https://github.com/shreshthgoyal/cmdx
This project that transforms natural language tasks into executable Linux shell commands. This tool bridges the gap between user-friendly language and the powerful capabilities of the command line, making it easier for users of all skill levels to leverage the full potential of Terminal.
https://github.com/shreshthgoyal/cmdx
ai langchain python shell terminal
Last synced: 3 months ago
JSON representation
This project that transforms natural language tasks into executable Linux shell commands. This tool bridges the gap between user-friendly language and the powerful capabilities of the command line, making it easier for users of all skill levels to leverage the full potential of Terminal.
- Host: GitHub
- URL: https://github.com/shreshthgoyal/cmdx
- Owner: shreshthgoyal
- Created: 2024-06-20T09:08:46.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-20T14:09:47.000Z (about 2 years ago)
- Last Synced: 2025-09-02T13:55:46.663Z (10 months ago)
- Topics: ai, langchain, python, shell, terminal
- Language: Python
- Homepage:
- Size: 461 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# cmdX
An AI tool that converts natural language instructions into shell commands for the command line interface (CLI).
https://github.com/shreshthgoyal/cmdX/assets/73751013/c7738fa6-d6fc-46ae-a3d1-5eadb4f7cf88
This is a CLI tool to provide commands based on the task in the cli itself. This is works on RAG with a custom knowledge base.
## Install and Run
```
# In the project repository after setting up the env
$ python -m venv venv
$ source venv/bin/activate
$ pip install -r requirements.txt
$ python api.py #to start the server
$ python cli.py "task" or python cli.py #to query
```
## Usage
Simply run the app followed by your query in natural language:
python cli.py "find all txt files in the current directory"
or
python cli.py
It will interpret your command and offer a shell command suggestion with its explaination, which you can:
- **Edit** to make adjustments
- **Run** the command.
- **Exit** if it's not what you were looking for
## Features
- **Natural Language Understanding**: Easily convert your English sentences into shell commands.
- **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.
## Workflow
## Contributing
We welcome contributions to cmdX! Whether it's adding new features, improving documentation, or reporting bugs, please feel free to make a pull request or open an issue.