gpterminal
WARNING: gpterminal has very few guardrails. If used indiscriminately, it can wipe your entire system or leak information.
gpterminal is a powerful, flexible and dangerous command-line tool designed to help you generate commands for your terminal using OpenAI's Chat Completions. It will not execute commands without your consent, but please do check which commands it is presenting before you let it execute them. Like so:
$ gpterminal "Using git diff to gather info, commit all the latest changes with a descriptive commit message, then push the changes"
$ # It gathers info, asks for consent, and does the thing
$ [main 94a9292] Update README with gpterminal usage example
$ 1 file changed, 4 insertions(+)
Getting Started
You can install it from RubyGems using gem install gpterminal, or you can clone it and run it straight from the source.
Ensure you have Ruby installed on your system. Then, follow these steps:
- Clone the repository or download the source code.
- Navigate to the gpterminal directory and run
bundle installto install dependencies. - Start the application by running
./bin/gpterminal
Configuration
On first run, you'll be prompted to enter your OpenAI API key. This is required for the application to interact with OpenAI's API. You will also be asked to specify whether you'd like your PATH variable to be sent in the prompt, which can help with command generation.
Usage
gpterminal <prompt> [options] [subcommand [options]]
Subcommands:
preset-gpterminal preset <name> <prompt>config-gpterminal config [--openapi_key <value>|--send_path <true|false>]
Options:
-v, --verbose Run verbosely
Presets
You can save and reuse preset prompts for common or repeated tasks. To create a preset, use the -s option followed by a name and the prompt, separated by a comma.
To use a preset, simply pass its name as an argument when starting gpterminal.
Contributing
Contributions are welcome! Feel free to open an issue or pull request.
License
gpterminal is open-source software licensed under the MIT license.