https://github.com/timkitch/yt-ai-shell-command-generator
https://github.com/timkitch/yt-ai-shell-command-generator
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/timkitch/yt-ai-shell-command-generator
- Owner: timkitch
- License: mit
- Created: 2024-07-26T19:38:20.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2024-07-26T19:40:48.000Z (9 months ago)
- Last Synced: 2024-07-26T23:06:24.482Z (9 months ago)
- Language: Python
- Size: 60.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - timkitch/yt-ai-shell-command-generator - (Python)
README
# Shell Command Generator
## Description
Shell Command Generator is a Python-based CLI application that generates shell commands based on user queries using the Anthropic API. It supports multiple shell environments and provides an interactive interface for users to input their command queries and receive generated commands.
## Technologies Used
- Python 3.x
- Click (for CLI interface)
- Anthropic API with Claude 3.5 Sonnet model (for command generation)
- python-dotenv (for environment variable management)
- pyperclip (for clipboard functionality)
## How It Works
1. The user selects their preferred shell environment (cmd, powershell, or bash).
2. The user inputs a query describing the command they need.
3. The application sends the query to the Anthropic API using the Claude 3.5 Sonnet model, which generates a suitable shell command.
4. The generated command is displayed to the user and can be copied to the clipboard.
5. The process repeats until the user chooses to exit.
## Installation
1. Clone this repository:
```
git clone https://github.com/timkitch/yt-ai-shell-command-generator.git
cd shell-command-generator
```
2. Create a virtual environment and activate it:
```
python -m venv venv
source venv/bin/activate # On Windows, use `venv\Scripts\activate`
```
3. Install the required packages:
```
pip install -r requirements.txt
```
4. Create a `.env` file in the project root and add your Anthropic API key:
```
ANTHROPIC_API_KEY=your_api_key_here
```
## Obtaining an Anthropic API Key
To use this project, you'll need an API key from Anthropic. Here's how to get one:
1. Go to the Anthropic website (https://www.anthropic.com)
2. Sign up for an account or log in if you already have one
3. Navigate to the API section of your account dashboard
4. Generate a new API key
5. Copy the API key and paste it into your `.env` file as shown in the installation steps
Note: Keep your API key confidential and never share it publicly.
## Usage
1. Run the application:
```
python main.py
```
2. Select your preferred shell environment when prompted.
3. Enter your command queries when prompted. The application will generate and display the corresponding shell commands.
4. Choose whether to copy the generated command to your clipboard.
5. Type 'exit' when you're done to quit the application.
## Example Usage
Here's an example of a user session with the Shell Command Generator:
```
(venv) timkitch@TimsBeelinkPC:~/ai-projects/yt-ai-shell-command-generator$ python main.py
1. cmd
2. powershell
3. bash
Select your preferred shell environment: 3
Shell Command Generator initialized for bash.
Enter your command query (or 'exit' to quit): give me a command to back up my home directory to an external drive
Generated command for bash:
rsync -avz --delete ~/. /path/to/external/drive/backup/
Do you want to copy this command to clipboard? [y/N]: N
Command (for easy copy-paste):
rsync -avz --delete ~/. /path/to/external/drive/backup/
Enter your command query (or 'exit' to quit):
```
This example demonstrates how the application prompts the user to select a shell environment, accepts a command query, generates a suitable command, and provides options for clipboard copying.
## Testing
To run the unit tests:
```
python -m unittest test_main.py
```
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
This project is open source and available under the [MIT License](LICENSE). This means you're free to use, modify, and distribute the code, even for commercial purposes, as long as you include the original copyright notice and license terms.