Skip to content

Refresh the README to match the shipped harness behavior - #47

Merged
gurnben merged 1 commit into
mainfrom
docs/readme-refresh
Oct 30, 2026
Merged

gurnben merged 1 commit into
mainfrom
docs/readme-refresh

Conversation

@gurnben

@gurnben gurnben commented Oct 30, 2026

Copy link
Copy Markdown
Member

Summary

Aligns the README with what actually shipped in the recent harness work:

  • goose: no longer "experimental" — documents the verified headless invocation (goose run -i - --no-session, prompt on stdin) and the config-authoritative OPENAI_API_KEY/OPENAI_HOST bridging (goose reads the key from the environment only; an ambient key from another tool would shadow it).
  • opencode: stream and usage marked supported — its current wire format delivers text, tool calls and step_finish usage.
  • crush: notes that dropped event streams reconnect without killing the run.
  • run: documents the verbatim flag passthrough with the --fp-rules example — skill flags after the skill name reach the skill exactly as typed.
  • Why list: gains corpus auto-registration (runs register unregistered findings trees themselves; the harness only closes that loop interactively via /corpus-intake).
  • init: notes that skipped toolchain profiles are re-checked with a warning when stale.

Verification

Docs-only change; full CI still runs.

💘 Generated with Crush

The README still described goose as an experimental template guess and
opencode's stream as partial — both were verified live and fixed. goose
now documents the real headless invocation (goose run -i - with the
prompt on stdin, --no-session) and its config-authoritative
OPENAI_API_KEY/OPENAI_HOST bridging; opencode's stream and usage are
marked supported (its current wire format delivers text, tool calls
and step_finish usage); crush notes that dropped event streams
reconnect without killing the run.

The run command now documents the verbatim flag passthrough with the
--fp-rules example (skill flags after the skill name reach the skill
exactly as typed), the Why list gains corpus auto-registration (runs
register unregistered findings trees themselves — the harness only
closes that loop interactively), and init notes that skipped
toolchain profiles are re-checked with a warning when stale.

💘 Generated with Crush

Assisted-by: Crush:rits/zai-org/glm-5-3
@gurnben
gurnben merged commit 5e2edd3 into main Oct 30, 2026
6 checks passed
@gurnben
gurnben deleted the docs/readme-refresh branch October 30, 2026 14:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant