Deepfish Ai

---

• English | 中文

目录

• 目录
• 1. 介绍
• 2. 安装
  • 前置要求
  • 通过npm安装
  • 从源码安装
• 3. 快速使用
• 4. 命令说明
  • 基础对话
  • 配置管理
  • 模型管理
  • Skill 管理
  • 工具管理
  • 会话管理
  • 任务管理
  • 长任务规划
  • MCP 管理
  • 服务管理
  • 缓存管理（AI自我学习的缓存）
• 5. MCP 扩展配置
  • 配置示例
• 6. Tool 与 Skill 扩展说明
  • 当前目录扩展
  • 全局扩展
• 7. 系统配置文件说明
  • 配置文件字段
  • AI 模型配置字段
• 8. 贡献
• 9. 许可证
• 10. 支持

1. 介绍

一款高效便捷的AI驱动命令行工具，致力于打破自然语言与操作系统指令、文件操作指令之间的壁垒，让非专业开发者也能通过简单的自然语言描述，快速生成可直接执行的操作指令，大幅提升终端操作效率。 核心特性：

• 多模型兼容：无缝支持DeepSeek、Ollama，以及所有遵循OpenAI API规范的AI模型，可根据需求灵活切换，适配不同场景下的指令生成需求。

• 自然语言转指令：精准解析自然语言需求，自动转换为对应的操作系统命令（如Linux、Windows、macOS终端指令）和文件操作指令（如创建、删除、修改文件/目录），无需手动编写复杂命令。

• Skill 扩展：Skill 是 AI 的工作流知识包，通过 Markdown 文件定义特定领域的操作流程和最佳实践。安装 Skill 后，AI 能自动遵循其中的规范来执行任务，例如代码审查流程、文档生成模板等。支持兼容 OpenClaw 的 Skill 生态，可通过 ai skills 命令进行安装、启用与管理。

• Tool 扩展：Tool 是 AI 可调用的自定义函数工具，通过 TypeScript 文件定义。你可以编写 Tool 来扩展 AI 的能力边界，例如调用第三方 API、操作数据库、处理特定文件格式等。支持通过 ai tools generate 命令让 AI 自动生成 Tool，降低开发门槛。

• MCP 扩展：MCP（Model Context Protocol）是一种标准化的模型上下文协议，允许 AI 连接外部工具和数据源。通过配置 MCP Server，AI 可以获得浏览器自动化、数据库查询、文件系统访问等能力。DeepFish 内置 MCP 支持，只需简单配置即可接入各类 MCP 服务。

• 高度可扩展：支持通过扩展机制拓展功能边界，除基础的终端、文件操作外，可轻松实现翻译、小说创作、文件格式转换、数据处理等复杂任务，满足多样化使用需求。

2. 安装

前置要求

• Node.js（v22.14.0或更高版本）
• npm或yarn

通过npm安装

npm install -g deepfish-ai --verbose

从源码安装

git clone https://github.com/qq306863030/deepfish-ai.git
cd deepfish
npm install
npm link

3. 快速使用

ai models add # 输入名称, 输入你的模型配置
ai config use 你输入的名称
ai "帮我在当前目录写一篇关于未来科技的文章，用markdown格式输出"

4. 命令说明

基础对话

ai "你的问题或指令"

直接输入自然语言，AI 将自动解析并执行对应操作。同一个目录下只会保持一个 Agent 会话，因此在当前目录中多次执行 ai 命令会复用同一个上下文。

示例：

cd your-project
ai "你叫什么名字"
ai "我刚问了一个什么问题"

第二次提问时，AI 会基于当前目录中的同一会话上下文回答你刚才问过的问题。

配置管理

命令	说明
ai config edit	编辑配置文件
ai config view	查看当前配置
ai config reset	重置配置
ai config dir	查看配置目录

模型管理

命令	说明
ai models add	添加新模型
ai models ls	列出所有模型
ai models use <name>	切换使用的模型
ai models del <name>	删除指定模型

Skill 管理

命令	说明
ai skills ls	列出所有 Skill
ai skills add <name>	添加 Skill
ai skills del <index>	删除指定 Skill
ai skills enable <name|index>	启用 Skill
ai skills disable <name|index>	禁用 Skill
ai skills dir	查看 Skill 目录
ai skills generate xxx	通过 AI 生成 Skill

工具管理

命令	说明
ai tools ls	列出所有工具
ai tools dir	查看全局工具目录
ai tools add <name>	添加当前目录下的本地工具目录，可选择本地或全局生效
ai tools del <index>	按索引删除工具
ai tools generate xxx	通过 AI 生成工具

会话管理

命令	说明
ai session clear	清除会话历史
ai session dir	查看会话目录

任务管理

命令	说明
ai tasks ls	列出所有任务
ai tasks add <task>	添加任务
ai tasks del <index>	删除指定任务
ai tasks clear	清除所有任务

长任务规划

命令	说明
ai plan-do <任务描述>	将复杂任务拆解为子任务并逐步执行完成
ai plan-continue	继续执行被中断的 plan-do 任务

MCP 管理

命令	说明
ai mcp ls	列出所有 MCP 服务器
ai mcp edit	编辑 MCP 配置
ai mcp enable <name|index>	启用 MCP 服务器
ai mcp disable <name|index>	禁用 MCP 服务器

服务管理

命令	说明
ai serve	启动服务
ai serve start	启动服务
ai serve stop	停止服务
ai serve restart	重启服务

缓存管理（AI自我学习的缓存）

命令	说明
ai cache ls	列出缓存
ai cache edit <index|id>	编辑缓存项
ai cache del <index|id>	删除缓存项

5. MCP 扩展配置

MCP（Model Context Protocol）允许 AI 连接外部工具和服务。通过 ai mcp edit 命令编辑 MCP 配置文件，添加你需要的 MCP Server。

配置示例

以下示例配置了 Chrome DevTools MCP Server，使 AI 能够操控浏览器进行自动化操作：

{
  "mcpServers": {
    "chrome-devtools": {
      "command": "npx",
      "args": ["-y", "chrome-devtools-mcp@latest"]
    }
  }
}

配置完成后，AI 将自动加载 MCP Server 提供的工具，你可以在对话中直接让 AI 使用这些能力。

6. Tool 与 Skill 扩展说明

DeepFish 支持通过 Tool 和 Skill 扩展 AI 的能力。扩展文件可以放在当前工作目录的 .deepfish-ai 目录中，也可以放在全局配置目录中。

• Tool 扩展：用于定义 AI 可直接调用的自定义函数工具，适合封装 API 调用、数据库操作、文件处理等能力。可以使用 ai tools generate xxx 命令让 AI 根据描述生成 Tool。
  • 在 Tool 函数中，可以通过调用 this.createSubAgent(prompt: string) 创建子 Agent，并将任务说明作为 prompt 传入。
  • 在 Tool 函数中，可以通过 this.curAgent 获取当前正在执行该 Tool 的 Agent 实例；当 Tool 运行在子 Agent 中时，this.curAgent 指向该子 Agent，而不是主 Agent。可用于访问当前 Agent 的上下文能力，例如 this.curAgent.createSubAgent() 继续创建下级子 Agent。
• Skill 扩展：用于定义 AI 的工作流知识包，适合沉淀某类任务的执行步骤、规范和最佳实践。可以使用 ai skills generate xxx 命令让 AI 根据描述生成 Skill。

当前目录扩展

如果扩展只希望在当前目录下生效，请将扩展拷贝到当前目录的 .deepfish-ai 目录中：

当前目录/
└── .deepfish-ai/
    ├── tools/
    │   └── your-tool/
    └── skills/
        └── your-skill/

• Tool 扩展放入 当前目录/.deepfish-ai/tools/。
• Skill 扩展放入 当前目录/.deepfish-ai/skills/。
• 这种方式只对当前目录有效，适合项目级扩展或仅在某个项目中使用的能力。

全局扩展

如果扩展希望在所有目录下生效，请将扩展拷贝到全局配置目录中的 tools 或 skills 目录。

可以通过以下命令打开全局配置目录：

ai config dir

目录结构示例：

全局配置目录/
└── .deepfish-ai/
    ├── tools/
    │   └── your-tool/
    └── skills/
        └── your-skill/

• Tool 扩展放入 全局配置目录/.deepfish-ai/tools/。
• Skill 扩展放入 全局配置目录/.deepfish-ai/skills/。
• 这种方式对全局有效，适合通用工具或长期复用的工作流能力。

7. 系统配置文件说明

DeepFish 的系统配置文件位于用户目录下的 .deepfish-ai/config.json5，可通过以下命令打开或查看：

ai config edit
ai config view

配置文件字段

字段	类型	默认值	说明
aiList	array	[]	AI 模型配置列表，可添加多个模型配置。
currentModel	string	''	当前正在使用的 AI 配置名称，对应 aiList 中某一项的 name。
maxIterations	number	-1	AI 完成工作流的最大迭代次数，-1 表示不限制。
maxMemoryExpireTime	number	30	会话记忆最大保留时间，单位为天；-1 表示永久保留，0 表示不记录。
maxLogExpireTime	number	3	日志最大保留时间，单位为天；-1 表示永久保留，0 表示不记录。
maxBlockFileSize	number	50	最大分块文件大小，单位为 KB；超过该大小的文件会按块处理。
encoding	string	'auto'	命令行输出编码，可设置为 utf-8、gbk 等；auto 或空值表示自动判断。
maxSubAgentCount	number	2	最大并行子 Agent 数量，-1 表示不限制。
isPrintThinking	boolean	true	是否打印 AI 思考过程中的中间信息。
serve.port	number	8866	DeepFish 本地服务端口。

AI 模型配置字段

aiList 中的每一项表示一个 AI 模型配置，常见字段如下：

字段	类型	说明
name	string	模型配置名称，用于 ai models use <name> 切换模型。
type	string	模型供应商类型，例如 DeepSeek、Ollama、OpenAICompatible。
baseUrl	string	模型 API 地址。
model	string	实际调用的模型名称。
apiKey	string	模型 API Key。
temperature	number	生成随机性参数，数值越高输出越发散，数值越低输出越稳定。
maxContextLength	number	模型最大上下文长度，单位为 tokens。

8. 贡献

欢迎贡献！请随时提交Pull Request。

9. 许可证

本项目采用MIT许可证 - 详见LICENSE文件。

10. 支持

如有问题和疑问，请在GitHub仓库上提交issue。