[PR #4651] [CLOSED] docs(cli): list Kuna as a doctor provider #6344

Closed
opened 2026-10-31 01:13:44 +00:00 by bsakaguchi · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/4651
Author: @Ha1baraA11
Created: 10/17/2026
Status: ❌ Closed

Base: main ← Head: pr/rea-4624


📝 Commits (4)

  • e8c3153 docs(cli): list Kuna as a doctor provider
  • 133deb8 test(docs): simplify provider ID assertion message
  • 403043a Merge branch 'main' into pr/rea-4624
  • 1164efe test(docs): assert exported doctor provider IDs

📊 Changes

2 files changed (+27 additions, -3 deletions)

View changed files

📝 docs/cli.md (+4 -3)
📝 tests/conformance/readmeConsistency.test.ts (+23 -0)

📄 Description

Summary

The CLI guide now lists kuna as a supported rea doctor --provider value and links to its setup guide.
Related to #4624

Problem and expected behavior

The CLI paragraph omits an ID already accepted by the allowlist and documented in the Kuna guide. Keeping the reference in sync makes the existing option easy to find.

Change and scope

  • List kuna with the accepted rea doctor --provider values and link to the existing Kuna guide.
  • Add a conformance check that reads the source IDs, checks them against the CLI paragraph, and verifies the Kuna guide link.

Contract and boundary impact

  • Semantic owner and earliest changed stage: The CLI provider-selection paragraph in docs/cli.md; no runtime stage changes.
  • Contribution scope fit and linked maintainer decision: Documentation for an existing provider; no new capability or maintainer scope decision is involved.
  • CLI and MCP/tool-catalog contract: The CLI already accepts kuna; no MCP schema, command parser, or catalog changes.
  • Provider, bridge, target-format, or platform compatibility: Existing Kuna support and target compatibility stay as they are; the CLI guide now points to its setup instructions.
  • Evidence, artifact, provenance, or reconstruction contract: No change to analysis output, evidence records, artifact provenance, or reconstruction.
  • Target selection, authority, upstream behavior, and cleanup details (if applicable): Not applicable; this change does not select, launch, or modify a target.
  • 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.
  • Generated metadata (docs/public/product-catalog.json), package, or installation impact: No generated metadata, package, or installation change.

Evidence and regression coverage

  • Tests added or updated: tests/conformance/readmeConsistency.test.ts reads the source allowlist, checks each ID against the CLI paragraph, and checks the Kuna guide link.
  • Base reproduction or other evidence: On base 150e996, the regression command below fails because the CLI paragraph omits kuna; the same command passes on this patch.
  • User-visible CLI/MCP output (if applicable): With no Kuna executable configured, the isolated command selects kuna and reports missing_analysis_engine; the overall diagnostic also marks this Darwin arm64 host unsupported_host. An unknown ID returns VALIDATION_ERROR.
  • Remaining proof gaps: These checks cover CLI validation and readiness output, not a Kuna analysis run.
  • Observed, derived, and inferred claims remain distinguishable.
  • Artifact identity, source provenance, and failed attempts remain preserved.
  • Unsupported, incomplete, unavailable, or uncertain outcomes remain visible.

Validation performed

  • npm ci — passed.
  • npm run test:focused -- src/ghidra/GhidraInstallation.test.ts — 89 passed.
  • npm run check:fast — passed.
  • npm run build:cached — passed.
  • npm run docs:check — 6 passed.
  • npm run verify:test-discovery — passed.
  • node scripts/run-exact-tests.mjs --reporter=verbose --testNamePattern "^provider documentation > lists every ID accepted by \x60doctor --provider\x60$" tests/conformance/readmeConsistency.test.ts — 1 passed, 5 skipped.

Compatibility, safety, and release

  • No migration is needed; Kuna was already accepted by the CLI.
  • No package or release metadata changed.

Author readiness

  • 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.
    Human owner:

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/4651 **Author:** [@Ha1baraA11](https://github.com/Ha1baraA11) **Created:** 10/17/2026 **Status:** ❌ Closed **Base:** `main` ← **Head:** `pr/rea-4624` --- ### 📝 Commits (4) - [`e8c3153`](https://github.com/morluto/rea/commit/e8c31534cfb52258f4237addca48eae1887e3f58) docs(cli): list Kuna as a doctor provider - [`133deb8`](https://github.com/morluto/rea/commit/133deb8796bc600bc200ae1daaece7206517e4d9) test(docs): simplify provider ID assertion message - [`403043a`](https://github.com/morluto/rea/commit/403043a4f34b991263c091f233d8fb80e4d7749a) Merge branch 'main' into pr/rea-4624 - [`1164efe`](https://github.com/morluto/rea/commit/1164efe01ae85cd31a44329a11bd45a26287ad3a) test(docs): assert exported doctor provider IDs ### 📊 Changes **2 files changed** (+27 additions, -3 deletions) <details> <summary>View changed files</summary> 📝 `docs/cli.md` (+4 -3) 📝 `tests/conformance/readmeConsistency.test.ts` (+23 -0) </details> ### 📄 Description ## Summary The CLI guide now lists `kuna` as a supported `rea doctor --provider` value and links to its setup guide. Related to #4624 ## Problem and expected behavior The CLI paragraph omits an ID already accepted by the allowlist and documented in the Kuna guide. Keeping the reference in sync makes the existing option easy to find. ## Change and scope - List `kuna` with the accepted `rea doctor --provider` values and link to the existing Kuna guide. - Add a conformance check that reads the source IDs, checks them against the CLI paragraph, and verifies the Kuna guide link. ## Contract and boundary impact - Semantic owner and earliest changed stage: The CLI provider-selection paragraph in `docs/cli.md`; no runtime stage changes. - Contribution scope fit and linked maintainer decision: Documentation for an existing provider; no new capability or maintainer scope decision is involved. - CLI and MCP/tool-catalog contract: The CLI already accepts `kuna`; no MCP schema, command parser, or catalog changes. - Provider, bridge, target-format, or platform compatibility: Existing Kuna support and target compatibility stay as they are; the CLI guide now points to its setup instructions. - Evidence, artifact, provenance, or reconstruction contract: No change to analysis output, evidence records, artifact provenance, or reconstruction. - Target selection, authority, upstream behavior, and cleanup details (if applicable): Not applicable; this change does not select, launch, or modify a target. - [ ] 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. - Generated metadata (`docs/public/product-catalog.json`), package, or installation impact: No generated metadata, package, or installation change. ## Evidence and regression coverage - Tests added or updated: `tests/conformance/readmeConsistency.test.ts` reads the source allowlist, checks each ID against the CLI paragraph, and checks the Kuna guide link. - Base reproduction or other evidence: On base `150e996`, the regression command below fails because the CLI paragraph omits `kuna`; the same command passes on this patch. - User-visible CLI/MCP output (if applicable): With no Kuna executable configured, the isolated command selects `kuna` and reports `missing_analysis_engine`; the overall diagnostic also marks this Darwin arm64 host `unsupported_host`. An unknown ID returns `VALIDATION_ERROR`. - Remaining proof gaps: These checks cover CLI validation and readiness output, not a Kuna analysis run. - [ ] Observed, derived, and inferred claims remain distinguishable. - [ ] Artifact identity, source provenance, and failed attempts remain preserved. - [ ] Unsupported, incomplete, unavailable, or uncertain outcomes remain visible. ## Validation performed - `npm ci` — passed. - `npm run test:focused -- src/ghidra/GhidraInstallation.test.ts` — 89 passed. - `npm run check:fast` — passed. - `npm run build:cached` — passed. - `npm run docs:check` — 6 passed. - `npm run verify:test-discovery` — passed. - `node scripts/run-exact-tests.mjs --reporter=verbose --testNamePattern "^provider documentation > lists every ID accepted by \x60doctor --provider\x60$" tests/conformance/readmeConsistency.test.ts` — 1 passed, 5 skipped. ## Compatibility, safety, and release - No migration is needed; Kuna was already accepted by the CLI. - No package or release metadata changed. ## Author readiness - [ ] 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. Human owner: ## 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-10-31 01:13:44 +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#6344
No description provided.