- Notifications
You must be signed in to change notification settings - Fork85
Command-line interface for ChatGPT, Claude and Bard
License
kharvd/gpt-cli
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Command-line interface for chat LLMs.
export ANTHROPIC_API_KEY=xcxcuvx --from gpt-command-line gpt- OpenAI
- Anthropic
- Google Gemini
- Cohere
- Other APIs compatible with OpenAI (e.g. Together, OpenRouter, local models with LM Studio)
- Command-Line Interface: Interact with ChatGPT or Claude directly from your terminal.
- Model Customization: Override the default model, temperature, and top_p values for each assistant, giving you fine-grained control over the AI's behavior.
- Extended Thinking Mode: Enable Claude 3.7's extended thinking capability to see its reasoning process for complex problems.
- Usage tracking: Track your API usage with token count and price information.
- Keyboard Shortcuts: Use Ctrl-C, Ctrl-D, and Ctrl-R shortcuts for easier conversation management and input control.
- Multi-Line Input: Enter multi-line mode for more complex queries or conversations.
- Markdown Support: Enable or disable markdown formatting for chat sessions to tailor the output to your preferences.
- Predefined Messages: Set up predefined messages for your custom assistants to establish context or role-play scenarios.
- Multiple Assistants: Easily switch between different assistants, including general, dev, and custom assistants defined in the config file.
- Flexible Configuration: Define your assistants, model parameters, and API key in a YAML configuration file, allowing for easy customization and management.
This install assumes a Linux/OSX machine with Python and pip available.
pip install gpt-command-line
Install latest version from source:
pip install git+https://github.com/kharvd/gpt-cli.git
Or install by cloning the repository manually:
git clone https://github.com/kharvd/gpt-cli.gitcd gpt-clipip install.
Add the OpenAI API key to your.bashrc file (in the root of your home folder).In this example we use nano, you can use any text editor.
nano ~/.bashrcexport OPENAI_API_KEY=<your_key_here>Run the tool
gptYou can also use agpt.yml file for configuration. See theConfiguration section below.
Make sure to set theOPENAI_API_KEY environment variable to your OpenAI API key (or put it in the~/.config/gpt-cli/gpt.yml file as described below).
usage: gpt [-h] [--no_markdown] [--model MODEL] [--temperature TEMPERATURE] [--top_p TOP_P] [--thinking THINKING_BUDGET] [--log_file LOG_FILE] [--log_level {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [--prompt PROMPT] [--execute EXECUTE] [--no_stream] [{dev,general,bash}]Run a chat session with ChatGPT. See https://github.com/kharvd/gpt-cli for more information.positional arguments: {dev,general,bash} The name of assistant to use. `general` (default) is a generally helpful assistant, `dev` is a software development assistant with shorter responses. You can specify your own assistants in the config file ~/.config/gpt-cli/gpt.yml. See the README for more information.optional arguments: -h, --help show this help message and exit --no_markdown Disable markdown formatting in the chat session. --model MODEL The model to use for the chat session. Overrides the default model defined for the assistant. --temperature TEMPERATURE The temperature to use for the chat session. Overrides the default temperature defined for the assistant. --top_p TOP_P The top_p to use for the chat session. Overrides the default top_p defined for the assistant. --thinking THINKING_BUDGET Enable Claude's extended thinking mode with the specified token budget. Only applies to Claude 3.7 models. --log_file LOG_FILE The file to write logs to. Supports strftime format codes. --log_level {DEBUG,INFO,WARNING,ERROR,CRITICAL} The log level to use --prompt PROMPT, -p PROMPT If specified, will not start an interactive chat session and instead will print the response to standard output and exit. May be specified multiple times. Use `-` to read the prompt from standard input. Implies --no_markdown. --execute EXECUTE, -e EXECUTE If specified, passes the prompt to the assistant and allows the user to edit the produced shell command before executing it. Implies --no_stream. Use `-` to read the prompt from standard input. --no_stream If specified, will not stream the response to standard output. This is useful if you want to use the response in a script. Ignored when the --prompt option is not specified. --no_price Disable price logging.Type:q or Ctrl-D to exit,:c or Ctrl-C to clear the conversation,:r or Ctrl-R to re-generate the last response.To enter multi-line mode, enter a backslash\ followed by a new line. Exit the multi-line mode by pressing ESC and then Enter.
Thedev assistant is instructed to be an expert in software development and provide short responses.
$ gpt dev
Thebash assistant is instructed to be an expert in bash scripting and provide only bash commands. Use the--execute option to execute the commands. It works best with thegpt-4 model.
gpt bash -e"How do I list files in a directory?"This will prompt you to edit the command in your$EDITOR it before executing it.
You can configure the assistants in the config file~/.config/gpt-cli/gpt.yml. The file is a YAML file with the following structure (see alsoconfig.py)
default_assistant:<assistant_name>markdown:Falseopenai_api_key:<openai_api_key>anthropic_api_key:<anthropic_api_key>log_file:<path>log_level:<DEBUG|INFO|WARNING|ERROR|CRITICAL>assistants:<assistant_name>:model:<model_name>temperature:<temperature>top_p:<top_p>thinking_budget:<token_budget># Claude 3.7 models onlymessages: -{ role: <role>, content: <message> } -...<assistant_name>:...
You can override the parameters for the pre-defined assistants as well.
You can specify the default assistant to use by setting thedefault_assistant field. If you don't specify it, the default assistant isgeneral. You can also specify themodel,temperature andtop_p to use for the assistant. If you don't specify them, the default values are used. These parameters can also be overridden by the command-line arguments.
Example:
default_assistant:devmarkdown:Trueopenai_api_key:<openai_api_key>assistants:pirate:model:gpt-4temperature:1.0messages: -{ role: system, content: "You are a pirate." }
$ gpt pirate> ArrrrAhoy, matey! What be bringing ye to these here waters? Be it treasure or adventure ye seek, we be sailing the high seas together. Ready yer map and compass, for we have a long voyage ahead!You can read in files to the assistant's context with !include <file_path>.
default_assistant:devmarkdown:Trueopenai_api_key:<openai_api_key>assistants:pirate:model:gpt-4temperature:1.0messages: -{ role: system, content: !include "pirate.txt" }
If you are using other models compatible with the OpenAI Python SDK, you can configure them by modifying theopenai_base_url setting in the config file or using theOPENAI_BASE_URL environment variable .
Example:
openai_base_url: https://your-custom-api-url.com/v1Useoai-compat: prefix for the model name to pass non-GPT model names to the API. For example, to chat with Llama3-70b onTogether, use the following command:
OPENAI_API_KEY=$TOGETHER_API_KEY OPENAI_BASE_URL=https://api.together.xyz/v1 gpt general --model oai-compat:meta-llama/Llama-3-70b-chat-hfThe prefix is stripped before sending the request to the API.
Similarly, use theoai-azure: model name prefix to use a model deployed via Azure Open AI. For example,oai-azure:my-deployment-name.
With assistant configuration, you can override the base URL and API key for a specific assistant.
# ~/.config/gpt-cli/gpt.ymlassistants:llama:model:oai-compat:meta-llama/llama-3.3-70b-instructopenai_base_url_override:https://openrouter.ai/api/v1openai_api_key_override:$OPENROUTER_API_KEY
To use Claude, you should have an API key fromAnthropic (currently there is a waitlist for API access). After getting the API key, you can add an environment variable
export ANTHROPIC_API_KEY=<your_key_here>
or a config line in~/.config/gpt-cli/gpt.yml:
anthropic_api_key:<your_key_here>
Now you should be able to rungpt with--model claude-3-(opus|sonnet|haiku)-<date>.
gpt --model claude-3-opus-20240229
Claude 3.7 Sonnet supports an extended thinking mode, which shows Claude's reasoning process before delivering the final answer. This is useful for complex analysis, advanced STEM problems, and tasks with multiple constraints.
Enable it with the--thinking parameter, specifying the token budget for the thinking process:
gpt --model claude-3-7-sonnet-20250219 --thinking 32000
You can also configure thinking mode for specific assistants in your config:
assistants:math:model:claude-3-7-sonnet-20250219thinking_budget:32000messages: -{ role: system, content: "You are a math expert." }
Note: When thinking mode is enabled, the temperature is automatically set to 1.0 and top_p is unset as required by the Claude API.
export GOOGLE_API_KEY=<your_key_here>
or
google_api_key:<your_key_here>
export COHERE_API_KEY=<your_key_here>
or
cohere_api_key:<your_key_here>
About
Command-line interface for ChatGPT, Claude and Bard