[PR #655] [MERGED] docs: correct CLI examples and documentation checks #2141

New issue

Closed

opened 2026-10-16 21:14:49 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-16 21:14:49 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/655
Author: @N0zoM1z0
Created: 10/6/2026
Status: ✅ Merged
Merged: 10/6/2026
Merged by: @N0zoM1z0

Base: main ← Head: docs/fix-cli-examples-and-doc-checks

📝 Commits (1)

83f6309 docs: correct CLI examples and documentation checks

📊 Changes

3 files changed (+9 additions, -8 deletions)

View changed files

📝 AGENTS.md (+1 -1)
📝 README.md (+6 -4)
📝 docs/testing.md (+2 -3)

📄 Description

Changes

Fixes #648. Fixes #649. Fixes #650.

Use the registered inspect-artifact command in the README's pipefail example and name its output inspection.json.
Document setup dry runs (planned) and cancelled setup results (cancelled) as exit 0; keep needs_confirmation and needs_human at exit 1.
Align README, AGENTS.md and the testing guide with the existing generated-document checks and regeneration commands after the TypeDoc pipeline removal.

Verification

Actual current built CLI, exposed as rea through a temporary PATH entry, with a generated public ASAR and an isolated HOME:

Invocation	Result
Original README `inventory-artifact` pipeline	Exit 1, `COMMAND_NOT_FOUND`
Corrected README example copied unchanged	Exit 0, valid `inspect_artifact` Evidence
Same corrected pipeline on a missing ASAR	Exit 1, `target_unavailable`
Missing-ASAR pipeline without `pipefail`	Exit 0: `jq` masks REA's failure
`rea setup --client codex --skill=false --dry-run --json`	Exit 0, `planned`
Same setup without `--dry-run`, stdin noninteractive	Exit 1, `needs_confirmation`

Confirmed that neither setup invocation wrote client configuration or installed a skill. Temporary fixtures were removed.

npm run build:cached
npm run test:focused -- src/cliLogging.test.ts src/application/Setup.planning.test.ts tests/process-global/cliLogging.test.ts tests/conformance/releaseConfiguration.test.ts
Focused tests: 4 files / 44 tests passed (4.87 seconds).
npm run docs:check: passed (10.1 seconds).
npx oxfmt --check README.md AGENTS.md docs/testing.md
Checked all npm run references in the three edited documents against package.json and verified that the stale API pipeline claims are absent.

This is a documentation-only change. Real Hopper/Ghidra verification was not performed; provider behavior and platform support claims are unchanged.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/morluto/rea/pull/655 **Author:** [@N0zoM1z0](https://github.com/N0zoM1z0) **Created:** 10/6/2026 **Status:** ✅ Merged **Merged:** 10/6/2026 **Merged by:** [@N0zoM1z0](https://github.com/N0zoM1z0) **Base:** `main` ← **Head:** `docs/fix-cli-examples-and-doc-checks` --- ### 📝 Commits (1) - [`83f6309`](https://github.com/morluto/rea/commit/83f630990b805904c275b4cb4ee2fb46cfdf5847) docs: correct CLI examples and documentation checks ### 📊 Changes **3 files changed** (+9 additions, -8 deletions) <details> <summary>View changed files</summary> 📝 `AGENTS.md` (+1 -1) 📝 `README.md` (+6 -4) 📝 `docs/testing.md` (+2 -3) </details> ### 📄 Description ## Changes Fixes #648. Fixes #649. Fixes #650. - Use the registered `inspect-artifact` command in the README's `pipefail` example and name its output `inspection.json`. - Document setup dry runs (`planned`) and cancelled setup results (`cancelled`) as exit 0; keep `needs_confirmation` and `needs_human` at exit 1. - Align README, AGENTS.md and the testing guide with the existing generated-document checks and regeneration commands after the TypeDoc pipeline removal. ## Verification Actual current built CLI, exposed as `rea` through a temporary PATH entry, with a generated public ASAR and an isolated HOME: | Invocation | Result | | --- | --- | | Original README `inventory-artifact` pipeline | Exit 1, `COMMAND_NOT_FOUND` | | Corrected README example copied unchanged | Exit 0, valid `inspect_artifact` Evidence | | Same corrected pipeline on a missing ASAR | Exit 1, `target_unavailable` | | Missing-ASAR pipeline without `pipefail` | Exit 0: `jq` masks REA's failure | | `rea setup --client codex --skill=false --dry-run --json` | Exit 0, `planned` | | Same setup without `--dry-run`, stdin noninteractive | Exit 1, `needs_confirmation` | Confirmed that neither setup invocation wrote client configuration or installed a skill. Temporary fixtures were removed. - `npm run build:cached` - `npm run test:focused -- src/cliLogging.test.ts src/application/Setup.planning.test.ts tests/process-global/cliLogging.test.ts tests/conformance/releaseConfiguration.test.ts` - Focused tests: **4 files / 44 tests passed** (4.87 seconds). - `npm run docs:check`: passed (10.1 seconds). - `npx oxfmt --check README.md AGENTS.md docs/testing.md` - Checked all `npm run` references in the three edited documents against `package.json` and verified that the stale API pipeline claims are absent. This is a documentation-only change. Real Hopper/Ghidra verification was not performed; provider behavior and platform support claims are unchanged. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-16 21:14:49 +00:00