# CommandRex 🦖
A natural language interface for terminal commands. Talk to your terminal in plain English!
## Features
- 🗣️ Use natural language to run terminal commands
- 🔍 Preview commands before execution
- 🔒 Built-in safety checks for dangerous commands
- 💻 Cross-platform support (Windows, Linux, macOS)
- 📝 Command history with search
- ⌨️ Arrow key navigation
- 📊 Usage statistics
## Installation
```bash
pip install commandrex-cli
```
## Requirements
- Python 3.9 or higher
- OpenAI API key (get one at https://platform.openai.com)
## Quick Start
1. Install CommandRex:
```bash
pip install commandrex-cli
```
2. Run CommandRex:
```bash
commandrex
```
3. On first run, you'll be prompted to enter your OpenAI API key.
4. Start typing commands in plain English:
```
Show me all files in the current directory
Create a new folder called projects
What's my current directory
```
5. Update-
```
pip install --upgrade commandrex-cli
```
## Usage Tips
- Use arrow keys (↑/↓) to navigate command history
- Press Ctrl+R to search command history
- Type 'help' for more information
- Type 'history' to see command history
- Type 'stats' to see usage statistics
- Type 'exit' or 'quit' to leave
## Common Commands
Here are some example commands you can try:
- "Show all files"
- "Create a new folder called test"
- "What's my IP address"
- "Show system information"
- "Create a file called notes.txt"
## Safety Features
- Commands are shown and explained before execution
- Dangerous commands are flagged with warnings
- Confirmation required before execution
- Platform-specific command adaptation
## Special Commands
- `help` - Show help information
- `history` - Show command history
- `stats` - Show usage statistics
- `clear` - Clear the screen
- `reset-key` - Reset OpenAI API key
- `exit` or `quit` - Exit CommandRex
## Configuration
The OpenAI API key is stored securely using your system's keyring. You can:
1. Set it via environment variable:
```bash
export OPENAI_API_KEY=your-key-here
```
2. Let CommandRex prompt you for it on first run
3. Reset it anytime with:
```bash
commandrex reset-key
```
## License
MIT License - see LICENSE file for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "commandrex-cli",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "cli, terminal, natural-language, openai, commands",
"author": "Siddhant",
"author_email": "siddhantg314@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/92/61/1070a47c10bbf95c665a7eb4438524de3da645e6a727c3fa674bc0ca5e03/commandrex_cli-0.1.9.tar.gz",
"platform": null,
"description": "# CommandRex \ud83e\udd96\n\nA natural language interface for terminal commands. Talk to your terminal in plain English!\n\n## Features\n\n- \ud83d\udde3\ufe0f Use natural language to run terminal commands\n- \ud83d\udd0d Preview commands before execution\n- \ud83d\udd12 Built-in safety checks for dangerous commands\n- \ud83d\udcbb Cross-platform support (Windows, Linux, macOS)\n- \ud83d\udcdd Command history with search\n- \u2328\ufe0f Arrow key navigation\n- \ud83d\udcca Usage statistics\n\n## Installation\n\n```bash\npip install commandrex-cli\n```\n\n## Requirements\n\n- Python 3.9 or higher\n- OpenAI API key (get one at https://platform.openai.com)\n\n## Quick Start\n\n1. Install CommandRex:\n```bash\npip install commandrex-cli\n```\n\n2. Run CommandRex:\n```bash\ncommandrex\n```\n\n3. On first run, you'll be prompted to enter your OpenAI API key.\n\n4. Start typing commands in plain English:\n```\nShow me all files in the current directory\nCreate a new folder called projects\nWhat's my current directory\n```\n\n5. Update-\n```\npip install --upgrade commandrex-cli\n```\n\n## Usage Tips\n\n- Use arrow keys (\u2191/\u2193) to navigate command history\n- Press Ctrl+R to search command history\n- Type 'help' for more information\n- Type 'history' to see command history\n- Type 'stats' to see usage statistics\n- Type 'exit' or 'quit' to leave\n\n## Common Commands\n\nHere are some example commands you can try:\n\n- \"Show all files\"\n- \"Create a new folder called test\"\n- \"What's my IP address\"\n- \"Show system information\"\n- \"Create a file called notes.txt\"\n\n## Safety Features\n\n- Commands are shown and explained before execution\n- Dangerous commands are flagged with warnings\n- Confirmation required before execution\n- Platform-specific command adaptation\n\n## Special Commands\n\n- `help` - Show help information\n- `history` - Show command history\n- `stats` - Show usage statistics\n- `clear` - Clear the screen\n- `reset-key` - Reset OpenAI API key\n- `exit` or `quit` - Exit CommandRex\n\n## Configuration\n\nThe OpenAI API key is stored securely using your system's keyring. You can:\n\n1. Set it via environment variable:\n```bash\nexport OPENAI_API_KEY=your-key-here\n```\n\n2. Let CommandRex prompt you for it on first run\n\n3. Reset it anytime with:\n```bash\ncommandrex reset-key\n```\n\n## License\n\nMIT License - see LICENSE file for details.",
"bugtrack_url": null,
"license": "MIT",
"summary": "A natural language interface for terminal commands",
"version": "0.1.9",
"project_urls": null,
"split_keywords": [
"cli",
" terminal",
" natural-language",
" openai",
" commands"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b81d0bcb7edbd2ea4a3ab530538813a7371c6c8d86b5bc009d501d42eeefc8a0",
"md5": "6e8fef110fb286ea4cb94cccbcb3f60c",
"sha256": "5eeae580e10f60b09a37ecc5c4bc72f9356dfa05549253601028a9dc75d28b42"
},
"downloads": -1,
"filename": "commandrex_cli-0.1.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6e8fef110fb286ea4cb94cccbcb3f60c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 19862,
"upload_time": "2024-11-14T19:44:22",
"upload_time_iso_8601": "2024-11-14T19:44:22.076287Z",
"url": "https://files.pythonhosted.org/packages/b8/1d/0bcb7edbd2ea4a3ab530538813a7371c6c8d86b5bc009d501d42eeefc8a0/commandrex_cli-0.1.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "92611070a47c10bbf95c665a7eb4438524de3da645e6a727c3fa674bc0ca5e03",
"md5": "315794c5226e001e60c397a01886e49c",
"sha256": "a53198b41a27e2ecd632fe66c6ff853555c12420074077069b318963672ad336"
},
"downloads": -1,
"filename": "commandrex_cli-0.1.9.tar.gz",
"has_sig": false,
"md5_digest": "315794c5226e001e60c397a01886e49c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 16041,
"upload_time": "2024-11-14T19:44:23",
"upload_time_iso_8601": "2024-11-14T19:44:23.550970Z",
"url": "https://files.pythonhosted.org/packages/92/61/1070a47c10bbf95c665a7eb4438524de3da645e6a727c3fa674bc0ca5e03/commandrex_cli-0.1.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-14 19:44:23",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "commandrex-cli"
}
JSON