贡献#

要为这个工具做出贡献，首先检出代码。然后创建一个新的虚拟环境：

cd llm
python -m venv venv
source venv/bin/activate

或者如果你正在使用 pipenv：

pipenv shell

现在安装依赖项和测试依赖项：

pip install -e '.[test]'

运行测试：

pytest

调试技巧#

默认的OpenAI插件具有调试机制，用于显示发送到OpenAI API的确切请求和响应。

设置LLM_OPENAI_SHOW_RESPONSES环境变量如下：

LLM_OPENAI_SHOW_RESPONSES=1 llm -m chatgpt 'three word slogan for an an otter-run bakery'

这将在控制台输出API请求和响应的详细信息。

使用 --no-stream 来查看更易读的响应体版本，避免流式传输响应：

LLM_OPENAI_SHOW_RESPONSES=1 llm -m chatgpt --no-stream \
  'three word slogan for an an otter-run bakery'

文档#

本项目的文档使用MyST编写 - 它是用Markdown编写的，并使用Sphinx进行渲染。

要在本地构建文档，请运行以下命令：

cd docs
pip install -r requirements.txt
make livehtml

这将启动一个实时预览服务器，使用 sphinx-autobuild。

文档中的CLI --help示例是使用Cog管理的。按如下方式更新这些文件：

just cog

你需要Just安装才能运行此命令。

发布流程#

发布新版本：

  1. 使用新的更改更新 docs/changelog.md。

  2. 更新setup.py中的版本号

  3. Create a GitHub release 为新版本。

  4. 等待包推送到PyPI，然后…

  5. 运行regenerate.yaml工作流以将Homebrew tap更新到最新版本。