3个版本 (破坏性更新)

0.3.0 2023年4月4日
0.2.0 2023年3月28日
0.1.0 2023年3月27日

#628机器学习

每月35次下载

MIT许可证

9MB
376

cligpt

dependency status

cligpt recording

cligpt是用于与OpenAI的ChatGPT API交互的命令行界面。使用cligpt,您可以通过从终端向ChatGPT发送消息来快速轻松地生成文本。只需提供您的OpenAI API密钥和要生成的消息,然后cligpt将处理其余部分。

cligpt是用Rust编写的,并使用clapasync-openai软件包为ChatGPT API提供用户友好的界面。

继续阅读以了解如何安装使用cligpt

可用模型

常见用法

  • 生成创意写作想法或头脑风暴主题。
  • 帮助回答特定主题的问题。
  • 草拟电子邮件或其他专业写作作品。
  • 总结长篇文章。
  • 在不同语言之间翻译文本。

安装

要求

在安装 cligpt 之前,您需要确保已安装 Rust(版本 1.65.0 或更高版本)和 Cargo,Rust 的包管理器。

安装 Rust 和 Cargo 后,您可以使用 Cargo 从 crates.io 安装 cligpt

cargo install cligpt

这将下载必要的依赖项,编译 cligpt 二进制文件,并将其安装到您的系统中。安装完成后,您可以在终端中键入 cligpt 来运行它。这就完成了!

直接从 GitHub

或者,您可以使用 Cargo 直接从 GitHub 仓库安装 cligpt,方法如下

cargo install --git=https://github.com/schneiderfelipe/cligpt.git

通过克隆 GitHub 仓库

您也可以通过克隆 GitHub 仓库并运行 cargo build 从源代码构建 cligpt

git clone https://github.com/schneiderfelipe/cligpt.git
cd cligpt
cargo build --release

构建后,二进制文件将位于 target/release/cligpt

或者,您可以直接安装二进制文件而不是仅构建它。只需运行 cargo install --path=. 而不是 cargo build --release

用法

要使用 cligpt,您需要提供您的 OpenAI API 密钥 和您想要生成的消息。您可以使用 -k--api-key 选项提供 API 密钥,或者通过设置 OPENAI_API_KEY 环境变量。

以下是一个使用示例

$ echo 'Hello, ChatGPT!' | cligpt --api-key YOUR_API_KEY
Hello there, how may I assist you today?

这将使用您的 API 密钥将消息 'Hello, ChatGPT!' 发送到 ChatGPT API,并将生成的文本打印到您的终端。

您还可以指定其他选项来自定义文本生成,例如温度和要使用的语言模型。

例如,您可以将温度设置为 0.9 并使用 GPT-4

$ echo 'Hello, ChatGPT!' | cligpt --temperature 0.9 --model gpt4
Hello! How can I help you today? If you have any questions or need assistance, feel free to ask.

在上面的示例中,API 密钥将从中读取环境变量。

cligpt 仅支持从标准输入接收输入

$ echo "Repeat this message exactly how you read it" | cligpt
Repeat this message exactly how you read it.

cligpt 还存储单个聊天会话,您可以使用 cligpt show 查看它。例如

$ echo 'What is the capital of France?' | cligpt
The capital of France is Paris.

$ cligpt show
user:
What is the capital of France?

assistant:
The capital of France is Paris.

您可以使用存储的聊天会话继续对话

$ echo "What is the city's population?" | cligpt
As of 2021, the population of Paris is estimated to be around 2.2 million people. However, the population of the greater Paris metropolitan area, which includes surrounding suburbs and municipalities, is estimated to be around 12 million people.

$ cligpt show
user:
What is the capital of France?

assistant:
The capital of France is Paris.

user:
What is the city's population?

assistant:
As of 2021, the population of Paris is estimated to be around 2.2 million people. However, the population of the greater Paris metropolitan area, which includes surrounding suburbs and municipalities, is estimated to be around 12 million people.

在某些情况下,我们会通过截断聊天来管理聊天上下文,在这些情况下,我们确信我们只删除了不相关信息。这是一种保守的方法,所以有时可能会失败。如果您注意到聊天上下文有问题,请 提交问题,以便我们解决。

有关可用选项的更多信息,请运行 cligpt --help

贡献

欢迎为 cligpt 贡献!如果您发现了一个错误,有功能请求或想贡献代码,请在 GitHub 仓库提交问题发起拉取请求

许可证

cligpt采用MIT许可证发布。

依赖项

~13–30MB
~450K SLoC