Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kharvd/gpt-cli

Command-line interface for ChatGPT, Claude and Bard
https://github.com/kharvd/gpt-cli

anthropic anthropic-claude assistant bard chatgpt claude cli command-line google-bard gpt-3 gpt-4 gpt-cli gpt-client llm openai palm2

Last synced: about 12 hours ago
JSON representation

Command-line interface for ChatGPT, Claude and Bard

Awesome Lists containing this project

README 

        
# gpt-cli



Command-line interface for chat LLMs.



## Supported providers



- OpenAI

- Anthropic

- Google Gemini

- Cohere

- Other APIs compatible with OpenAI (e.g. Together, OpenRouter, local models with LM Studio)



![screenshot](https://github.com/kharvd/gpt-cli/assets/466920/ecbcccc4-7cfa-4c04-83c3-a822b6596f01)



## Features



- **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.

- **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.



## Installation



This install assumes a Linux/OSX machine with Python and pip available.



```bash

pip install gpt-command-line

```



Install latest version from source:



```bash

pip install git+https://github.com/kharvd/gpt-cli.git

```



Or install by cloning the repository manually:



```bash

git clone https://github.com/kharvd/gpt-cli.git

cd gpt-cli

pip 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 ~/.bashrc

export OPENAI_API_KEY=

```



Run the tool



```

gpt

```



You can also use a `gpt.yml` file for configuration. See the [Configuration](README.md#Configuration) section below.



## Usage



Make sure to set the `OPENAI_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]

              [--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.

  --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.



The `dev` assistant is instructed to be an expert in software development and provide short responses.



```bash

$ gpt dev

```



The `bash` 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 the `gpt-4` model.



```bash

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.



## Configuration



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 also [config.py](./gptcli/config.py))



```yaml

default_assistant: 

markdown: False

openai_api_key: 

anthropic_api_key: 

log_file: 

log_level: 

assistants:

  :

    model: 

    temperature: 

    top_p: 

    messages:

      - { role: , content:  }

      - ...

  :

    ...

```



You can override the parameters for the pre-defined assistants as well.



You can specify the default assistant to use by setting the `default_assistant` field. If you don't specify it, the default assistant is `general`. You can also specify the `model`, `temperature` and `top_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:



```yaml

default_assistant: dev

markdown: True

openai_api_key: 

assistants:

  pirate:

    model: gpt-4

    temperature: 1.0

    messages:

      - { role: system, content: "You are a pirate." }

```



```

$ gpt pirate



> Arrrr

Ahoy, 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!

```



### Read other context to the assistant with !include



You can read in files to the assistant's context with !include .



```yaml

default_assistant: dev

markdown: True

openai_api_key: 

assistants:

  pirate:

    model: gpt-4

    temperature: 1.0

    messages:

      - { role: system, content: !include "pirate.txt" }

```



### Customize OpenAI API URL



If you are using other models compatible with the OpenAI Python SDK, you can configure them by modifying the `openai_base_url` setting in the config file or using the `OPENAI_BASE_URL` environment variable .



Example:



```

openai_base_url: https://your-custom-api-url.com/v1

```



Use `oai-compat:` prefix for the model name to pass non-GPT model names to the API. For example, to chat with Llama3-70b on [Together](https://together.ai), use the following command:



```bash

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-hf

```



The prefix is stripped before sending the request to the API.



Similarly, use the `oai-azure:` model name prefix to use a model deployed via Azure Open AI. For example, `oai-azure:my-deployment-name`.



## Other chat bots



### Anthropic Claude



To use Claude, you should have an API key from [Anthropic](https://console.anthropic.com/) (currently there is a waitlist for API access). After getting the API key, you can add an environment variable



```bash

export ANTHROPIC_API_KEY=

```



or a config line in `~/.config/gpt-cli/gpt.yml`:



```yaml

anthropic_api_key: 

```



Now you should be able to run `gpt` with `--model claude-3-(opus|sonnet|haiku)-`.



```bash

gpt --model claude-3-opus-20240229

```



### Google Gemini



```bash

export GOOGLE_API_KEY=

```



or



```yaml

google_api_key: 

```



### Cohere



```bash

export COHERE_API_KEY=

```



or



```yaml

cohere_api_key: 

```