Skip to content
文档
Chat2DB CLI
CLI 概览

Chat2DB CLI 概览

Chat2DB CLI 是 Chat2DB 的命令行入口，命令名为 chat2db。它适合在终端、脚本、自动化任务和 AI Agent 工作流里管理 Chat2DB Pro / Local，而不是每次都打开图形界面。

本文档按 Chat2DB CLI 0.1.25 的命令面编写。命令语法以本机 chat2db --help、chat2db version --json 和各子命令 --help 输出为准。

适用场景

场景入口
安装 CLI、检查当前状态、安装补全安装与状态检查
查看数据源、测试连接、创建数据源、执行 SQL数据源与 SQL
给 AI Agent 暴露 Chat2DB MCP 工具，安装 Chat2DB-CLI-SkillMCP 与 Agent 集成
更新 CLI、卸载 CLI 或应用、查看安装日志、恢复异常状态更新与排障

支持范围

Chat2DB CLI 当前支持 macOS 和 Windows 上的 Chat2DB Pro / Local 桌面应用。应用安装、启动、运行时、数据源、SQL 和 MCP 命令都依赖本机 Chat2DB 应用。

CLI 覆盖以下能力：

  • 安装、启动、停止、重启 Chat2DB Pro / Local
  • 检查 App、CLI runtime 和 MCP 状态
  • 启动本机 headless runtime，用于数据源和 SQL 命令
  • 列出数据源、测试连接、创建/更新/删除数据源
  • 列出数据库、schema、表和表结构
  • 执行 SQL 查询并分页读取结果
  • 启用、禁用、重启、调用 Chat2DB 桌面 MCP endpoint
  • 安装或更新 Chat2DB-CLI-Skill 到 Codex / Claude Code
  • 更新或卸载 CLI 本身
  • 安装 zsh、bash、fish shell completion

Edition

大多数命令支持 --edition pro 或 --edition local。

edition含义默认情况
proChat2DB Pro大多数命令默认使用 Pro
localChat2DB Local需要操作 Local 时显式指定
all同时检查或处理两个 edition仅部分 lifecycle/status 类命令支持

建议先运行：

chat2db version --json
chat2db status --json

status 会告诉你 Pro / Local 的 App、CLI runtime、MCP 当前状态，以及下一步推荐命令。

命令影响范围

CLI 文档里的命令按影响范围分为几类：

类型示例说明
只读version、status、db datasources只读取本机或 runtime 状态
本机状态变更runtime start、runtime stop、completions --install会启动/停止 runtime 或改 shell 配置
App 生命周期变更install、start、stop、restart、uninstall会安装、打开、退出或卸载桌面应用
数据源变更datasource-create、datasource-update、datasource-delete会改变 Chat2DB 保存的数据源
外部系统风险sql querySQL 是否修改数据库取决于你执行的语句
凭据敏感mcp config、带 --password 的命令输出或参数中可能包含 token、密码或连接信息

不要把真实密码、MCP token、Authorization header、带凭据的 JDBC URL、生产库管理员账号写进文档、工单或聊天记录。

常用入口

chat2db --help
chat2db install --help
chat2db db --help
chat2db sql --help
chat2db mcp --help

如果本文档与本机 --help 输出不一致，以 chat2db --help 为准，并优先更新 CLI 文档。

Local离线激活安装与状态检查