morluto/rea

Fork 0

mirror of https://github.com/morluto/rea.git synced 2026-11-05 06:45:22 +00:00

[PR #842] [MERGED] docs: show task-scoped readiness and provider preference in the quick start #2280

New issue

Closed

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

bsakaguchi commented

2026-10-16 21:16:41 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/842
Author: @kaoru0822-kitauji
Created: 10/7/2026
Status: ✅ Merged
Merged: 10/7/2026
Merged by: @kaoru0822-kitauji

Base: main ← Head: docs/task-scoped-readiness

📝 Commits (2)

5fd0db3 docs: show task-scoped readiness and provider preference in the quick start
c3f2b8e docs: separate ambiguous and unavailable provider recovery

📊 Changes

2 files changed (+37 additions, -1 deletions)

View changed files

📝 README.md (+34 -0)
📝 docs/installation.md (+3 -1)

📄 Description

Summary

Fixes #726. Adds a short Check readiness for the task at hand subsection to the README quick start, right after "First result from the terminal", and links to it from docs/installation.md.

It covers the five points requested in the issue:

Full audit vs. task readiness. Bare rea doctor audits every registration, the skill, and all engines, so it can be unhealthy while the current task works.
Provider-scoped doctor. rea doctor --provider ghidra|hopper|ida --json, plus --client and --skill scopes.
Engine-free JS task. Static JavaScript/Electron analysis needs no readiness check.
Choosing a provider once. --provider, provider_id on open_binary, or REA_ANALYSIS_PROVIDER as a standing preference. An explicit selector wins, and the session never falls back to another engine.
Reading diagnostics. Explains scope_checks vs. informational_checks, healthy vs. environment_healthy, and the typed ambiguity error. None of it implies installing every backend.

The section links to the existing "Choosing a deep-analysis provider" policy instead of restating it.

Accuracy checks (against current `main`)

scope.mode is audit-wide without scope options and explicit with --provider/--client/--skill (normalizeDoctorScope). In explicit mode, healthy comes only from scope checks. environment_healthy keeps the full audit (Doctor.ts).
As #726 asked, --target alone does not narrow the scope. I verified that rea doctor --target <path> --json reports scope.mode: "audit-wide", which is what the docs say.
I checked the ambiguity error shape in analysisErrorProjection.ts: code: "capability_unavailable", details.selection_reason: "ambiguous", and details.candidate_ids. The user message names provider_id, --provider, and REA_ANALYSIS_PROVIDER.
ida is a valid doctor --provider value. rea providers --json lists ghidra, hopper, and ida, and an unknown value is rejected as a validation error.
I ran rea doctor --json, --provider ghidra, --provider ida, --skill, and --target … locally. The scope fields and exit statuses match the text.
npm run docs:check passed.

Docs only; no code or contract changes. No Hopper/Ghidra verification needed.

🤖 Generated with Claude Code

_{🔄 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/842 **Author:** [@kaoru0822-kitauji](https://github.com/kaoru0822-kitauji) **Created:** 10/7/2026 **Status:** ✅ Merged **Merged:** 10/7/2026 **Merged by:** [@kaoru0822-kitauji](https://github.com/kaoru0822-kitauji) **Base:** `main` ← **Head:** `docs/task-scoped-readiness` --- ### 📝 Commits (2) - [`5fd0db3`](https://github.com/morluto/rea/commit/5fd0db37d94f1c1a0495920c79e121d799da0d30) docs: show task-scoped readiness and provider preference in the quick start - [`c3f2b8e`](https://github.com/morluto/rea/commit/c3f2b8e7742915dc27ab7c801a8a1a9127169896) docs: separate ambiguous and unavailable provider recovery ### 📊 Changes **2 files changed** (+37 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+34 -0) 📝 `docs/installation.md` (+3 -1) </details> ### 📄 Description ## Summary Fixes #726. Adds a short **Check readiness for the task at hand** subsection to the README quick start, right after "First result from the terminal", and links to it from `docs/installation.md`. It covers the five points requested in the issue: 1. **Full audit vs. task readiness.** Bare `rea doctor` audits every registration, the skill, and all engines, so it can be unhealthy while the current task works. 2. **Provider-scoped doctor.** `rea doctor --provider ghidra|hopper|ida --json`, plus `--client` and `--skill` scopes. 3. **Engine-free JS task.** Static JavaScript/Electron analysis needs no readiness check. 4. **Choosing a provider once.** `--provider`, `provider_id` on `open_binary`, or `REA_ANALYSIS_PROVIDER` as a standing preference. An explicit selector wins, and the session never falls back to another engine. 5. **Reading diagnostics.** Explains `scope_checks` vs. `informational_checks`, `healthy` vs. `environment_healthy`, and the typed ambiguity error. None of it implies installing every backend. The section links to the existing "Choosing a deep-analysis provider" policy instead of restating it. ## Accuracy checks (against current `main`) - `scope.mode` is `audit-wide` without scope options and `explicit` with `--provider`/`--client`/`--skill` (`normalizeDoctorScope`). In explicit mode, `healthy` comes only from scope checks. `environment_healthy` keeps the full audit (`Doctor.ts`). - As #726 asked, `--target` alone does **not** narrow the scope. I verified that `rea doctor --target <path> --json` reports `scope.mode: "audit-wide"`, which is what the docs say. - I checked the ambiguity error shape in `analysisErrorProjection.ts`: `code: "capability_unavailable"`, `details.selection_reason: "ambiguous"`, and `details.candidate_ids`. The user message names `provider_id`, `--provider`, and `REA_ANALYSIS_PROVIDER`. - `ida` is a valid `doctor --provider` value. `rea providers --json` lists `ghidra`, `hopper`, and `ida`, and an unknown value is rejected as a validation error. - I ran `rea doctor --json`, `--provider ghidra`, `--provider ida`, `--skill`, and `--target …` locally. The scope fields and exit statuses match the text. - `npm run docs:check` passed. Docs only; no code or contract changes. No Hopper/Ghidra verification needed. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-16 21:16:41 +00:00

closed this issue
added the
pull-request
label

bsakaguchi referenced this issue

2026-10-31 01:04:16 +00:00

[PR #2280] [CLOSED] fix(cli): report analysis failures as not-ok in full-output envelopes #5136

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

morluto/rea#2280

No description provided.

Rows
Columns