[PR #2037] [MERGED] docs(cli): add a managed assembly inspection workflow #4979

New issue

Closed

opened 2026-10-31 00:57:38 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-31 00:57:38 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/2037
Author: @sandr01
Created: 10/12/2026
Status: ✅ Merged
Merged: 10/12/2026
Merged by: @morluto

Base: main ← Head: codex/docs-managed-cli-workflow

📝 Commits (1)

4fb627f docs(cli): add a managed assembly inspection workflow

📊 Changes

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

View changed files

📝 docs/cli.md (+25 -0)

📄 Description

Summary

Add a managed assembly workflow to the CLI guide so readers can start inspecting .NET artifacts without first configuring a native disassembler.

Problem and expected behavior

The CLI guide currently walks readers through JavaScript and native analysis but omits the static PE/CLI route. A reader with a managed DLL needs runnable identity/member inspection examples and guidance on selecting the correct workflow from artifact contents.

Change and scope

Document inspect-managed-artifact, whole-assembly inspect-managed-members, and focused --type inspection. Explain exact member full_name selection, the assembly-wide member-reference inventory, and the separate boundaries for single-file hosts, IL2CPP metadata, and NativeAOT method bodies. Link to the owning managed-code guide. No related issue was found; this is a focused documentation contribution.

Contract and boundary impact

Semantic owner and earliest changed stage: CLI user documentation, docs/cli.md.
CLI and MCP/tool-catalog contract: none.
Provider, bridge, target-format, or platform compatibility: none; describes existing support.
Evidence, artifact, provenance, or reconstruction contract: none.
Process execution, authorization, cleanup, or containment impact: none.
Generated metadata (docs/public/product-catalog.json), package, or installation impact: none.

Evidence and regression coverage

Tests added or updated: none; documentation-only change.
Source-derived evidence: command names and --type registration checked against src/cliCommandNames.ts and src/cli/managedCommands.ts; selection and deployment limits checked against docs/managed-code-analysis.md and the managed inspection schemas.
User-visible CLI/MCP output: unchanged.
Remaining proof gaps: example commands were not executed against an assembly.

Validation performed

git diff --check — passed.
Node script checking local Markdown link targets, documented command names/type option, and selection/deployment caveats — passed.
npm run check and npm run docs:check — not run: npm and repository dependencies are unavailable in this environment.

Compatibility, safety, and release

Breaking changes or migration steps: none.
Real Hopper/Ghidra, browser, or OS coverage: not exercised; no provider behavior changes.
Package or release metadata impact: none.
Security, privacy, process, or containment review: documentation only; preserves the distinction between static inspection and execution.

Review checklist

This PR addresses a concrete problem.
One focused outcome with a Conventional Commit title.
Reason for no linked issue stated above.
Owning documentation updated.
Final diff checked for unrelated changes 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/2037 **Author:** [@sandr01](https://github.com/sandr01) **Created:** 10/12/2026 **Status:** ✅ Merged **Merged:** 10/12/2026 **Merged by:** [@morluto](https://github.com/morluto) **Base:** `main` ← **Head:** `codex/docs-managed-cli-workflow` --- ### 📝 Commits (1) - [`4fb627f`](https://github.com/morluto/rea/commit/4fb627f74cca06c31aa970473e5a11187deda7c4) docs(cli): add a managed assembly inspection workflow ### 📊 Changes **1 file changed** (+25 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `docs/cli.md` (+25 -0) </details> ### 📄 Description ## Summary Add a managed assembly workflow to the CLI guide so readers can start inspecting .NET artifacts without first configuring a native disassembler. ## Problem and expected behavior The CLI guide currently walks readers through JavaScript and native analysis but omits the static PE/CLI route. A reader with a managed DLL needs runnable identity/member inspection examples and guidance on selecting the correct workflow from artifact contents. ## Change and scope Document `inspect-managed-artifact`, whole-assembly `inspect-managed-members`, and focused `--type` inspection. Explain exact member `full_name` selection, the assembly-wide member-reference inventory, and the separate boundaries for single-file hosts, IL2CPP metadata, and NativeAOT method bodies. Link to the owning managed-code guide. No related issue was found; this is a focused documentation contribution. ## Contract and boundary impact - Semantic owner and earliest changed stage: CLI user documentation, `docs/cli.md`. - CLI and MCP/tool-catalog contract: none. - Provider, bridge, target-format, or platform compatibility: none; describes existing support. - Evidence, artifact, provenance, or reconstruction contract: none. - Process execution, authorization, cleanup, or containment impact: none. - Generated metadata (`docs/public/product-catalog.json`), package, or installation impact: none. ## Evidence and regression coverage - Tests added or updated: none; documentation-only change. - Source-derived evidence: command names and `--type` registration checked against `src/cliCommandNames.ts` and `src/cli/managedCommands.ts`; selection and deployment limits checked against `docs/managed-code-analysis.md` and the managed inspection schemas. - User-visible CLI/MCP output: unchanged. - Remaining proof gaps: example commands were not executed against an assembly. ## Validation performed - `git diff --check` — passed. - Node script checking local Markdown link targets, documented command names/type option, and selection/deployment caveats — passed. - `npm run check` and `npm run docs:check` — not run: npm and repository dependencies are unavailable in this environment. ## Compatibility, safety, and release - Breaking changes or migration steps: none. - Real Hopper/Ghidra, browser, or OS coverage: not exercised; no provider behavior changes. - Package or release metadata impact: none. - Security, privacy, process, or containment review: documentation only; preserves the distinction between static inspection and execution. ## Review checklist - [x] This PR addresses a concrete problem. - [x] One focused outcome with a Conventional Commit title. - [x] Reason for no linked issue stated above. - [x] Owning documentation updated. - [x] Final diff checked for unrelated changes 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 00:57:38 +00:00