gpt-cli
聊天LLM的命令行界面。
支持的提供商
- OpenAI
- Anthropic
- Google Gemini
- Cohere
- 其他与OpenAI兼容的API(例如Together、OpenRouter、本地模型与LM Studio)
特点
- 命令行界面:直接从终端与ChatGPT或Claude互动。
- 模型定制:为每个助手覆盖默认模型、温度和top_p值,使你可以精细控制AI的行为。
- 使用跟踪:通过令牌计数和价格信息跟踪你的API使用情况。
- 快捷键:使用Ctrl-C、Ctrl-D和Ctrl-R快捷键更轻松地管理对话和输入控制。
- 多行输入:进入多行模式以进行更复杂的查询或对话。
- Markdown支持:为聊天会话启用或禁用Markdown格式,以便根据你的喜好调整输出。
- 预定义消息:为你的自定义助手设置预定义消息,以建立上下文或角色扮演场景。
- 多个助手:在不同的助手之间轻松切换,包括配置文件中定义的一般、开发和自定义助手。
- 灵活的配置:在YAML配置文件中定义你的助手、模型参数和API密钥,方便定制和管理。
安装
此安装假设你的机器上有Linux/OSX,已安装Python和pip。
pip install gpt-command-line
从源码安装最新版本:
pip install git+https://github.com/kharvd/gpt-cli.git
或手动克隆仓库进行安装:
git clone https://github.com/kharvd/gpt-cli.git
cd gpt-cli
pip install .
将OpenAI API密钥添加到你的 .bashrc
文件中(在你的主文件夹根目录中)。
在这个例子中我们使用nano,你可以使用任何文本编辑器。
nano ~/.bashrc
export OPENAI_API_KEY=<your_key_here>
运行工具
gpt
你还可以使用 gpt.yml
文件进行配置。请参阅下面的配置部分。
使用
确保将 OPENAI_API_KEY
环境变量设置为你的OpenAI API密钥(或将其放在 ~/.config/gpt-cli/gpt.yml
文件中,如下所述)。
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}]
运行一个与ChatGPT的对话会话。查看更多信息,请访问 https://github.com/kharvd/gpt-cli。
位置参数:
{dev,general,bash}
要使用的助手名称。`general`(默认)是一个通常有帮助的助手,`dev`是一个提供简短回复的软件开发助手。你可以在配置文件
~/.config/gpt-cli/gpt.yml 中定义自己的助手。详见README。
可选参数:
-h, --help 显示此帮助消息并退出
--no_markdown 在聊天会话中禁用Markdown格式。
--model MODEL 要在聊天会话中使用的模型。覆盖为助手定义的默认模型。
--temperature TEMPERATURE
要在聊天会话中使用的温度。覆盖为助手定义的默认温度。
--top_p TOP_P 要在聊天会话中使用的top_p。覆盖为助手定义的默认top_p。
--log_file LOG_FILE 要写入日志的文件。支持strftime格式代码。
--log_level {DEBUG,INFO,WARNING,ERROR,CRITICAL}
要使用的日志级别
--prompt PROMPT, -p PROMPT
如果指定,将不会启动交互式聊天会话,而是将响应打印到标准输出并退出。可以多次指定。使用 `-` 从标准输入读取提示。默认
--no_markdown。
--execute EXECUTE, -e EXECUTE
如果指定,将提示传递给助手并允许用户在执行前编辑生成的Shell命令。默认 --no_stream。使用 `-` 从标准输入读取提示。
--no_stream 如果指定,将不会将响应流传到标准输出。这在你希望在脚本中使用响应时非常有用。当未指定 --prompt 选项时忽略。
--no_price 禁用价格记录。
输入 :q
或 Ctrl-D 退出,:c
或 Ctrl-C 清除对话,:r
或 Ctrl-R 重新生成最后一个响应。
要进入多行模式,输入反斜杠 \
并换行。按ESC,然后回车退出多行模式。
你可以使用提示末尾的 --model
、--temperature
和 --top_p
参数覆盖模型参数。例如:
> What is the meaning of life? --model gpt-4 --temperature 2.0
生命的意义是主观的,对于不同的人和独特的文化/哲学/伦理来说可能是不同的。
dev
助手被指示为软件开发专家,并提供简短回复。
$ gpt dev
bash
助手被指示为Bash脚本专家,并只提供Bash命令。使用 --execute
选项执行命令。与 gpt-4
模型搭配效果最佳。
gpt bash -e "如何列出目录中的文件?"
这将提示你在 $EDITOR
中编辑命令,然后再执行它。
配置
你可以在配置文件 ~/.config/gpt-cli/gpt.yml
中配置助手。该文件为YAML格式,具有以下结构(参见 config.py)
default_assistant: <assistant_name>
markdown: False
openai_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>
messages:
- { role: <role>, content: <message> }
- ...
<assistant_name>:
...
你可以覆盖预定义助手的参数。
你可以通过设置 default_assistant
字段来指定默认使用的助手。如果不指定,默认助手是 general
。你还可以为助手指定 model
、temperature
和 top_p
。如果不指定,则使用默认值。这些参数也可以通过命令行参数覆盖。
示例:
default_assistant: dev
markdown: True
openai_api_key: <openai_api_key>
assistants:
pirate:
model: gpt-4
temperature: 1.0
messages:
- { role: system, content: "你是一名海盗。" }
$ gpt pirate
> Arrrr
啊哈,伙计!是什么让你来到这片水域?是寻宝还是冒险?我们将一起航行在大海上。准备好你的地图和指南针,我们有一个漫长的航程!
自定义OpenAI API URL
如果你正在使用其他与OpenAI Python SDK兼容的模型,可以通过修改配置文件中的 openai_base_url
设置或使用 OPENAI_BASE_URL
环境变量进行配置。
示例:
openai_base_url: https://your-custom-api-url.com/v1
使用 oai-compat:
前缀为模型名称传递非GPT模型名称到API。例如,要在 https://together.ai 使用Llama3-70b模型进行聊天,使用以下命令:
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
前缀在发送请求到API之前会被剥离。
其他聊天机器人
Anthropic Claude
要使用Claude,你应该有来自 Anthropic 的API密钥(目前API访问有候补名单)。获取API密钥后,你可以添加环境变量
export ANTHROPIC_API_KEY=<your_key_here>
或在 ~/.config/gpt-cli/gpt.yml
里添加配置行:
anthropic_api_key: <your_key_here>
现在,你应该可以运行 gpt
,使用 --model claude-3-(opus|sonnet|haiku)-<date>
。
gpt --model claude-3-opus-20240229
Google Gemini
export GOOGLE_API_KEY=<your_key_here>
或
google_api_key: <your_key_here>
Cohere
export COHERE_API_KEY=<your_key_here>
或
cohere_api_key: <your_key_here>