QUICK START · 分步指南

先预览,再安装。
十分钟走完。

本页所有命令只用于复制,页面不会执行任何东西。安装器默认先预览差异;初始化只写本机能力快照与角色覆盖,不装软件、不读密钥。安装成功 ≠ 宿主已发现 ≠ 行为已测——按第 4 步核验。

macOS / UbuntuPython 3.9+4 个宿主~10 min
01 / 准备PREREQUISITES

开工前,四样东西。

安装器直接 import fcntl,不以 Windows 原生 Python 为支持面(WSL 可用)。仓库当前为私有,clone 需要访问权限。

REQ / 01

macOS 或 Ubuntu

CI 覆盖这两个平台;其他 Linux 发行版未逐一验证。Windows 请走 WSL。

REQ / 02

Python 3.9+

渲染与安装脚本都需要 python3;低于 3.9 时部分测试会跳过。

REQ / 03

Git 与仓库访问

git clone 需要 GitHub 上对该私有仓库的读权限。

REQ / 04

一个受支持宿主

Codex、Claude Code、Cursor 或 Grok(走 Claude compatibility)任选其一,可重复安装到多个。

02 / 安装INSTALL

复制五段命令。预览在前,安装在后。

选择你的宿主,命令随之切换。--preview 只打印将要写入的路径、diff 与冲突,不改任何文件;确认后再跑无参安装。

01

克隆并校验渲染

LOCAL / TERMINAL
$git clone https://github.com/Octo-o-o-o/OctoWorkFlow.git
$cd OctoWorkFlow
$python3 scripts/render.py --check

--check 校验宿主入口是否与共同正文同步;过期会列出,不写入。

02

预览安装差异

DRY RUN / PREVIEW
$./scripts/install.sh codex --preview

核对目标路径、写入内容与和你已有文件的冲突。默认仅复制按需 Skills 及依赖,保留已有 MD。

03

实际安装

INSTALL
$./scripts/install.sh codex

首次修改已有文件前会完整备份并读回校验。常用选项:--skill <name> 只装某个能力,--project <dir> 装到项目范围,--rules block 附带常驻规则区块。复制受管文件,不做 symlink。

多宿主:对每个宿主重复第 2、3 步(或 ./scripts/install.sh all)。升级时 git pull 后重跑 render.py --check 与安装即可;--rules 模式沿用收据。

03 / 初始化SETUP

一次性的能力快照。不是第二条安装命令。

install.sh 复制文件;setup.py 做的是另一件事——探测本机 CLI、询问订阅与常用宿主,写角色覆盖与能力快照。编排入口靠它解析角色;只用普通 skill 可以跳过,建议先 --dry-run 看一遍。

01

先干跑一遍

DRY RUN
$python3 scripts/setup.py --dry-run

只探测与打印:各 CLI 路径与版本、node、API key 是否在场(只看存在性,不读值)、已有覆盖与 policy。不写任何文件。

02

回答一次问题

INTERACTIVE
$python3 scripts/setup.py
# 非交互:--answers answers.json 或 --non-interactive

12 个短问题:各平台订阅、常用宿主(supervisor)、Oracle 研究传输、本人亲验门禁、任务目录。准入条件不满足就写显式 gaps,不回填默认角色。

写入(仅在 OCTOWORKFLOW_HOME 或 ~/.octoworkflow)
  • roles.override.json — 角色覆盖与显式 gaps,供编排任务解析角色
  • local/capabilities.json — 能力快照;之后 setup.py --check 对照报告 CLI 消失或版本变化

不做的事:不安装软件、不改 policy.json、不改第三方配置、不读任何密钥值。

04 / 验证VERIFY

三层核验,不是看输出像成功。

安装成功 ≠ 宿主已发现 ≠ 真实任务行为已测。三层分别核对:

层级命令 / 位置看什么
收据./scripts/install.sh codex --doctor对照收据报告文件归属与状态;不一致会列出
能力python3 scripts/setup.py --checkCLI 消失或版本变化时报告 capability_stale
宿主发现宿主的 Skills / 命令菜单Claude:/command 与 @import;Codex:$skill 或 Skills 菜单(别假定 @import 会展开);Cursor:规则 + skills;Grok:Claude compatibility

真实行为只能靠一次真实任务确认。宿主加载实测边界见仓库接入指南。

05 / 首次使用FIRST USE

七个入口。不是七道工序。

普通任务直接做;只有明确选择前四个入口才增加角色。后三个按产物意图使用,不额外加角色。

/supervised-delivery明确选择

监督交付:当前宿主主持实施、独立评审与有界返工

/impl-review明确选择

独立只读验收,不施工

/deep-audit明确选择

发现与独立证伪,不自动修复

/pro-research明确选择

向网页 Pro 征询,并在授权研究产物内有界修订

/impl-prompt产物意图

只输出自足新会话 prompt,不执行

/consolidate-reviews产物意图

只在指定材料与范围内核验融合,不隐含外派

/borrow-assess产物意图

按指定范围评估;明确要全量才全量

06 / 维护MAINTAIN

可逆,按归属卸载。

操作命令说明
卸载./scripts/install.sh codex --uninstall按收据归属卸载,保留你的修改;--rules-only 只停用常驻规则
回滚./scripts/install.sh --rollback撤销上次事务;备份在 ~/.octoworkflow/.bak/<事务>/
升级git pull && ./scripts/install.sh codex先跑 render.py --check;不带 --rules 时沿用收据里的模式
07 / 帮助HELP

卡住时,先看这些。

SELF CHECK
$python3 -B scripts/render.py --check
$env PYTHONDONTWRITEBYTECODE=1 bash scripts/check.sh