aio - 简化AI终端交互

欢迎使用aio 命令行工具的README——这是您通过终端与AI引擎无缝通信的入口。此工具简化了与AI API（包括OpenAI API）的交互，并使用集成Markdown格式方便地格式化结果。无论您是在寻找信息、生成内容还是进行AI实验，aio 都能满足您的需求。

0.9版本重大更改

aio 命令行参数已更改，以提高易用性。有关新界面的更多信息，请参阅参数清单。

0.8版本重大更改

默认凭证路径已从 ~/.config/aio/creds.yml 更改为 ~/.cache/aio/creds.yml。

目录

• aio - 简化AI终端交互
  • 0.9版本重大更改
  • 0.8版本重大更改
  • 目录
  • 新增：从代码块运行代码
  • 简介
  • 安装
  • 从crates.io安装
    • 从GitHub发布版安装
    • 从源代码安装
  • 用法
  • 参数
  • 配置
  • 凭证
  • 示例
  • 别名
  • 贡献

新增：从代码块运行代码

现在您可以使用标志 -r|--run 从代码块运行代码

简介

aio 命令行工具旨在通过在您的终端内提供直观的界面来简化您与AI引擎的交互。利用OpenAI API等大型语言模型的力量，而无需离开您的命令行环境。

安装

从crates.io安装

您现在可以使用以下命令从crates.io安装aio

cargo install aio-cli

程序将被安装到您的 ~/.cargo/bin 目录。

从GitHub发布版安装

要安装 aio，请按照以下步骤操作

1. 根据您的操作系统和架构下载最新发布版。

2. 解压缩下载的存档。

3. (可选) 将二进制文件解压到的目录路径添加到您的 PATH。在您的 ~/.bashrc 或 ~/.zshrc （或 ~/.zshenv）

   中写入此路径。

   PATH=/path/to/aio/bin:$PATH
   

   或者，您可以将 aio 可执行文件复制到 /usr/local/bin。

   # sudo may be required
   sudo cp aio /usr/local/bin
   

从源代码安装

要安装 aio，请按照以下步骤操作

1. 先决条件：请确保您已在系统上安装了 Rust。如果没有，您可以 安装 Rust。

2. 克隆仓库：将 aio 仓库克隆到您的本地计算机上

   git clone https://github.com/yourusername/aio.git
   

3. 构建和安装：导航到 aio 目录并构建工具

   cd aio
   cargo install --path .
   

用法

使用 aio 非常简单。在您的终端中，只需使用适当的参数调用工具，与 AI 引擎通信并接收格式化的响应。

aio --engine openai:ask "Write an informative article about space exploration."

参数

aio 命令行工具支持以下参数

• --config_path：配置文件路径。默认为 ~/.config/aio/config.yaml。

• --creds_path：凭证文件路径。默认为 ~/.config/aio/creds.yaml。

• -e|--engine <ENGINE>：要使用的 AI 引擎名称。您可以可选地从 配置文件 中附加自定义提示名称（例如，openai:command）。ENGINE 列表

  • openai：OpenAI API
  • from-file：从文件中读取提示。用于调试或测试文件很有用。

• -f|--formatter <FORMATTER>：要使用的格式化程序。可能的 FORMATTER

  • markdown：将文本响应解析为 Markdown 并在控制台中格式化。
  • raw：不解析响应文本。仅显示原始文本响应。

  默认情况下，如果是在终端/tty 中，格式化程序设置为 markdown，否则为 raw。

• -r|--run <METHOD>：如果支持该语言，则运行代码块。可能的 METHOD

  • no：不运行任何内容。
  • ask：询问是否运行代码。
  • force：不询问直接运行代码。

  默认情况下，run 设置为 no。

• input：用户文本提示，将用于与 AI 引擎交互。

• -h|--help：显示帮助信息。

• -V|--version：显示版本。

注意：现在 aio 可以从 stdin 读取输入而不是从参数中读取。

配置

为了微调您的 AI 交互，您可以创建和修改 YAML 格式的配置文件。该文件允许您为不同的 AI 引擎定义提示、消息和参数。有关更多信息，请参阅 配置详情 文件。

凭证

通过将凭证存储在凭证文件中来保护您的API凭证。这确保了与AI引擎进行认证的安全便捷方式。可以使用creds.yaml文件来设置凭证。有关更多信息，请参阅凭证详细信息文件。

示例

以下是一些启动示例

1. 使用OpenAI引擎生成创意故事

   aio --engine openai "Once upon a time in a distant galaxy..."
   

2. 请求提取压缩存档的命令

   aio --engine openai:command "Extract a compressed archive `./archive.tar.gz` to the current directory."
   

别名

整个命令可能很长，难以输入。您可以在shell中使用别名来缩短命令。

alias ask='aio --engine openai:ask'
alias command='aio --engine openai:command'

ask "Write an informative article about space exploration."
command "Extract a compressed archive `./archive.tar.gz` to the current directory."

贡献

我们欢迎社区对aio项目做出贡献。如果您有兴趣进行改进、修复问题或添加新功能，请随时贡献。

通过为aio做出贡献，您成为了一个开源社区的一员，该社区致力于改进终端中的AI交互。

有关更详细的指南，请参阅我们的贡献指南。

我们感谢您的贡献，并期待与您合作！