Skip to content

CLI 命令 ​

不带子命令运行 xopc 会打开终端界面。设置、脚本、维护和诊断使用子命令。

基础用法 ​

bash
xopc --help
xopc <command> --help
xopc --version

--config <path>、--workspace <path> 等全局参数只为当前调用选择不同配置或工作区。需要可重复的隔离环境时,优先使用 Profile。

命令概览 ​

命令用途
init初始化状态、配置和 Agent 工作区
setup创建基础配置和工作区
profile管理独立 xopc 状态 Profile
backup创建、校验和恢复离线加密状态备份
onboard运行首次设置向导
channels配置消息通道和配对
auth管理认证凭据
agent发送单条消息或开始交互聊天
tui打开全屏终端界面
resume恢复之前的 TUI Session
tunnel管理公网隧道访问
gateway运行和管理 Gateway
history为 ctx 等外部工具导出 Session 历史
session列出和管理 Session
project管理长期 Project
doctor诊断安装、数据和安全问题
runtime管理 Node.js 与 Python 工具运行环境
platform连接 XOPC Cloud 或企业平台
update检查和安装更新
logs查询和跟踪日志
config读取、修改和验证配置
image检查图像服务商可用性
models列出模型并选择默认值
providers管理服务商凭据
voice配置文字转语音
search配置网页搜索服务商
skills安装、配置、审计和测试 Skill
connectors浏览和安装连接器能力
tailscale查看 Tailscale 访问状态
browser诊断浏览器控制并安装 Chrome 扩展桥接
agents创建、列出和移除 Agent
extensions安装和管理扩展

具体参数和示例以当前安装版本的 xopc <command> --help 为准。

常用任务 ​

bash
# 首次设置
xopc onboard --quick

# 开始或发送聊天
xopc
xopc agent -m "总结这个文件夹"

# 模型状态
xopc providers list
xopc models status

# Gateway
xopc gateway
xopc gateway health

# 平台连接
xopc platform status
xopc platform connect https://xopc.example.com

# 配置与诊断
xopc config validate
xopc doctor
xopc logs tail

# 停止 Gateway 后创建离线备份
xopc backup create --output /secure/xopc-backup --passphrase-file /secure/passphrase

如需在 ctx 中搜索 XOPC Session,请参阅导出历史到 ctx。

平台连接、Discovery 与 runtime 注册见 XOPC Platform。

备份前准备、校验与恢复见备份与恢复 xopc。

Profile 与路径 ​

Profile 为不同场景隔离状态、Agent、凭据和 Session。使用 xopc profile --help 查看创建和选择方式。命令看起来使用了不同数据时,先确认:

bash
xopc profile list
xopc config path

脚本输出 ​

脚本中优先使用支持 --json 的命令,检查退出状态,不要解析面向用户的表格,也不要输出未隐藏凭据。通过具体命令的 --help 确认是否支持 JSON。

安全 ​

  • 删除、清理、Token 轮换和更新操作前阅读确认提示。
  • 共享系统上避免把敏感信息直接放在命令行参数中。
  • 执行外部副作用前确认当前 Profile、Agent、工作区和 Gateway。
  • 以已安装版本的 --help 为准;在线文档可能对应更新版本。

基于 MIT 许可证发布