Skip to content

Latest commit

 

History

History
67 lines (43 loc) · 2.44 KB

README.md

File metadata and controls

67 lines (43 loc) · 2.44 KB

A light weight CLI to interact with the OpenAI models from your terminal written in Rust. OpenAI's LLMs are bringing a whole new dimension to the development experience and it's important to bridge the communication with our every day tools.

If you rely on tools like ChatGPT or Github Copilot to aid you while coding, gptc might be a right solution to extend that assistance to the terminal. It can help you with tasks like:

  • Come up with terminal commands from all major operating systems.
  • Create boilerplate code for most languages (including HTML, CSS, etc.).
  • Answer questions about technical acronyms.

And endless things if you get creative enough...

Installation and setup

Run the following script to download the latest gptc binary:

curl -fsSL https://raw.githubusercontent.com/dmosc/gptc/main/scripts/install.sh | sh

During installation, gptc will prompt you for an OpenAI API key and export the $OPENAI_KEY environment variable inside your shell configuration file (i.e. .zshrc, .bashrc) with the provided key. The script installs gptc's binary inside /usr/local/bin and appends the path to your $PATH variable if it isn't registered (get an API key from OpenAI's platform).

Updated to latest version

Run the following script to download gptc's latest binary:

curl -fsSL https://raw.githubusercontent.com/dmosc/gptc/main/scripts/update.sh | sh

If all goes well you should have the freshest gptc version...

Usage

gptc "linux script to install a binary in bin/ directory"
gptc -c "create an index.html file with common html boilerplate"

Get a list of flags and descriptions:

gptc --help

Troubleshooting

Since it's a first version, feel free to ping me if something's not right.

Installation

If gptc is failing to install, read through the error message. Hopefully is informative enough to let you know what's going on.

Usage

If the installation is successfull, make sure that:

  • $OPENAI_KEY environment variable is set and loaded; try to echo $OPENAI_KEY and see if you get the key back.
  • Try gptc --help to get additional info on flags and what they do.