NaturalShell

AI-powered bridge from natural language to shell commands in CLI.

NaturalShell is a Node.js package that simplifies the command line, allowing you to use natural language to generate and understand shell commands.

Requirements

• GEMINI_API_KEY is required which you can get from here.
• npm should be installed

Features

• Natural Language Understanding: Easily convert your English sentences into shell commands.
• Command Explanation: Get explanations for what each command does, enhancing your understanding of shell operations.
• Command Editing: Directly edit the suggested command before execution, giving you full control.
• Cross-Platform Support: Whether you're on Linux, macOS, or Windows, NaturalShell works seamlessly.

Setup

Ensure you have Node.js (version 14 or later) installed. Then, install NaturalShell globally using npm:

npm install -g naturalshell

Retrieve your API key from Google AI Studio.

Note: If you haven't already, you'll have to create an account and set up a project to get your API key. (It's free of cost!)

Usage

Simply run nsh or naturalshell followed by your query in natural language:

nsh -m "find all txt files in the current directory"

NaturalShell will interpret your command and offer a shell command suggestion with its explaination, which you can:

• Run directly by pressing Enter
• Edit to make adjustments
• Understand by clearing your doubts.
• Cancel if it's not what you were looking for

Contributing

We welcome contributions to NaturalShell! Whether it's adding new features, improving documentation, or reporting bugs, please feel free to make a pull request or open an issue.

License

NaturalShell is open-sourced software licensed under the MIT license.