Skip to content

CLI 参考

prx 是 OpenPRX 的唯一入口二进制,所有功能均通过子命令暴露。

全局选项

参数缩写默认值说明
--config-dir <PATH>~/.openprx指定配置目录,覆盖默认路径
--version-V显示版本号并退出
--help-h显示帮助信息

--config-dir 为全局选项,可放在任何子命令之前:

bash
prx --config-dir /etc/openprx daemon

命令总览

交互与对话

命令说明文档
prx agent启动 Agent 循环,支持交互式会话和单轮查询详情
prx chat富终端对话,流式输出 + 会话历史管理详情

运行时

命令说明文档
prx daemon启动完整守护进程:网关 + 渠道 + 心跳 + 调度详情
prx gateway启动独立 HTTP/WebSocket 网关详情
prx service管理 OS 系统服务(systemd/launchd/OpenRC)详情
prx status显示系统状态(版本、提供商、渠道、安全配置等)见下文

渠道与调度

命令说明文档
prx channel管理消息渠道(添加/删除/列出/诊断/启动)详情
prx cron管理定时任务(cron/一次性/固定间隔)详情

自进化

命令说明文档
prx evolution自进化仪表盘和操作(状态/历史/配置/触发)详情

认证与配置

命令说明文档
prx auth管理 OAuth/Token 认证配置详情
prx config配置操作(Schema 导出/拆分/合并)详情
prx onboard安装引导向导(快速设置/交互式向导/渠道修复)详情

诊断与技能

命令说明文档
prx doctor运行诊断检查(系统环境/模型可用性)详情
prx skills管理用户自定义技能(安装/列出/删除)详情

其他

命令说明
prx providers列出所有支持的 LLM 提供商
prx models refresh刷新并缓存提供商模型目录
prx integrations info <NAME>查看集成详情
prx migrate openclaw从 OpenClaw 迁移数据
prx completions <SHELL>生成 Shell 补全脚本(bash/zsh/fish/powershell/elvish)

prx status

显示当前 OpenPRX 实例的完整状态,包括版本、工作区路径、提供商、模型、可观测性后端、自治级别、运行时、心跳、记忆后端和渠道配置情况。

bash
prx status

输出示例:

OpenPRX Status

Version:     0.2.1
Workspace:   /home/user/.openprx/workspace
Config:      /home/user/.openprx/config.toml

Provider:      openrouter
   Model:         (default)
Observability:  otlp
Autonomy:      Supervised
Runtime:       tokio

Heartbeat:      every 60min
Memory:         sqlite (auto-save: on)

Security:
  Workspace only:    true
  Allowed commands:  git, ls, cat, grep
  Max actions/hour:  100
  Max cost/day:      $5.00

Channels:
  CLI:      always
  Telegram  configured
  Discord   not configured
  Slack     not configured

prx completions

生成 Shell 自动补全脚本,支持 Bash、Zsh、Fish、PowerShell 和 Elvish。

bash
# Bash — 即时加载
source <(prx completions bash)

# Bash — 持久化
prx completions bash > ~/.local/share/bash-completion/completions/prx

# Zsh
prx completions zsh > ~/.zfunc/_prx

# Fish
prx completions fish > ~/.config/fish/completions/prx.fish

# PowerShell
prx completions powershell >> $PROFILE

环境变量

变量说明
OPENPRX_CONFIG_DIR等效于 --config-dir,指定配置目录
OPENPRX_EVOLUTION_CONFIG覆盖自进化配置文件路径
OPENPRX_AUTOSTART_CHANNELS设为 1 时,onboard 完成后自动启动渠道
RUST_LOG控制日志级别,默认 info,支持 debug/trace/模块级过滤

相关链接

Released under the Apache-2.0 License.