CLI Reference

命令行参考

Better Codex 的 CLI 输出以结构化 JSON 为主，适合诊断和本地自动化。

版本与健康状态

命令	作用
better-codex version	查看 Core 与兼容层版本
better-codex version --json	以 JSON 查看版本、配置档和数据目录
better-codex status	查看 Runtime、页面集成和注入器状态
better-codex doctor	检查 Core、服务、Runtime、数据库、Codex、兼容层、页面集成、Skill、MCP 和更新密钥

启动与页面集成

命令	作用
better-codex setup	交互式配置运行时、MCP、Skill、页面集成和启动入口
better-codex setup --yes	跳过交互确认并执行配置
better-codex launch	打开当前配置档对应的 Codex 并启用 Better Codex
better-codex launch --restart	重启 Codex 后重新接入
better-codex enable	启用页面集成
better-codex disable	停用页面集成
better-codex eject	移除当前页面中的 Better Codex 集成并保留本地数据
better-codex start	启动 Runtime；Codex 已可连接时同时恢复集成
better-codex start --launch	启动 Runtime，并在需要时启动 Codex
better-codex stop	停止注入器、移除页面集成并关闭 Runtime

启动入口与 MCP

命令	作用
better-codex launcher install	安装系统启动入口
better-codex launcher uninstall	移除系统启动入口
better-codex launcher status	查看启动入口状态
better-codex mcp install	注册或修复 better-codex MCP
better-codex mcp uninstall	移除 MCP 注册
better-codex mcp status	查看 MCP 注册状态

更新

命令	作用
better-codex update check	检查当前通道更新
better-codex update	更新 Core 与兼容层
better-codex update compatibility	只更新兼容层
better-codex update rollback	回滚已激活的托管更新
better-codex update channel stable	后续使用正式通道
better-codex update channel preview	后续使用 Preview 通道
better-codex update --channel preview	本次从 Preview 通道检查并安装更新

后台服务

命令	作用
better-codex service install	安装后台服务
better-codex service uninstall	移除后台服务
better-codex service start	启动后台服务
better-codex service stop	停止后台服务
better-codex service restart	重启后台服务
better-codex service status	查看后台服务状态
better-codex service logs --lines 100	查看最近 100 行服务日志

项目、Agent 与任务

命令	作用
better-codex project list	列出项目
better-codex project create --name NAME --workspace PATH	创建项目
better-codex agent list	列出 Agent
better-codex issue list	列出任务
better-codex issue list --project ID --search TEXT	按项目和关键词筛选任务
better-codex issue get ID	查看任务详情
better-codex issue create --title TITLE	创建任务
better-codex issue update ID	更新任务字段
better-codex issue status ID STATUS	修改任务状态
better-codex issue open ID	在 Codex 中打开任务关联的会话

issue create 支持 --project、--description、--status、--priority 和 --workspace。issue update 支持 --title、--description、--priority、--status、--pending-actor、--needs-attention 和 --agent-id。

删除

• better-codex uninstall 会移除安装组件并删除 Better Codex 本地数据。
• better-codex data delete 只执行本地数据删除，并要求终端确认。
• better-codex data delete --yes 跳过交互确认。

删除前请阅读本地数据与隐私。