aaronrene / overseer-kit public
docs.html html
31 lines 5.7 KB
Raw
sha256:cb0d285531d52a0703d33e76389edd88459e272649b519516caf3aef09339b11 docs: restore original site design with bounded-v1 copy Human 7 days ago
1 <!DOCTYPE html><html lang="en" data-theme="dark"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1"><meta name="description" content="Install and use the seven public Overseer Kit commands."><title>Docs — Overseer Kit</title><link rel="icon" href="assets/favicon.ico" sizes="any"><link rel="stylesheet" href="assets/style.css"><script src="assets/theme.js" defer></script></head><body>
2
3 <a class="skip-link" href="#main">Skip to content</a>
4 <header class="site-header">
5 <nav aria-label="Main navigation">
6 <a class="brand" href="index.html" aria-label="Overseer Kit home">
7 <span class="logo-mark" aria-hidden="true">OK</span><span class="brand-name">Overseer Kit</span>
8 </a>
9 <div class="nav-links">
10 <a href="index.html#how-it-works">How it works</a><a href="index.html#start">Get started</a>
11 <a href="scenarios/index.html">Scenarios</a><a href="docs.html">Docs</a>
12 <button type="button" id="theme-toggle" class="theme-toggle" aria-label="Switch to light mode" title="Light / dark"><span class="theme-icon theme-icon-moon" aria-hidden="true">☾</span><span class="theme-icon theme-icon-sun" aria-hidden="true">☀</span></button>
13 </div>
14 </nav>
15 </header><main id="main"><section class="page-hero"><p class="section-kicker">Documentation</p><h1>Use the CLI that ships.</h1><p class="lead">Initialize → check status → read NEXT → publish a reviewed replacement.</p><p><span class="release-badge">v1.0.0-rc.1 prerelease</span> Git-only needs no Muse installation or account.</p></section>
16 <section><h2>Current documents</h2><div class="card-grid suite-grid"><div class="card"><h3>Start here</h3><p><a href="https://github.com/aaronrene/overseer-kit/blob/main/README.md">Repository README</a><br><a href="https://github.com/aaronrene/overseer-kit/blob/main/docs/GIT-ONLY-QUICKSTART.md">Git-only quickstart</a><br><a href="https://github.com/aaronrene/overseer-kit/blob/main/docs/CONSUMER-ADAPTER-PATTERN.md">Consumer adapter pattern</a></p></div><div class="card"><h3>Install safely</h3><p><a href="https://github.com/aaronrene/overseer-kit/releases/download/v1.0.0-rc.1/INSTALL-AND-ROLLBACK.md">Installation and rollback</a><br><a href="https://github.com/aaronrene/overseer-kit/releases/tag/v1.0.0-rc.1">Five immutable release assets</a></p></div><div class="card"><h3>Optional Muse</h3><p><a href="https://github.com/aaronrene/overseer-kit/blob/main/docs/MIGRATE-EXISTING-REPO.md">Adoption and rollback</a><br><a href="https://github.com/aaronrene/overseer-kit/blob/main/MUSE-BRIDGE-WORKFLOW.md">Controlled bridge workflow</a></p></div></div></section>
17 <section><h2>The daily flow</h2><p>After following the installation guide, set <code>PROJECT_ROOT</code> to an existing Git checkout you are authorized to initialize.</p><pre><code>./cli/ok -C &quot;$PROJECT_ROOT&quot; init --vcs git \
18 --repo-name PROJECT-NAME --lane product --model &#x27;GPT-6 Astra&#x27;
19 &quot;$PROJECT_ROOT/.overseer/bin/ok&quot; status --json
20 &quot;$PROJECT_ROOT/.overseer/bin/ok&quot; next</code></pre><p>Use the UUID, branch, revision, and <code>next_sha256</code> reported by status when you publish reviewed task text:</p><pre><code>./cli/ok -C &quot;$PROJECT_ROOT&quot; next-write \
21 --repo-id UUID-FROM-STATUS --branch BRANCH-FROM-STATUS \
22 --lane product --model &#x27;GPT-6 Astra&#x27; \
23 --action-id REVIEWED-ACTION --action-kind plan \
24 --base-head REVISION-FROM-STATUS --expect-next NEXT-SHA256-FROM-STATUS \
25 --prompt-file .overseer/local/task.txt</code></pre><p>NEXT validates and prints the task. It does not execute it. Use action kind <code>stop</code> when no executable task remains.</p></section>
26 <section><h2>The seven public commands</h2><div class="table-wrap"><table class="command-table"><caption>Bounded-v1 command surface</caption><thead><tr><th scope="col">Command</th><th scope="col">Purpose</th></tr></thead><tbody><tr><th scope="row"><code>status</code></th><td>Read repository identity, runtime, revision, and NEXT status.</td></tr><tr><th scope="row"><code>init</code></th><td>Initialize one checkout with its identity and local handoff files.</td></tr><tr><th scope="row"><code>sync</code></th><td>Refresh the bound launcher and runtime pin after an explicit update.</td></tr><tr><th scope="row"><code>adopt</code></th><td>Explicitly change repository authority or restore preserved configuration.</td></tr><tr><th scope="row"><code>mirror</code></th><td>Prepare and verify a Muse projection; explicitly deliver its GitHub mirror and pull request.</td></tr><tr><th scope="row"><code>next</code></th><td>Validate and print the trusted handoff without running it.</td></tr><tr><th scope="row"><code>next-write</code></th><td>Publish a reviewed handoff with exact context and the previous NEXT digest.</td></tr></tbody></table></div></section>
27 <section class="band-problem"><header class="section-intro"><p class="section-kicker">Product boundary</p><h2>A focused local tool</h2></header><p>Overseer has no hosted service, desktop runtime, automatic task execution, automatic merge, telemetry, or updater. Hooks are optional and off by default. Older specifications and desktop material remain historical records; current guides describe the bounded v1.</p></section></main>
28 <footer class="site-footer"><div class="footer-inner">
29 <div><p><strong>Honesty for Agents.</strong></p><p>This website is informational. It does not run Overseer.</p><p>v1.0.0-rc.1 is a prerelease, not stable and not Latest.</p></div>
30 <div class="footer-links"><a href="https://github.com/aaronrene/overseer-kit">GitHub</a><a href="https://github.com/aaronrene/overseer-kit/blob/main/LICENSE">MIT license</a><a href="https://github.com/aaronrene/overseer-kit/blob/main/SECURITY.md">Security</a></div>
31 </div></footer></body></html>
File History 1 commit
sha256:cb0d285531d52a0703d33e76389edd88459e272649b519516caf3aef09339b11 docs: restore original site design with bounded-v1 copy Human 7 days ago