AIChat 中文使用文档

概述

AIChat 是一个全能的命令行界面（CLI）工具，支持与多种大型语言模型（LLM）进行交互。它集成了 Shell 助手、聊天式 REPL、RAG（检索增强生成）、AI 工具和代理等功能，支持 OpenAI、Claude、Gemini、Ollama、Grok 等 20 多种主流 LLM 提供商。AIChat 旨在提升命令行效率，帮助用户通过自然语言完成任务。

当前日期：2025年2月21日

主要功能

Shell 助手
- 通过自然语言描述任务，AIChat 会生成并执行对应的 Shell 命令。
- 自动适配操作系统和 Shell 环境。
交互式 Chat-REPL
- 支持 Tab 自动补全、多行输入、历史搜索、可配置按键绑定和自定义 REPL 提示符。
- 提供上下文感知的会话功能。
RAG（检索增强生成）
- 将外部文档（如本地文件、目录或远程 URL）集成到对话中，提升回答的准确性和上下文相关性。
AI 工具与代理
- 通过函数调用连接外部工具和数据源，扩展 LLM 功能。
- 支持自动化任务、信息检索和操作执行。
HTTP 服务器
- 内置轻量级服务器，提供聊天、嵌入和重排序 API，以及 LLM 游乐场和竞技场。
多平台支持
- 无缝集成超过 20 个 LLM 提供商，包括 OpenAI、Claude、Gemini、Grok 等。
- 支持 macOS、Linux 和 Windows。

安装步骤

下载二进制文件
- 从 GitHub Releases 下载适用于 macOS、Linux 或 Windows 的预构建二进制文件。
- 解压文件并将 aichat 添加到系统路径（$PATH）中。
配置初始化
- 首次运行 aichat 时，会引导你初始化配置文件。
- 可编辑配置文件（参考 config.example.yaml）以自定义设置。
验证安装
- 在终端运行 aichat --version，确认版本号输出。

使用方法

基本命令格式

aichat [选项] [文本]...

常用选项

-m, --model <MODEL>：选择 LLM 模型（如 openai:gpt-4o）。
-r, --role <ROLE>：选择角色以定制 LLM 行为。
-s, --session [<SESSION>]：启动或加入会话。
-e, --execute：执行自然语言命令。
-f, --file <FILE>：附带文件（如图片、文本）发送消息。
--serve [<ADDRESS>]：启动 HTTP 服务器（默认地址 127.0.0.1:8000）。
--info：显示系统信息。
-h, --help：查看帮助。

示例

基本聊天
```
aichat 讲个笑话
```
输出一个笑话。
执行命令
```
aichat -e 安装 nvim
```
生成并执行安装 Neovim 的命令。

代码生成

aichat -c 用 JavaScript 写斐波那契数列

只输出代码，不含注释。

启动服务器
```
aichat --serve
```
访问：
- 聊天 API: http://127.0.0.1:8000/v1/chat/completions
- 游乐场: http://127.0.0.1:8000/playground
- 竞技场: http://127.0.0.1:8000/arena?num=2

附带文件

aichat -f screenshot.png 提取图片中的文本

对图片进行 OCR 处理。

进入 REPL 模式
```
aichat
```
进入交互式 REPL，按 Ctrl+D 退出。

REPL 命令

在 REPL 模式下，可使用以下命令（以 . 开头）：

.help：显示帮助。
.model：切换 LLM 模型。
.role：使用角色。
.session：开始上下文感知会话。
.file：附带文件提交消息。
.set：修改配置参数（如 .set max_output_tokens 4096）。
.exit：退出 REPL。

高级功能

自定义角色

在 <aichat-config-dir>/roles/ 创建 Markdown 文件（如 grammar-genie.md），定义提示和模型配置。

示例：

---
model: openai:gpt-4o
temperature: 0
---
你的任务是改写提供的文本，确保语法正确并保留原意。

函数调用

通过 llm-functions 创建 Bash/JavaScript/Python 工具。
配置 use_tools 以启用（如 execute_command,fs）。

会话管理

使用 -s 或 .session 保持对话上下文。
设置 save_session: true 自动保存会话。

RAG 使用

初始化 RAG：
```
aichat --rag rag1
```
编辑文档：.edit rag-docs。

支持的 LLM 提供商

包括但不限于：

OpenAI
Claude
Gemini
Ollama
Groq
XAI Grok
Cohere
Perplexity
任何 OpenAI 兼容 API

自定义主题

支持深色和浅色主题。
下载 .tmTheme 文件到配置目录，分别命名为 dark.tmTheme 和 light.tmTheme。

许可证

AIChat 采用 MIT 或 Apache 2.0 许可证，用户可自由选择。

资源链接

GitHub 主页: sigoden/aichat
函数调用扩展: sigoden/llm-functions
最新发布: GitHub Releases

这份文档涵盖了 AIChat 的核心内容，你可以直接将其保存为 Markdown 文件（如 aichat-docs-cn.md），方便后续查阅或分享。如需更详细的配置说明，请参考官方 Wiki 或配置文件示例。有什么问题欢迎随时提问！

在命令行中集成AI - aichat | AIChat 中文使用文档