From bd8907d6f53465c5e3679af20005fd0267fa436a Mon Sep 17 00:00:00 2001 From: garrytan Date: Wed, 28 Oct 2026 01:55:41 +0000 Subject: [PATCH] docs: harness registration in README, install and hosts (document-release audit) Co-authored-by: capy-ai[bot] <230910855+capy-ai[bot]@users.noreply.github.com> --- README.md | 12 +++++++----- docs/hosts.md | 3 ++- docs/install.md | 8 ++++---- 3 files changed, 13 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index e1a74eae0..209faa2c5 100644 --- a/README.md +++ b/README.md @@ -47,8 +47,10 @@ Team mode's `required` hook runs on Node.js, so every teammate needs Node.js on ### Other AI Agents gstack runs on more agents than Claude. Bare `./setup` installs for Claude -Code only. Pick another agent with `--host `, or install for every agent -setup detects on this machine with `--host auto`: +Code only (run inside OpenClaw, Hermes or a Dot, it also registers gstack's +skills with that harness: [docs/hosts.md](docs/hosts.md#agent-harnesses)). +Pick another agent with `--host `, or install for every agent setup +detects on this machine with `--host auto`: ```bash git clone --single-branch --depth 1 https://github.com/garrytan/gstack.git ~/gstack @@ -80,7 +82,7 @@ installs and passes the conformance tests but has no certification run yet; | Hermes | experimental | `--host hermes` (every skill in `$HERMES_HOME/skills/gstack`; automatic when setup runs inside Hermes) | ask for the task, or `/gstack-review` | advisory, not blocked | — | `./setup --host hermes` | | GBrain (mod) | instruction-only | `--host gbrain` (brain-aware variants ship from the GBrain repo) | — | advisory, not blocked | — | — | -Per-host notes (Copilot, Antigravity, OpenClaw and ClawHub, the Codex behavioral profile and model tiers, outside-review providers, the design binary's models) are in [docs/hosts.md](docs/hosts.md). Any rules-reading agent (Zed, Amp, Jules) can use the 2KB [agents digest](agents-digest/gstack-AGENTS.md) with no install. Adding a host: [docs/ADDING_A_HOST.md](docs/ADDING_A_HOST.md). +Per-host notes (agent harnesses, Copilot, Antigravity, OpenClaw and ClawHub, the Codex behavioral profile and model tiers, outside-review providers, the design binary's models) are in [docs/hosts.md](docs/hosts.md). Any rules-reading agent (Zed, Amp, Jules) can use the 2KB [agents digest](agents-digest/gstack-AGENTS.md) with no install. Adding a host: [docs/ADDING_A_HOST.md](docs/ADDING_A_HOST.md). ## See it work @@ -240,8 +242,8 @@ On Windows without Developer Mode (MSYS2 / Git Bash), `setup` falls back to file | [Skill Deep Dives](docs/skills.md) | Philosophy, examples, and workflow for every skill (includes Greptile integration) | | [The recommended harness](docs/recommended-harness.md) | gstack + Capy from zero to the first merged train: install, the Captain and its Drive, trains, the daily flaky pass, the weekly release, the factory scorecard, what is Capy-specific, known Capy limits | | [Why gstack](docs/why-gstack.md) | The story, the productivity numbers and their caveats, Karpathy's failure modes, parallel sprints | -| [Install details](docs/install.md) | Setup timing, requirements in detail, team mode, the hooks setup registers | -| [Other agents](docs/hosts.md) | OpenClaw and ClawHub, per-host notes, the Codex profile and model tiers, outside-review providers, the design binary's models | +| [Install details](docs/install.md) | Setup timing, requirements in detail, team mode, the hooks setup registers, agent harness registration | +| [Other agents](docs/hosts.md) | Agent harnesses (OpenClaw, Hermes, dots, QM, Muse Code, Grok, any other), OpenClaw and ClawHub, per-host notes, the Codex profile and model tiers, outside-review providers, the design binary's models | | [QA without a webpage](docs/qa-without-a-webpage.md) | `/qa` and `/qa-only` on CLIs, APIs, jobs, workers and webhooks | | [Standalone binaries](docs/standalone-binaries.md) | The standalone `gstack-*` CLIs (egress auditor, context bill, model benchmark, the review and evidence ledgers, the iOS QA daemon), and the CSO evaluation producer contract | | [Privacy & Telemetry](docs/privacy.md) | What is sent, what never is, the update check, outside reviews, egress receipts | diff --git a/docs/hosts.md b/docs/hosts.md index 7639b9a75..4ed9148a6 100644 --- a/docs/hosts.md +++ b/docs/hosts.md @@ -18,7 +18,8 @@ registers with the harness it runs inside: OpenClaw (its exec tool sets `OPENCLAW_SHELL=exec`), Hermes (`HERMES_AGENT=true`) or a Dot (`HOME=/home/dot` on a Dot's computer), or a harness found among setup's parent processes. It prints every path it wrote and the command that removes them. An explicit -`--host claude` (or any other host) never writes under a harness folder. +`--host claude` (or any other host) never writes under a harness folder, and +neither does `./setup --local`. `./setup --no-harness-auto` or `GSTACK_HARNESS_AUTO=0` turns the automatic step off. **What it writes.** Copies in the harness's own skills folder, never edits to diff --git a/docs/install.md b/docs/install.md index d43258a29..f666f7223 100644 --- a/docs/install.md +++ b/docs/install.md @@ -2,7 +2,7 @@ The README covers the two-step install. This page holds the details: what setup needs and how long it takes, the team-mode hook, the hooks setup -registers in Claude Code, and how to remove gstack. +registers in Claude Code, agent harness registration, and how to remove gstack. ## How long setup takes @@ -51,9 +51,9 @@ writing a backup beside the file) only when it changed something. Run inside OpenClaw, Hermes or a Dot, `./setup` also registers gstack's skills with that harness, in the harness's own skills folder, and prints every path -it wrote. It never does this when `--host` names another host. Turn it off -with `./setup --no-harness-auto` or `GSTACK_HARNESS_AUTO=0`. Per-harness -details, QM and any other harness: [hosts.md](hosts.md#agent-harnesses). +it wrote. It never does this when `--host` names another host or with +`--local`. Turn it off with `./setup --no-harness-auto` or +`GSTACK_HARNESS_AUTO=0`. Per-harness details, QM and any other harness: [hosts.md](hosts.md#agent-harnesses). ## Uninstall