# Commandor
An intelligent terminal assistant that uses AI to **convert natural language into shell commands** and now **answers questions directly** with `/ask`.
Bring the power of AI to your terminal and work smarter!
[](https://github.com/ravin-d-27/Commandor/stargazers)
[](LICENSE)
[](https://python.org)
---
## Key Features
- **/ai** – Convert natural language instructions to shell commands
- **/ask** – Ask AI anything: get explanations, coding help, system tips & more
- **Beautiful interface** – Colorful ASCII art, emoji cues, color-coded prompts
- **Context-aware** – Commands tailored to your current directory
- **Safety checks** – Warn before running dangerous commands
- **Command history** – Navigate with arrow keys (readline support)
- **Cross-platform** – Works on Linux, macOS & Windows
---
## Installation
### Clone & install (recommended)
```bash
git clone https://github.com/ravin-d-27/Commandor.git
cd Commandor
pip install -e .
````
### Set up your API key
Get your Gemini API key from [Google AI Studio](https://makersuite.google.com/app/apikey):
```bash
echo "GEMINI=your_api_key_here" > ~/.env
```
Or set it directly:
```bash
export GEMINI=your_api_key_here
```
> **Windows tip:** Use `set GEMINI=your_api_key_here` instead
---
## Usage
Run from any terminal:
```bash
commandor
```
---
## 🛠️ Available Commands
| Command | What it does |
| ------------------: | --------------------------------------------------------: |
| `/ai <instruction>` | Convert natural language to shell command |
| `/ask <question>` | Ask AI anything (coding, concepts, tips, general queries) |
| `/help` | Show help message |
| `/info` | Show basic system info |
| `/history` | View past generated commands |
| `/clear` | Clear terminal screen |
| `exit` / `Ctrl+C` | Exit Commandor |
---
## Examples
```bash
Commandor $ /ai list all .py files
🤖 AI → find . -name "*.py" -type f
Commandor $ /ask What is a virtual environment in Python?
🤔 Thinking...
🤖 AI Response:
────────────────────────────────────────────
A virtual environment isolates your Python packages ...
────────────────────────────────────────────
```
---
## Beautiful UI
* Rainbow-colored ASCII logo on start
* 🤖 & 💡 emojis for quick visual cues
* Clear, color-coded prompts to separate AI and user input
---
## Troubleshooting
✅ Command not found?
* Ensure it’s installed: `pip show commandor`
* Check your PATH: `echo $PATH`
✅ API key issues?
* Verify `.env` contains: `GEMINI=your_actual_key`
* Key must be valid on [Google AI Studio](https://makersuite.google.com/app/apikey)
✅ Windows users:
```bash
pip install pyreadline3
```
---
## 🤝 Contribute
We love contributions!
* ⭐ Star the repo
* 🐛 Report bugs / request features via [issues](https://github.com/ravin-d-27/Commandor/issues)
* 📚 Improve docs
* 🔧 Submit pull requests
> Follow code style & add tests if you add features!
---
## License
Open Source, free to use personally & commercially (with attribution):
* Display **"Powered by Commandor"** if used commercially
* Link back to this repo
See [LICENSE](LICENSE) for full details.
---
## ✏Author & Contact
Made with ❤️ by **Ravin D**
* Email: [ravin.d3107@outlook.com](mailto:ravin.d3107@outlook.com)
---
## Show your support
If you find Commandor helpful:
* Star this repository!
* Share with fellow developers!
---
## Uninstall
```bash
pip uninstall commandor
```
---
**Happy coding! 🚀**
Raw data
{
"_id": null,
"home_page": "https://github.com/ravin-d-27/Commandor",
"name": "commandor-ai",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "terminal, ai, shell, command-line, natural-language, gemini, assistant, automation, cli, productivity",
"author": "Ravin D",
"author_email": "Ravin D <ravin.d3107@outlook.com>",
"download_url": "https://files.pythonhosted.org/packages/c1/68/d2df53a059cd38b3314bfa0d1fd24cda6f01e994114803ba8ba945c4018d/commandor_ai-0.0.1.tar.gz",
"platform": null,
"description": "# Commandor\r\n\r\nAn intelligent terminal assistant that uses AI to **convert natural language into shell commands** and now **answers questions directly** with `/ask`. \r\nBring the power of AI to your terminal and work smarter!\r\n\r\n[](https://github.com/ravin-d-27/Commandor/stargazers)\r\n[](LICENSE)\r\n[](https://python.org)\r\n\r\n---\r\n\r\n\r\n## Key Features\r\n\r\n- **/ai** \u2013 Convert natural language instructions to shell commands\r\n- **/ask** \u2013 Ask AI anything: get explanations, coding help, system tips & more\r\n- **Beautiful interface** \u2013 Colorful ASCII art, emoji cues, color-coded prompts\r\n- **Context-aware** \u2013 Commands tailored to your current directory\r\n- **Safety checks** \u2013 Warn before running dangerous commands\r\n- **Command history** \u2013 Navigate with arrow keys (readline support)\r\n- **Cross-platform** \u2013 Works on Linux, macOS & Windows\r\n\r\n---\r\n\r\n## Installation\r\n\r\n### Clone & install (recommended)\r\n\r\n```bash\r\ngit clone https://github.com/ravin-d-27/Commandor.git\r\ncd Commandor\r\npip install -e .\r\n````\r\n\r\n### Set up your API key\r\n\r\nGet your Gemini API key from [Google AI Studio](https://makersuite.google.com/app/apikey):\r\n\r\n```bash\r\necho \"GEMINI=your_api_key_here\" > ~/.env\r\n```\r\n\r\nOr set it directly:\r\n\r\n```bash\r\nexport GEMINI=your_api_key_here\r\n```\r\n\r\n> **Windows tip:** Use `set GEMINI=your_api_key_here` instead\r\n\r\n---\r\n\r\n## Usage\r\n\r\nRun from any terminal:\r\n\r\n```bash\r\ncommandor\r\n```\r\n\r\n---\r\n\r\n## \ud83d\udee0\ufe0f Available Commands\r\n\r\n| Command | What it does |\r\n| ------------------: | --------------------------------------------------------: |\r\n| `/ai <instruction>` | Convert natural language to shell command |\r\n| `/ask <question>` | Ask AI anything (coding, concepts, tips, general queries) |\r\n| `/help` | Show help message |\r\n| `/info` | Show basic system info |\r\n| `/history` | View past generated commands |\r\n| `/clear` | Clear terminal screen |\r\n| `exit` / `Ctrl+C` | Exit Commandor |\r\n\r\n---\r\n\r\n## Examples\r\n\r\n```bash\r\nCommandor $ /ai list all .py files\r\n\ud83e\udd16 AI \u2192 find . -name \"*.py\" -type f\r\n\r\nCommandor $ /ask What is a virtual environment in Python?\r\n\ud83e\udd14 Thinking...\r\n\r\n\ud83e\udd16 AI Response:\r\n\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\r\nA virtual environment isolates your Python packages ...\r\n\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\r\n```\r\n\r\n---\r\n\r\n## Beautiful UI\r\n\r\n* Rainbow-colored ASCII logo on start\r\n* \ud83e\udd16 & \ud83d\udca1 emojis for quick visual cues\r\n* Clear, color-coded prompts to separate AI and user input\r\n\r\n---\r\n\r\n## Troubleshooting\r\n\r\n\u2705 Command not found?\r\n\r\n* Ensure it\u2019s installed: `pip show commandor`\r\n* Check your PATH: `echo $PATH`\r\n\r\n\u2705 API key issues?\r\n\r\n* Verify `.env` contains: `GEMINI=your_actual_key`\r\n* Key must be valid on [Google AI Studio](https://makersuite.google.com/app/apikey)\r\n\r\n\u2705 Windows users:\r\n\r\n```bash\r\npip install pyreadline3\r\n```\r\n\r\n---\r\n\r\n## \ud83e\udd1d Contribute\r\n\r\nWe love contributions!\r\n\r\n* \u2b50 Star the repo\r\n* \ud83d\udc1b Report bugs / request features via [issues](https://github.com/ravin-d-27/Commandor/issues)\r\n* \ud83d\udcda Improve docs\r\n* \ud83d\udd27 Submit pull requests\r\n\r\n> Follow code style & add tests if you add features!\r\n\r\n---\r\n\r\n## License\r\n\r\nOpen Source, free to use personally & commercially (with attribution):\r\n\r\n* Display **\"Powered by Commandor\"** if used commercially\r\n* Link back to this repo\r\n See [LICENSE](LICENSE) for full details.\r\n\r\n---\r\n\r\n## \u270fAuthor & Contact\r\n\r\nMade with \u2764\ufe0f by **Ravin D**\r\n\r\n* Email: [ravin.d3107@outlook.com](mailto:ravin.d3107@outlook.com)\r\n\r\n---\r\n\r\n## Show your support\r\n\r\nIf you find Commandor helpful:\r\n\r\n* Star this repository!\r\n* Share with fellow developers!\r\n\r\n---\r\n\r\n## Uninstall\r\n\r\n```bash\r\npip uninstall commandor\r\n```\r\n\r\n---\r\n\r\n**Happy coding! \ud83d\ude80**\r\n\r\n\r\n",
"bugtrack_url": null,
"license": "Proprietary",
"summary": "An intelligent terminal assistant that uses AI to convert natural language to shell commands",
"version": "0.0.1",
"project_urls": {
"BugReports": "https://github.com/ravin-d-27/Commandor/issues",
"Documentation": "https://github.com/ravin-d-27/Commandor#readme",
"Homepage": "https://github.com/ravin-d-27/Commandor",
"Source": "https://github.com/ravin-d-27/Commandor"
},
"split_keywords": [
"terminal",
" ai",
" shell",
" command-line",
" natural-language",
" gemini",
" assistant",
" automation",
" cli",
" productivity"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "0c4780d1ec113be8d9057b76bc892061747b548addcfce87ef23d8e917146cf1",
"md5": "461ab3fc6022f03a4605f1775f616add",
"sha256": "f9c47b9b9e22e281bc39ffb40116b8a84c5bc32f1011246ca19842122cc11b10"
},
"downloads": -1,
"filename": "commandor_ai-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "461ab3fc6022f03a4605f1775f616add",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 15343,
"upload_time": "2025-07-18T14:45:27",
"upload_time_iso_8601": "2025-07-18T14:45:27.705561Z",
"url": "https://files.pythonhosted.org/packages/0c/47/80d1ec113be8d9057b76bc892061747b548addcfce87ef23d8e917146cf1/commandor_ai-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "c168d2df53a059cd38b3314bfa0d1fd24cda6f01e994114803ba8ba945c4018d",
"md5": "bcac33373b1348b81fdff202e9381705",
"sha256": "fdb416c3c71987b33f0ced20cbc2bc63b4a8b8a6ef0fac2ee31bcd2ff9553bb8"
},
"downloads": -1,
"filename": "commandor_ai-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "bcac33373b1348b81fdff202e9381705",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 17287,
"upload_time": "2025-07-18T14:45:28",
"upload_time_iso_8601": "2025-07-18T14:45:28.997203Z",
"url": "https://files.pythonhosted.org/packages/c1/68/d2df53a059cd38b3314bfa0d1fd24cda6f01e994114803ba8ba945c4018d/commandor_ai-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-18 14:45:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ravin-d-27",
"github_project": "Commandor",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "setuptools",
"specs": []
},
{
"name": "google-generativeai",
"specs": [
[
">=",
"0.3.0"
]
]
},
{
"name": "python-decouple",
"specs": [
[
">=",
"3.6"
]
]
},
{
"name": "pyreadline3",
"specs": [
[
">=",
"3.4.1"
]
]
},
{
"name": "python-decouple",
"specs": []
},
{
"name": "rich",
"specs": [
[
">=",
"10.0.0"
]
]
},
{
"name": "colorama",
"specs": [
[
">=",
"0.4.4"
]
]
}
],
"lcname": "commandor-ai"
}
JSON
