• 简体中文

      • Octop CLI 概览：所有命令与传输模式

      octop CLI 是与服务器二进制文件一同安装的单条命令。大多数命令可在离线模式下运行——直接读写 ~/.octop/——因此您无需启动服务器即可管理专家、用户、渠道和定时任务。少数命令（例如 chats repl、channel test）会自动启动嵌入式服务器，或要求已有 octop run。

      全局选项

      在任意子命令前传递以下标志，以控制输出格式和默认目标：

      选项环境变量作用
      --user TEXTOCTOP_USER管理类子命令的默认 --user（代其他用户操作）
      --agent TEXTOCTOP_AGENT子命令的默认 --agent
      --json—为列表类命令输出机器可读的 JSON
      -v, --version—打印已安装版本并退出

      传输模式

      每条 octop 命令会根据操作需求自动选择以下三种传输方式之一：

      离线（Offline）

      直接读写 ~/.octop/，无需运行中的服务器。用于 init、backup、plugin、agent list、user *、admin overview/audit、captcha reset 以及大多数 CRUD 命令。

      附加（Attach）

      通过 HTTP 连接到正在运行的 octop run 进程。用于 channel test、models ollama-*、provider test 等。CLI 不需要先 login：本机文件系统访问即足够，用 octop config set-user 固定操作用户。

      嵌入式（Embedded）

      为单条命令启动进程内临时服务器，执行完毕后退出。无需单独运行 octop run。用于 octop acp、octop chats repl、octop chats send 以及 octop agent create/from-expert/start/stop/reload。

      命令分类

      服务器命令

      init、run、service、update、captcha、user、clean、config、completion、version

      专家命令

      agent、chats、skills、models、provider、acp

      渠道与定时任务

      channel、cron、plugin、user、admin、backup

      命令参考

      提示

      在任意列表命令后加上 --json，即可获得机器可读的 JSON 输出——适合脚本和 CI 流水线。

      命令描述
      octop init引导 ~/.octop/（数据库、管理员账户、JWT 密钥）
      octop run在前台启动服务器
      octop service管理系统服务（Linux 上为 systemd，macOS 上为 launchd）
      octop agent创建、列出、启动、停止和重载专家
      octop chats聊天 REPL 与会话管理
      octop channelIM 渠道配置与管理
      octop cron定时任务管理
      octop providerLLM 提供商管理
      octop models模型目录与活动模型设置
      octop skills启用或禁用按专家划分的技能
      octop acp将专家暴露为 ACP 服务器（IDE 集成）
      octop backup导出与恢复备份
      octop user用户管理
      octop admin管理操作（审计日志、JWT 轮换）
      octop captcha登录验证码维护（reset 可解除误配提供方导致的锁定）
      octop plugin安装与管理插件
      octop update检查并安装更新
      octop clean重置 CLI 状态或清空 ~/.octop/
      octop config查看与编辑 CLI 状态（固定的默认用户 / 专家）
      octop completionShell 补全工具
      octop version打印已安装的 octop 版本

      CLI 状态文件

      文件 ~/.octop/cli_state.json 存储您的 CLI 会话状态：

      {
  "default_user": null,
  "default_agent": null
}
      字段描述
      default_user固定的 --user 值（通过 octop config set-user 设置）
      default_agent固定的 --agent 值（通过 octop agent use 设置）

      删除此文件即可清除 CLI 固定项。Web 控制台和 HTTP API 客户端各自管理令牌，不会共享此文件。

      说明

      在运行任意 octop 命令前设置 OCTOP_HOME 环境变量，可覆盖 ~/.octop/ 的位置。