Skip to content

Latest commit

 

History

History
41 lines (24 loc) · 1.36 KB

README.md

File metadata and controls

41 lines (24 loc) · 1.36 KB

CliGPT

Streamline your terminal experience by generating Linux commands from natural language queries, reducing the need to leave the terminal for manual web searches.

Setup

chmod +x install.sh
./install.sh

This will create a symbolic link for CliGPT in the ${HOME}/.local/bin directory, making it accessible system-wide.

If a previous version is already installed, the symbolic link will be updated.

I might tweak the prompt in this repository from time to time.

You might want to tweak it too and suggest changes through a Pull Request.

Essential Configuration: OPENAI_API_KEY and cligpt Alias

To ensure proper functionality, including the ability to retrieve the last run command from your shell history, you must set the OPENAI_API_KEY environment variable and create an alias for running cligpt.

You can do so by running:

export OPENAI_API_KEY="<your key here>"
alias cligpt="source $HOME/.local/bin/cligpt"

Or by adding the above command to your shell .rc file, or whatever other environment variable setup you prefer.

Run

cligpt <linux related question>

You will be asked to confirm if you want to run the command or not, no need to copy and paste it.

Thanks for being here

If you enjoyed this, you might like GitGPT - to get suggestions for Git, altough CliGPT can work with Git commands as well.