unixgpt is a powerful bridge between natural language and UNIX commands
Project description
🗣️ unixgpt
unixgpt is a powerful bridge between natural language and UNIX commands.
A valid OpenAI API Key is required to run unixgpt (you can get one here: https://openai.com/blog/openai-api)
export OPENAI_API_KEY="enter key here"
The latest version of unixgpt
can be installed from PyPI:
pip install unixgpt
To upgrade to the latest version:
pip install --upgrade unixgpt
Building Locally
Docker
Build the Docker image
docker build -t unixgpt-cli .
Create and run the Docker container (with a valid OpenAI API Key)
docker run -e OPENAI_API_KEY unixgpt-cli
Note: Input can be edited in Dockerfile
pip
Build via pip (from source code)
pip install .
Run via pip
unixgpt -i "enter input here"
Features
-
Conversion: Seamlessly transform natural language queries into their corresponding UNIX commands.
-
Command Options: After generating a command, enjoy the following flexibility:
- Execute: Execute the generated UNIX command directly.
- Save: Store frequently used commands locally for swift and convenient access.
- Copy: Copy the generated command to the clipboard, simplifying pasting and use in your terminal.
- Reusability: It's not just about storing commands; it's a versatile tool for saving and editing custom commands via natural language, ensuring your workflow remains flexible and efficient.
Examples
Conversion
Input: unixgpt -i "I want to see any uses of the 'git commit' command in my history"
Output: history | grep "git commit"
Input: unixgpt -i "Use the Dockerfile in the cwd to create an image called project-image"
Output: docker build -t project-image .
Input: unixgpt --input "Show me the current processes running on port 8000"
Output: lsof -i :8000
Save
Input: unixgpt -s "git commit && git push"
Output: "Added to UnixGPT local library"
Input: unixgpt --save 1599
Output: "Added to UnixGPT local library"
Fetch
Input: unixgpt -f "command that commits and pushes via Git"
Output: git commit && git push
Input: unixgpt --fetch 23
Output: "Returns command in UnixGPT local library with ID:23"
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.