Skip to content

Latest commit

 

History

History
141 lines (101 loc) · 3.84 KB

README.md

File metadata and controls

141 lines (101 loc) · 3.84 KB
Raw

Command line GPT utils

Utilities provided

openai

Provides direct access to OpenAI API endpoints for the assistants and threads APIs.

gpt

Sends a prompt or series of prompts to the OpenAI discussions API and outputs the response as it arrives. This uses the (now possibly legacy?) chat API endpoint.

gpt -s 'You are a helpful assistant' \
    -p 'Rewrite the second act of Much Ado About Nothing in modern English'

chat

Provides a command line interface to have conversational interactions similar to ChatGPT from the command line, with a searchable conversation history. Simply execute chat and follow the menu prompts to start a conversation.

cmd

Generates a command that can be directly executed in your $SHELL.

cmd 'list files in the current directory with time stamps'

If you want commands you execute with cmd to be added to your shell's history, add something like this to your bashrc:

alias cmd="source $(which cmd)"

code

A little wrapper around gpt focused on producing code without texty explanations.

stack_class=$(code -l python -p 'stack class')
unit_test=$(code -l python -c "$stack_class" -p 'unit test for this class')

tester

Runs your unit tests. If they fail, sends the error messages and relevant file contents to gpt to come up with suggested fixes. Then it will offer to rerun your tests to verify the fix.

utils

Library of small utility functions and aliases:

  • image <prompt> [<size>] > image.png - generate an image
  • re-image <source-file> <prompt> > new-image.png - modify an image

Dependencies

Environment variables

  • OPENAI_API_KEY - your OpenAI API key (required; create one at https://platform.openai.com/account/api-keys)
  • OPENAI_MODEL - the model to use; defaults to gpt-3.5-turbo-16k
  • BASHGPT_CACHE_DIR - gpt memoizes responses to prompts here; defaults to $HOME/.bashgpt_cache
  • BASHGPT_CHAT_HOME - chat stores its index of conversations here; defaults to $HOME/.bashgpt/chat/chat-history

Installation

Directly

  1. Ensure that /usr/local/bin is in your PATH
  2. Ensure that you have write permissions to /usr/local/bin
  3. Download to /usr/local/bin
for tool in gpt chat code cmd tester; do
  curl -sSL "https://raw.githubusercontent.com/sysread/bash-gpt/main/$tool" -o "/usr/local/bin/$tool" \
    && chmod +x "/usr/local/bin/$tool"
done

From repo

  1. Check out repository:
git clone https://github.com/sysread/bash-gpt
  1. Add to your PATH
export PATH="$PATH:/path/to/bash-gpt"

With Nix

Want an easy way to install nix? Checkout the Determinite Systems Installer

  1. Check out repository:
git clone https://github.com/sysread/bash-gpt
  1. Add Env Vars to your shell environment
  • create a .env file with the following keys:
OPENAI_API_KEY=""
OPENAI_API_MODEL="gpt-3.5-turbo-16k"
  1. Run the nix shell
nix develop

Utils

To use the utilities in utils, first download it:

curl -sSL https://raw.githubusercontent.com/sysread/bash-gpt/main/utils -o /usr/local/lib/bash-gpt-utils

Then add it to your .bashrc or .bash_profile:

echo 'source /usr/local/lib/bash-gpt-utils' >> ~/.bashrc

Support and compatibility

Tested on macOS. Ought to work on linux as well. Please file a ticket if you find an issue on mac or linux. Better yet, send me a pull request :)