ChatGPT CLI

ChatGPT CLI is a command-line interface tool for interacting with OpenAI's ChatGPT API. It allows users to communicate with the GPT model, adjust API parameters, use magic commands, insert file contents, fetch content from URLs, and execute system commands while chatting.

Features

Interactive command-line interface using GNU Readline.
Expand file contents from the file path(s) using the placeholder.
Expand web page contents from the URL using the placeholder.
Magic commands to clear, undo, edit, write, save, and load data.
Execute system commands and pass captured stdout and stderr output to ChatGPT.
Code blocks in the response are saved in temp files and can be referenced from $CODE1, $CODE2...
Output execution results as HTML (experimental).
Substitution patterns of placeholders can be configurable in the configuration file.

Installation

Install Crystal

Build the project:

git clone https://github.com/kojix2/chatgpt-cli
cd chatgpt-cli
make
sudo make install

Set your OpenAI API key as an environment variable:
```
export OPENAI_API_KEY="your_openai_api_key"
```

Usage

To start using ChatGPT CLI, run the chatgpt command in your terminal:

chatgpt

Type a message and press Enter to get a response from GPT-3.5 Turbo. To exit, type exit, quit, or press Ctrl + D.

Options

You can set various options when running the chatgpt command:

Usage: bin/chatgpt [options]
    -m MODEL, --model MODEL          Model name [gpt-3.5-turbo]
    -i ID, --id ID                   ID of the custom system message
    -s STR, --system STR             System message
    -n INT                           Number of edits to generate [1]
    -t Float, --temperature Float    Sampling temperature to use [1.0]
    -p Float, --top_p Float          Probability threshold of nucleus sampling [1.0]
    -v, --version                    Print version info and exit
    -h, --help                       Print help

Selecting ChatGPT System Commands

Select pre-registered system commands:

chatgpt -i code

Depending on how you use it, system commands are not always necessary. It works well without them. To edit system commands, edit the config file. Type %config to open a text editor. code, edit, poet, tran are available by default.

Passing Files to ChatGPT

You can pass the contents of files to ChatGPT by using the %{foo.txt} pattern.

> Please explain the following code: %{src/beatles.py} Are there any bugs?

With this feature, you can pass the code to ChatGPT and have them write README.md.

> Please read the code of the tool: %{src/*.cr} %{src/**/*.cr} Then update README.md %{README.md}
...
> %w README.md # This will save README.md

Note: READMEs created this way tend to be characterless. Still, it is marvelous to have a computer write the README for you.

Passing Web Pages to ChatGPT

You can pass the contents of a web page to ChatGPT by using %{www.example.com}.

> Pick five interesting news items: %%{https://news.ycombinator.com/}

Here, the HTML from the URL is fetched, the words used in the body are extracted and passed to ChatGPT. It is much smaller than the raw HTML, but still not enough.

Magic Commands

During the dialogue, you can use a variety of magic commands.

%clear

Clear all messages. This is useful when you want to change the topic and set TOKEN back to zero.

%undo <n>

Undo the last n query and response [1]. If you make a mistake asking ChatGPT or if the reply is not what you are looking for, you can undo.

%write <filename>

Write the most recent message to a file. Save the text and scripts written by ChatGPT.

%w <filename>

Alias for write. This magic command is used so often that an alias is provided.

%config

Edit the config file. Open a text editor and rewrite the settings.

%system

Show the current system message.

%system <message>

Set a new system message (this behavior is subject to change).

%edit

Edit data in JSON format. All data passed to ChatGPT can be edited here. You are free to tamper with the past.

%html <filename>

Export the conversation to HTML and launch your browser. This feature is useful when you want to save a conversation or check path expansion, etc. (Experimental and the output HTML may not be correct)

%save <filename>

Save the data. This allows you to do things like "save session". The file is a JSON file to be posted to ChatGPT.

%load <filename>

Load the data. This allows you to do things like "load session".

%resume

Load data from auto-saved data file. We humans forget to save data. Therefore, the last session is automatically saved.

%tokens

Total tokens used. You will see a more detailed number of TOKENs than is shown in the prompt. Please note that chatgpt-cli does not have the ability to calculate the number of TOKENs. It only displays the ChatGPT response. Therefore, if any edits may have been made, it will be Unknown.

%webapp

Open the ChatGPT website.

%debug

Show debug message. Display the data actually posted to ChatGPT and the response in JSON format.

%help

Show the help. Humans forget commands.

Note that for %config, %data, and other commands launch an editor. The editor used can be set by the EDITOR environment variable. Note that the tool is still being improved and the behavior of the magic commands will continue to change.

Executing System Commands

You can execute system commands while chatting by prefixing the command with the ! symbol.

Execute a command, and display the output immediately:

> !pwd

This way you can also run commands like vim and top.

Capture STDOUT and STDERR

Capture the output of a command for later use:

> !!git diff

The standard output can be inserted into the chat with %STDOUT.

> Please write a commit message: %STDOUT

The results can be referenced through the environment variable RESP (experimental).

> !git commit -m "$RESP"

The contents of the standard error output can also be inserted into the chat with %STDERR.

> !!wrong_command

> Explain the meaning of this error message: %STDERR

You can also use !{ cmd }. In this case, it will be replaced by the contents of standard input

> What time is it now? Hint: !{date}

Run Code Blocks in the Response

When ChatGPT returns code blocks, ChatGPT CLI saves these blocks temporarily and assigns them to environment variables named CODE1, CODE2, ... and so on. This allows you to execute the code blocks on your computer.

> Write code to display 1 to 10 in Python and Ruby.
> Python:

```
for i in range(1, 11):
    print(i)
```

Ruby:

```
(1..10).each { |i| puts i }
```

> ! python $CODE1
> ! ruby $CODE2

Configuration

The system messages used by ChatGPT CLI can be customized through the config.json file. The file is located in ~/.config/chatgpt-cli/ by default. Type %config.

Configuration files are often changed to make more items configurable. Please see config.json in the repository for the latest information.

Uninstallation

ChatGPT CLI uses the following 3 files and directories. This is all there is to it.

rm /usr/local/bin/chatgpt   # Remove the executable
rm -r ~/.config/chatgpt-cli # Remove the config directory
rm ~/.chatgpt_history       # Remove command history

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/kojix2/chatgpt-cli.

Development

git clone https://github.com/kojix2/chatgpt-cli
cd chatgpt-cli
shards install
shards build --release
bin/chatgpt

What is a good way to distribute command-line tools created in Crystal? I am looking for someone to help us.

You can quickly try development by using Gitpod.

License

This project is open-source and available under the terms of the MIT License.

CrystalDoc.info

chatgpt-cli