No project description provided
Project description
ShellGenius
ShellGenius is an intuitive CLI tool designed to enhance your command-line experience by turning your task descriptions into efficient shell commands.
Powered by OpenAI's gpt-3.5-turbo AI model, ShellGenius generates accurate commands based on your input and provides step-by-step explanations to help you understand the underlying logic.
Table of Contents
Installation
Ensure you have Python 3.8 or later installed on your system. To install ShellGenius, use the following command:
python3 -m pip install shellgenius
Install via pipx
(recommended)
pipx
is an alternative package manager for Python applications. It allows you to install and run Python applications in isolated environments, preventing conflicts between dependencies and ensuring that each application uses its own set of packages. I recommend using pipx
to install ShellGenius.
First, install pipx
if you haven't already:
-
On macOS and Linux:
python3 -m pip install --user pipx python3 -m pipx ensurepath
Alternatively, you can use your package manager (brew
, apt
, etc.).
-
On Windows:
py -m pip install --user pipx py -m pipx ensurepath
Once pipx
is installed, you can install ShellGenius using the following command:
pipx install shellgenius
OpenAI API key
ShellGenius requires an OpenAI API key to function. You can obtain a key by signing up for an account at OpenAI's website.
Once you have your API key, set it as an environment variable:
-
On macOS and Linux:
export OPENAI_API_KEY="your-api-key-here"
-
On Windows:
setx OPENAI_API_KEY your_key
Usage
To use ShellGenius, simply type shellgenius
followed by a description of the task you want to perform:
shellgenius "description of your task"
Note: The quotes are not necessary.
The tool will generate a shell command based on your description, display it with an explanation, and prompt you to confirm if you want to execute the command.
Examples
Here are some examples of ShellGenius in action:
Create a file
shellgenius "create a new file called example.txt"
Output:
touch example.txt
Explanation:
* touch command is used to create a new file if it doesn't exist
* example.txt is the name of the new file
Be careful with your answer.
Do you want to execute this command? [Y/n]: y
Number of lines in a file
shellgenius "count the number of lines in a file called data.csv"
Output:
wc -l data.csv
Explanation:
* wc is a word, line, and byte count utility
* -l flag counts the number of lines
* data.csv is the target file
Be careful with your answer.
Do you want to execute this command? [Y/n]: y
Limitations
ShellGenius is powered by an AI model and may not always generate the most efficient or accurate commands. Exercise caution when executing commands, especially when working with sensitive data or critical systems.
License
ShellGenius is released under the MIT License.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for shellgenius-0.1.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b92180ec03e19a27fe627d7822af591a2a0ccdcefa856a3a24783c359596ce20 |
|
MD5 | 92018e8c7a40338ebaf0ecb311daa53a |
|
BLAKE2b-256 | e435b09d3e4480f929c76c6f2ffac7b452d7c80faca9cf2f59599fdcd1654fa3 |