[PR #4992] [CLOSED] docs: include Kuna in the doctor provider list #6715

Closed
opened 2026-11-01 21:42:31 +00:00 by bsakaguchi · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/4992
Author: @skyzhao1223
Created: 10/18/2026
Status: ❌ Closed

Base: main ← Head: docs/doctor-provider-kuna


📝 Commits (1)

  • 77c069a docs: include Kuna in the doctor provider list

📊 Changes

1 file changed (+1 additions, -1 deletions)

View changed files

📝 docs/cli.md (+1 -1)

📄 Description

Summary

Fixes #4624.

docs/cli.md named only Hopper, Ghidra, IDA and JADX as engines accepted by
rea doctor --provider and then stated that other adapters are not accepted.
On main the command also accepts kuna (DOCTOR_PROVIDER_IDS), and
docs/kuna-provider.md already documents rea doctor --provider kuna. A reader
of the CLI guide can therefore miss an available Kuna readiness diagnostic.

Problem and expected behavior

Smallest trigger: read the provider-selection paragraph in docs/cli.md and run
rea doctor --provider not-a-provider --json; the validation error lists five
accepted IDs including kuna, while the guide names four and adds "Other
adapters ... are not accepted by doctor --provider". Expected: the guide names
every provider ID the command accepts.

Change and scope

One line in docs/cli.md: add Kuna to the accepted list. The following
sentence about pwntools-elf stays accurate and unchanged. Not included: the
published 6.5.0 wording, which predates Kuna support and is correct for that
release (as the issue notes).

Contract and boundary impact

  • Semantic owner and earliest changed stage: documentation only; no code path changed.
  • Contribution scope fit and linked maintainer decision: standalone correction of misleading user instructions per CONTRIBUTING ("confusing or incorrect user instructions warrant standalone corrections"); ordinary documentation fix, no maintainer scope decision required.
  • CLI and MCP/tool-catalog contract: describes existing behavior only; measured below.
  • Provider, bridge, target-format, or platform compatibility: none.
  • Evidence, artifact, provenance, or reconstruction contract: none.
  • Target selection, authority, upstream behavior, and cleanup details (if applicable): not applicable; no target interaction.
  • Generated metadata (docs/public/product-catalog.json), package, or installation impact: docs/cli.md is authored; docs:check validates the generated catalogs. No generated output is committed.

Expected effects (check known effects; use documentation-only on its own).
Unchecked items do not establish absence; leave uncertainties visible.

  • Read existing files or captured data.
  • Launch or attach to a process.
  • Inject instrumentation or run scripts/code.
  • Change process memory, registers, files, or configuration.
  • Contact network services.
  • Recover protected code or work around protections.
  • Documentation or usability only; no target interaction.
  • Not sure yet; investigation or maintainer guidance needed.

Evidence and regression coverage

  • Tests added or updated: none; this is a documentation-only change. The existing documentation gates (docs:check, including check-doc-facts and the onboarding/readme consistency suite) pass.
  • Base reproduction or other evidence: source (src/application/DoctorProviderIds.ts) and executed CLI output below.
  • User-visible CLI/MCP output (if applicable): shown under "Validation performed".
  • Remaining proof gaps: none identified for this wording; no provider or target behavior is claimed.

For evidence-bearing changes: not applicable to a documentation-only correction; no artifact identity, provenance, or reconstruction claim is made.

Validation performed

  • npm run docs:check — exit 0; turbo tasks 6/6 successful (including check-doc-facts, product catalog, managed evidence, error schema and license checks) and tests/conformance/readmeConsistency.test.ts 5/5 passed.
  • npx oxfmt --check docs/cli.md — "All matched files use the correct format."
  • git diff --check — clean.
  • env -i PATH="$PATH" HOME=<empty> TMPDIR=<empty> node scripts/rea.mjs doctor --provider kuna --json — exit 1, scope.providers: ["kuna"] and kuna-installation: missing_analysis_engine: the provider ID is accepted and the failure is only the absent engine on this host.
  • env -i PATH="$PATH" HOME=<empty> TMPDIR=<empty> node scripts/rea.mjs doctor --provider not-a-provider --json — exit 1, VALIDATION_ERROR whose allowed values are hopper|ghidra|ida|jadx|kuna.

Compatibility, safety, and release

  • Breaking changes or migration steps: none.
  • Real Hopper/Ghidra, browser, or OS coverage: none required; no provider was started.
  • Package or release metadata impact: none.
  • Security, privacy, process, or containment review: none; documentation only.

Author readiness

Human owner: @skyzhao1223

  • I reviewed the final diff and relevant existing code, understand the change and its edge cases, and take responsibility for the complete PR, including AI-assisted work.
  • I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps.
  • I declare this PR ready for initial maintainer review.

Before merge

  • This PR addresses a concrete problem or an agreed enhancement.
  • Material scope and authority questions are resolved, and any required maintainer scope decision covers the final diff.
  • The PR has one focused outcome and the title follows type(scope): outcome.
  • Related issue is linked, or the reason for not linking one is stated above.
  • Tests cover changed observable behavior and meaningful failure paths.
  • Owning docs, contracts, and generated metadata are updated where needed.
  • User-visible CLI/MCP changes include representative output.
  • I checked the final diff for secrets, unrelated cleanup, and unsupported claims.

🔄 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/4992 **Author:** [@skyzhao1223](https://github.com/skyzhao1223) **Created:** 10/18/2026 **Status:** ❌ Closed **Base:** `main` ← **Head:** `docs/doctor-provider-kuna` --- ### 📝 Commits (1) - [`77c069a`](https://github.com/morluto/rea/commit/77c069a05c76d8580e1511fc68db563dac22de7d) docs: include Kuna in the doctor provider list ### 📊 Changes **1 file changed** (+1 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `docs/cli.md` (+1 -1) </details> ### 📄 Description ## Summary Fixes #4624. `docs/cli.md` named only Hopper, Ghidra, IDA and JADX as engines accepted by `rea doctor --provider` and then stated that other adapters are not accepted. On `main` the command also accepts `kuna` (`DOCTOR_PROVIDER_IDS`), and `docs/kuna-provider.md` already documents `rea doctor --provider kuna`. A reader of the CLI guide can therefore miss an available Kuna readiness diagnostic. ## Problem and expected behavior Smallest trigger: read the provider-selection paragraph in `docs/cli.md` and run `rea doctor --provider not-a-provider --json`; the validation error lists five accepted IDs including `kuna`, while the guide names four and adds "Other adapters ... are not accepted by `doctor --provider`". Expected: the guide names every provider ID the command accepts. ## Change and scope One line in `docs/cli.md`: add Kuna to the accepted list. The following sentence about `pwntools-elf` stays accurate and unchanged. Not included: the published 6.5.0 wording, which predates Kuna support and is correct for that release (as the issue notes). ## Contract and boundary impact - Semantic owner and earliest changed stage: documentation only; no code path changed. - Contribution scope fit and linked maintainer decision: standalone correction of misleading user instructions per CONTRIBUTING ("confusing or incorrect user instructions warrant standalone corrections"); ordinary documentation fix, no maintainer scope decision required. - CLI and MCP/tool-catalog contract: describes existing behavior only; measured below. - Provider, bridge, target-format, or platform compatibility: none. - Evidence, artifact, provenance, or reconstruction contract: none. - Target selection, authority, upstream behavior, and cleanup details (if applicable): not applicable; no target interaction. - Generated metadata (`docs/public/product-catalog.json`), package, or installation impact: `docs/cli.md` is authored; `docs:check` validates the generated catalogs. No generated output is committed. Expected effects (check known effects; use documentation-only on its own). Unchecked items do not establish absence; leave uncertainties visible. - [ ] Read existing files or captured data. - [ ] Launch or attach to a process. - [ ] Inject instrumentation or run scripts/code. - [ ] Change process memory, registers, files, or configuration. - [ ] Contact network services. - [ ] Recover protected code or work around protections. - [x] Documentation or usability only; no target interaction. - [ ] Not sure yet; investigation or maintainer guidance needed. ## Evidence and regression coverage - Tests added or updated: none; this is a documentation-only change. The existing documentation gates (`docs:check`, including `check-doc-facts` and the onboarding/readme consistency suite) pass. - Base reproduction or other evidence: source (`src/application/DoctorProviderIds.ts`) and executed CLI output below. - User-visible CLI/MCP output (if applicable): shown under "Validation performed". - Remaining proof gaps: none identified for this wording; no provider or target behavior is claimed. For evidence-bearing changes: not applicable to a documentation-only correction; no artifact identity, provenance, or reconstruction claim is made. ## Validation performed - `npm run docs:check` — exit 0; turbo tasks 6/6 successful (including `check-doc-facts`, product catalog, managed evidence, error schema and license checks) and `tests/conformance/readmeConsistency.test.ts` 5/5 passed. - `npx oxfmt --check docs/cli.md` — "All matched files use the correct format." - `git diff --check` — clean. - `env -i PATH="$PATH" HOME=<empty> TMPDIR=<empty> node scripts/rea.mjs doctor --provider kuna --json` — exit 1, `scope.providers: ["kuna"]` and `kuna-installation: missing_analysis_engine`: the provider ID is accepted and the failure is only the absent engine on this host. - `env -i PATH="$PATH" HOME=<empty> TMPDIR=<empty> node scripts/rea.mjs doctor --provider not-a-provider --json` — exit 1, `VALIDATION_ERROR` whose allowed values are `hopper|ghidra|ida|jadx|kuna`. ## Compatibility, safety, and release - Breaking changes or migration steps: none. - Real Hopper/Ghidra, browser, or OS coverage: none required; no provider was started. - Package or release metadata impact: none. - Security, privacy, process, or containment review: none; documentation only. ## Author readiness <!-- The human owner completes these declarations before requesting review. AI agents must leave these declarations to a human. Draft PRs may leave them unchecked. --> Human owner: @skyzhao1223 - [x] I reviewed the final diff and relevant existing code, understand the change and its edge cases, and take responsibility for the complete PR, including AI-assisted work. - [x] I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps. - [x] I declare this PR ready for initial maintainer review. ## Before merge - [ ] This PR addresses a concrete problem or an agreed enhancement. - [ ] Material scope and authority questions are resolved, and any required maintainer scope decision covers the final diff. - [ ] The PR has one focused outcome and the title follows `type(scope): outcome`. - [ ] Related issue is linked, or the reason for not linking one is stated above. - [ ] Tests cover changed observable behavior and meaningful failure paths. - [ ] Owning docs, contracts, and generated metadata are updated where needed. - [ ] User-visible CLI/MCP changes include representative output. - [ ] I checked the final diff for secrets, unrelated cleanup, and unsupported claims. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
bsakaguchi 2026-11-01 21:42:31 +00:00
Sign in to join this conversation.
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#6715
No description provided.