DOCUMENTATION
Use the CLI that ships.
Initialize → check status → read NEXT → publish a reviewed replacement.
v1.0.0-rc.1 is a prerelease, not stable and not Latest. Git-only needs no Muse installation or account.
Current documents
- Repository README — product scope, setup and daily use
- Documentation index — current guides and evidence
- Installation and rollback — verify the five release assets and install source
- Git-only quickstart — complete repository setup
- Controlled Muse bridge workflow — optional source and mirror publication
- rc.1 prerelease — immutable tag and assets
The real flow
After following the installation guide, work from the fixed kit source directory. Set PROJECT_ROOT to the absolute path of an existing Git checkout you are authorized to initialize. These commands use the kit’s conventional .venv.
./cli/ok -C "$PROJECT_ROOT" init --vcs git \
--repo-name PROJECT-NAME --lane product --model 'GPT-6 Astra'
"$PROJECT_ROOT/.overseer/bin/ok" status --json
"$PROJECT_ROOT/.overseer/bin/ok" nextRead the actual UUID, branch, revision and next_sha256 from status. Write reviewed task text into a regular UTF-8 file inside that repository, then replace the example values below:
./cli/ok -C "$PROJECT_ROOT" next-write \
--repo-id UUID-FROM-STATUS --branch BRANCH-FROM-STATUS \
--lane product --model 'GPT-6 Astra' \
--action-id REVIEWED-ACTION --action-kind plan \
--base-head REVISION-FROM-STATUS --expect-next NEXT-SHA256-FROM-STATUS \
--prompt-file .overseer/local/task.txtRead NEXT again after publication. It validates and prints the task; it does not execute it. Use action kind stop when no executable task remains. Hooks stay off by default.
The seven public commands
| Command | Purpose |
|---|---|
status | Read repository identity, runtime, revision and NEXT status. |
init | Initialize one checkout with its identity and local handoff files. |
sync | Refresh the bound launcher and runtime pin after an explicit update. |
adopt | Explicitly change repository authority or restore a preserved configuration. |
mirror | Prepare and verify a controlled Muse projection; explicitly deliver its GitHub mirror and pull request. |
next | Validate and print the trusted handoff without running it. |
next-write | Publish a reviewed handoff with explicit context and the previous NEXT digest. |
Current guidance and historical records
Older specifications, desktop material, runbooks, templates and editor skills are retained as pre-reset historical records. Their legacy commands are not exposed by the bounded-v1 entrypoint.
Use the historical-material index for context, and the current guides above for onboarding.
PR #87 documentation publication and recovery closeout are complete. GitHub main includes that later documentation; the rc.1 tag and five assets remain unchanged. Read the completed closeout.