Open ContextOCTX
v0.1EN
API/命令行接口

命令行与错误

命令行接口

使用 octx create、inspect、validate 和 unpack 命令。

安装 octx 后会得到同名命令。CLI 与 Python API 使用同一套创建、读取、校验和安全边界。

命令一览

命令作用对应 Python API
octx create创建 Package 或发布新 Release。create_octx()
octx inspect只读取 manifest 摘要，不做完整校验。open_octx()
octx validate完整校验并输出结果。validate_octx()
octx unpack校验后安全展开。unpack_octx()

创建

bash
octx create ./.octx-workspace \
  --from ./knowledge \
  --name "Product Guide" \
  --output ./product-guide.octx

常用选项：

  • --version 1.1.0：发布后续 Release。
  • --derive：从展开的外部 Package 创建派生 Asset。
  • --capability NAME=VERSION：可重复传入 Capability 声明。
  • --from SOURCE：把源目录中的 Markdown 复制到 workspace；源目录不会被修改。

检查与校验

bash
octx inspect ./product-guide.octx
octx validate ./product-guide.octx

inspect 只显示名称、Asset ID、Release、文件数和文档数，并明确标记没有执行 validation。不能用它替代 validate。

安全展开

bash
octx unpack ./product-guide.octx ./product-guide-expanded

目标目录必须不存在或为空。命令只展开 manifest 和已声明 payload。

JSON 输出

所有子命令都支持 --json：

bash
octx validate ./product-guide.octx --json

JSON 模式适合 CI、Agent 和服务端调用。用法错误、OCTX 异常和校验报告都会输出稳定结构，不需要解析自然语言日志。

退出码

退出码含义
0命令成功；validate 表示 Package 有效。
1validate 或发布前校验发现无效 Package。
2命令用法、输入输出或其他操作错误。