@eyeauras/insight-cli 0.0.0-stage → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (174) hide show
  1. package/.cli-package-build.json +1 -0
  2. package/LICENSE +21 -0
  3. package/README.md +60 -2
  4. package/SKILL.md +58 -0
  5. package/dist/src/administration-results.d.ts +1 -0
  6. package/dist/src/administration-results.js +84 -0
  7. package/dist/src/administration.d.ts +14 -0
  8. package/dist/src/administration.js +134 -0
  9. package/dist/src/archive-contract.d.ts +6 -0
  10. package/dist/src/archive-contract.js +108 -0
  11. package/dist/src/archive.d.ts +12 -0
  12. package/dist/src/archive.js +116 -0
  13. package/dist/src/arguments.d.ts +14 -0
  14. package/dist/src/arguments.js +62 -0
  15. package/dist/src/artifacts.d.ts +17 -0
  16. package/dist/src/artifacts.js +115 -0
  17. package/dist/src/bin.d.ts +2 -0
  18. package/dist/src/bin.js +4 -0
  19. package/dist/src/cli.d.ts +10 -0
  20. package/dist/src/cli.js +419 -0
  21. package/dist/src/comment-effects.d.ts +3 -0
  22. package/dist/src/comment-effects.js +55 -0
  23. package/dist/src/contexts.d.ts +115 -0
  24. package/dist/src/contexts.js +1078 -0
  25. package/dist/src/coordinator.d.ts +41 -0
  26. package/dist/src/coordinator.js +160 -0
  27. package/dist/src/cross-results.d.ts +14 -0
  28. package/dist/src/cross-results.js +71 -0
  29. package/dist/src/cross.d.ts +3 -0
  30. package/dist/src/cross.js +43 -0
  31. package/dist/src/data-effects.d.ts +3 -0
  32. package/dist/src/data-effects.js +103 -0
  33. package/dist/src/debugger-results.d.ts +4 -0
  34. package/dist/src/debugger-results.js +151 -0
  35. package/dist/src/debugger-supervisor.d.ts +1 -0
  36. package/dist/src/debugger-supervisor.js +136 -0
  37. package/dist/src/debugger.d.ts +21 -0
  38. package/dist/src/debugger.js +267 -0
  39. package/dist/src/documentation-effects.d.ts +5 -0
  40. package/dist/src/documentation-effects.js +56 -0
  41. package/dist/src/extensions.d.ts +64 -0
  42. package/dist/src/extensions.js +289 -0
  43. package/dist/src/function-effects.d.ts +4 -0
  44. package/dist/src/function-effects.js +112 -0
  45. package/dist/src/ghidra.d.ts +50 -0
  46. package/dist/src/ghidra.js +468 -0
  47. package/dist/src/index.d.ts +2 -0
  48. package/dist/src/index.js +1 -0
  49. package/dist/src/initial-model.d.ts +6 -0
  50. package/dist/src/initial-model.js +85 -0
  51. package/dist/src/json.d.ts +2 -0
  52. package/dist/src/json.js +8 -0
  53. package/dist/src/lifecycle.d.ts +49 -0
  54. package/dist/src/lifecycle.js +154 -0
  55. package/dist/src/memory-inputs.d.ts +8 -0
  56. package/dist/src/memory-inputs.js +56 -0
  57. package/dist/src/merge.d.ts +29 -0
  58. package/dist/src/merge.js +66 -0
  59. package/dist/src/model.d.ts +74 -0
  60. package/dist/src/model.js +67 -0
  61. package/dist/src/mutation-effects.d.ts +4 -0
  62. package/dist/src/mutation-effects.js +321 -0
  63. package/dist/src/mutation-inputs.d.ts +2 -0
  64. package/dist/src/mutation-inputs.js +71 -0
  65. package/dist/src/mutations.d.ts +4 -0
  66. package/dist/src/mutations.js +53 -0
  67. package/dist/src/native-inputs.d.ts +28 -0
  68. package/dist/src/native-inputs.js +182 -0
  69. package/dist/src/native-queries.d.ts +2 -0
  70. package/dist/src/native-queries.js +29 -0
  71. package/dist/src/projects.d.ts +31 -0
  72. package/dist/src/projects.js +301 -0
  73. package/dist/src/prototype-cli.d.ts +8 -0
  74. package/dist/src/prototype-cli.js +155 -0
  75. package/dist/src/queries.d.ts +5 -0
  76. package/dist/src/queries.js +84 -0
  77. package/dist/src/query-policy.d.ts +6 -0
  78. package/dist/src/query-policy.js +72 -0
  79. package/dist/src/query-results.d.ts +2 -0
  80. package/dist/src/query-results.js +224 -0
  81. package/dist/src/research.d.ts +184 -0
  82. package/dist/src/research.js +808 -0
  83. package/dist/src/runtime-archives.d.ts +5 -0
  84. package/dist/src/runtime-archives.js +127 -0
  85. package/dist/src/runtime-catalog.d.ts +18 -0
  86. package/dist/src/runtime-catalog.js +27 -0
  87. package/dist/src/runtime-manager.d.ts +101 -0
  88. package/dist/src/runtime-manager.js +444 -0
  89. package/dist/src/runtime-selection.d.ts +13 -0
  90. package/dist/src/runtime-selection.js +25 -0
  91. package/dist/src/saved-materials.d.ts +12 -0
  92. package/dist/src/saved-materials.js +196 -0
  93. package/dist/src/scripts.d.ts +19 -0
  94. package/dist/src/scripts.js +79 -0
  95. package/dist/src/sdk-contracts.d.ts +13 -0
  96. package/dist/src/sdk-contracts.js +37 -0
  97. package/dist/src/sdk-files.d.ts +29 -0
  98. package/dist/src/sdk-files.js +249 -0
  99. package/dist/src/sdk.d.ts +4 -0
  100. package/dist/src/sdk.js +125 -0
  101. package/dist/src/server.d.ts +46 -0
  102. package/dist/src/server.js +460 -0
  103. package/dist/src/store.d.ts +33 -0
  104. package/dist/src/store.js +178 -0
  105. package/dist/src/sync-policy.d.ts +22 -0
  106. package/dist/src/sync-policy.js +123 -0
  107. package/dist/src/transport.d.ts +23 -0
  108. package/dist/src/transport.js +135 -0
  109. package/dist/src/ui-results.d.ts +2 -0
  110. package/dist/src/ui-results.js +80 -0
  111. package/dist/src/ui.d.ts +17 -0
  112. package/dist/src/ui.js +88 -0
  113. package/dist/src/utility.d.ts +14 -0
  114. package/dist/src/utility.js +43 -0
  115. package/dist/src/version-tracking.d.ts +57 -0
  116. package/dist/src/version-tracking.js +200 -0
  117. package/dist/src/workspace.d.ts +199 -0
  118. package/dist/src/workspace.js +564 -0
  119. package/package.json +47 -4
  120. package/references/InsightRepositoryProbe.java +55 -0
  121. package/references/administration.md +34 -0
  122. package/references/archive.md +32 -0
  123. package/references/artifacts.md +47 -0
  124. package/references/debugger.md +40 -0
  125. package/references/extensions-and-sync.md +124 -0
  126. package/references/managed-runtime.md +116 -0
  127. package/references/mutations.json +1424 -0
  128. package/references/native/InsightApplyDocumentation.java +48 -0
  129. package/references/native/InsightArchivePayloads.java +36 -0
  130. package/references/native/InsightBlockTransfer.java +57 -0
  131. package/references/native/InsightEmulation.java +93 -0
  132. package/references/native/InsightExtensions.java +36 -0
  133. package/references/native/InsightFunctionDatabases.java +98 -0
  134. package/references/native/InsightGuiMain.java +32 -0
  135. package/references/native/InsightHeadlessMain.java +10 -0
  136. package/references/native/InsightInitialImport.java +42 -0
  137. package/references/native/InsightInitialJournal.java +48 -0
  138. package/references/native/InsightInitialPublication.java +142 -0
  139. package/references/native/InsightKeytool.java +16 -0
  140. package/references/native/InsightNativeReceipt.java +31 -0
  141. package/references/native/InsightPlugins.java +34 -0
  142. package/references/native/InsightProjectFiles.java +92 -0
  143. package/references/native/InsightPublicationRecovery.java +63 -0
  144. package/references/native/InsightPythonWheels.java +31 -0
  145. package/references/native/InsightResearchQueries.java +188 -0
  146. package/references/native/InsightRuntimeDoctor.java +33 -0
  147. package/references/native/InsightSdkFiles.java +142 -0
  148. package/references/native/InsightSdkScript.java +31 -0
  149. package/references/native/InsightSdkTools.java +338 -0
  150. package/references/native/InsightSdkTypes.java +132 -0
  151. package/references/native/InsightServerAdministration.java +82 -0
  152. package/references/native/InsightServerInit.java +62 -0
  153. package/references/native/InsightServerMain.java +43 -0
  154. package/references/native/InsightServerProbe.java +29 -0
  155. package/references/native/InsightSnapshotFields.java +68 -0
  156. package/references/native/InsightSnapshotInspect.java +189 -0
  157. package/references/native/InsightSnapshotPublisher.java +123 -0
  158. package/references/native/InsightStartDebugger.java +28 -0
  159. package/references/native/InsightStopDebugger.java +20 -0
  160. package/references/native/InsightTraceInspect.java +24 -0
  161. package/references/native/InsightTraceState.java +130 -0
  162. package/references/native/InsightTraceTools.java +114 -0
  163. package/references/native/InsightVersionTracking.java +91 -0
  164. package/references/native-workflows.md +112 -0
  165. package/references/queries.json +1761 -0
  166. package/references/query-semantics.md +96 -0
  167. package/references/recovery.md +53 -0
  168. package/references/research.md +101 -0
  169. package/references/setup.md +49 -0
  170. package/runtime/GhidraMCP-7.0.0.jar +0 -0
  171. package/runtime/GhidraMCP-LICENSE +202 -0
  172. package/runtime/GhidraMCP-NOTICE +10 -0
  173. package/runtime/provenance.json +11 -0
  174. package/skills/insight-re/SKILL.md +108 -0
@@ -0,0 +1,55 @@
1
+ import ghidra.GhidraApplicationLayout;
2
+ import ghidra.framework.Application;
3
+ import ghidra.framework.HeadlessGhidraApplicationConfiguration;
4
+ import ghidra.framework.client.RepositoryAdapter;
5
+ import ghidra.framework.remote.User;
6
+ import com.xebyte.headless.GhidraServerManager;
7
+ import com.google.gson.Gson;
8
+ import java.util.*;
9
+ import java.io.PrintStream;
10
+
11
+ /** Fixed read-only probe. No write/checkout/terminate operation exists here. */
12
+ class InsightRepositoryProbe {
13
+ public static void main(String[] args) {
14
+ PrintStream output = System.out;
15
+ System.setOut(System.err); // Ghidra diagnostics never share the result protocol.
16
+ try {
17
+ if (args.length != 3 || !Set.of("reader", "publisher").contains(args[2])) throw new IllegalArgumentException();
18
+ Application.initializeApplication(new GhidraApplicationLayout(), new HeadlessGhidraApplicationConfiguration());
19
+ GhidraServerManager manager = new GhidraServerManager();
20
+ manager.connect();
21
+ if (manager.server() == null || !manager.server().isConnected()) throw new IllegalStateException();
22
+ RepositoryAdapter repository = manager.server().getRepository(args[0]);
23
+ repository.connect();
24
+ User user = repository.getUser();
25
+ if (user == null || !user.getName().equals(System.getenv("GHIDRA_SERVER_USER"))) throw new IllegalStateException();
26
+ if (args[2].equals("reader") ? !user.isReadOnly() : !user.hasWritePermission()) throw new SecurityException();
27
+ int split = args[1].lastIndexOf('/');
28
+ String folder = split == 0 ? "/" : args[1].substring(0, split), name = args[1].substring(split + 1);
29
+ var item = repository.getItem(folder, name);
30
+ if(item==null){
31
+ boolean reserved=repository.fileExists(folder,name);
32
+ repository.disconnect();manager.server().disconnect();
33
+ output.println(new Gson().toJson(Map.of("state",reserved?"reserved":"absent","repository",args[0],"path",args[1],"permission",user.getPermissionType())));
34
+ System.exit(0);
35
+ }
36
+ var checkouts = repository.getCheckouts(folder, name);
37
+ var versions = repository.getVersions(folder, name);
38
+ if (item == null || checkouts == null || versions == null || versions.length == 0) throw new IllegalStateException();
39
+ List<Map<String,Object>> history = new ArrayList<>();
40
+ for (var version : versions) history.add(Map.of("version", version.getVersion(), "comment", version.getComment() == null ? "" : version.getComment()));
41
+ List<Long> ids = new ArrayList<>();
42
+ for (var checkout : checkouts) ids.add(checkout.getCheckoutId());
43
+ var result = new LinkedHashMap<String,Object>();
44
+ result.put("repository",repository.getName()); result.put("path",(item.getParentPath().equals("/") ? "/" : item.getParentPath() + "/") + item.getName());
45
+ result.put("version",item.getVersion()); result.put("permission",user.getPermissionType());
46
+ result.put("checkouts",ids); result.put("checkinActive",repository.isCheckinActive(folder,name)); result.put("versions",history);
47
+ repository.disconnect(); manager.server().disconnect();
48
+ output.println(new Gson().toJson(result));
49
+ System.exit(0);
50
+ } catch (Throwable error) {
51
+ output.println("{\"error\":\"authoritative_repository_probe_failed\"}");
52
+ System.exit(1);
53
+ }
54
+ }
55
+ }
@@ -0,0 +1,34 @@
1
+ # Projects, files and server administration
2
+
3
+ Research uses root session/target scope. `ghidra projects` manages separate projects inside the
4
+ selected profile; these projects do not select or replace an agent's private context. Use an
5
+ explicit `--project` for create/open/close/info/files and file operations. Closing releases the
6
+ native handle and preserves files; deletion requires Destructive. File listings are paged.
7
+ Moves select a source `--path` and an existing `--destination` folder. Existing names are preserved.
8
+
9
+ `ghidra program export --session <id> --target <id> --output <file>` saves the selected private
10
+ program as GZF without publishing. `ghidra program import --project <name> --input <gzf>
11
+ --path /folder/program` adds that saved program to a managed project. Importing files does not
12
+ change the immutable target's input identity. Export requires a new output file.
13
+
14
+ `ghidra projects archive --project <name> --output <gar>` exports a native Ghidra project archive.
15
+ `ghidra projects restore --project <new-name> --input <gar>` restores into a new independent owned
16
+ project. Archive entries cannot escape their destination; restoration accepts at most 100,000
17
+ entries and 4 GiB of declared uncompressed data. Research contexts and pending work remain separate.
18
+
19
+ Changing operations accept `--request-id`. A verified native completion journal can recover a
20
+ lost project response without executing that operation again. If no complete journal exists,
21
+ changing that project stays blocked; read-only inspection remains available. Partial or different
22
+ export output does not prove success and is preserved. Retain receipts for continuation.
23
+
24
+ `ghidra server` operates on the configured local or external server. `status` reports connection
25
+ state, including a missing runtime before installation; `start/stop` manage the owned local
26
+ server (stop requires closed contexts). `connect` enables shared operations; `disconnect` releases the owned local server or the
27
+ external connection. Reconnect preserves repositories. Repository/file/history/checkout commands
28
+ require the explicit repository and relevant path. Admin actions require actual server authority
29
+ alongside Factory permissions. Changing ACLs preserves other users and anonymous access.
30
+ Facade reader/publisher authority and canonical publication checkouts remain protected.
31
+
32
+ Unknown server administration outcomes are retained without blind replay. Server/file effects
33
+ are independent of program merge. Use generated help for flags and Factory profile/secret commands
34
+ for connection configuration.
@@ -0,0 +1,32 @@
1
+ # Exchange private documentation with an archive
2
+
3
+ Archive exchange is disabled until the selected Factory profile has an explicit `archiveUrl`.
4
+ Use HTTPS for a remote service; local HTTP is supported for local services. URLs cannot contain
5
+ credentials, query parameters or fragments. An optional bearer token is stored with
6
+ `auth login --role archive --password-stdin`; it is a Factory secret and is never passed to
7
+ Ghidra or the debuggee. `auth logout` clears this token as well as external server credentials.
8
+
9
+ Use `ghidra archive ingest-function --address <entry>` or `ingest-program`, with the usual
10
+ `--session` and `--target`. Both export the selected private view. `--version-label` supplies
11
+ the archive version; its default is `unknown`. Internal project directories are not used as
12
+ version labels. Bulk selection skips default function names unless `--include-default-named`
13
+ is set; `--limit` bounds visited functions. Zero selects all, subject to the documented bound.
14
+ `--dry-run` validates payloads and returns would-be counts without a network request.
15
+
16
+ The service contract is `POST <archiveUrl>/v1/doc_archive/upsert` with JSON and an optional
17
+ `Authorization: Bearer ...` header. The payload matches the pinned GhidraMCP builder: binary
18
+ name, explicit version, function address, run/tool identity, name/prototype, calling convention,
19
+ flags, matching hash/shape metadata, tags, named locals and instruction comments when present.
20
+ The binary name is the logical target name. Each successful JSON response must contain a
21
+ boolean `created` and a nonnegative integer `conflicts_enqueued`. Redirects are refused.
22
+
23
+ Results retain created, updated, conflict, skipped and error counts. Archive conflict counts
24
+ describe the external service's decisions; they do not resolve program merge conflicts.
25
+ Use an optional stable `--request-id` when a response might be lost. A repeated ID returns
26
+ the saved successful result or the retained uncertain outcome, without sending again.
27
+ Each outbound payload identity and the source snapshot are retained before dispatch. Unknown
28
+ external outcomes stay observable and do not block unrelated private research. A new request ID
29
+ expresses another explicit submission; the facade does not assume the service can deduplicate it.
30
+
31
+ Archive requests do not publish the program or alter another session. Developing or deploying
32
+ the external archive service is outside this package; acceptance uses an owned contract fixture.
@@ -0,0 +1,47 @@
1
+ # Save ordinary research materials
2
+
3
+ `insight-cli artifacts save <path> --json` saves a file or a settled directory tree in
4
+ the selected profile's AppData. It needs Factory Update permission and does not require
5
+ Ghidra, Java, authentication, target/session selectors or evidence metadata. Relative input
6
+ paths resolve against the caller's working directory. Use `--help` for generated syntax.
7
+
8
+ Save existing project files in their existing format; no `notes.md`, `finding.md` or
9
+ `research/` layout is required. The saved copy is a checkpoint and does not replace the
10
+ project's canonical evidence location or its source-of-truth rules.
11
+
12
+ Write notes and useful external-tool outputs as ordinary files while investigating. When
13
+ the selected files are no longer being edited, save one file, a completed worker subfolder
14
+ or the relevant project folder. For a project without a prescribed layout, for example:
15
+
16
+ ```sh
17
+ insight-cli artifacts save ./research --json
18
+ ```
19
+
20
+ The receipt has `state: "saved"`, `path`, `kind` (`file` or `directory`), `files`, `bytes`
21
+ and `sha256`. `path` points to an ordinary browsable copy with the source basename and
22
+ relative layout. Empty files and empty directories are retained. File count counts regular
23
+ files; byte count counts their contents. A file's SHA-256 hashes its bytes; a directory's
24
+ SHA-256 hashes its canonical manifest of relative paths, kinds, file lengths and hashes.
25
+ The manifest is stored beside the content, outside the returned directory.
26
+
27
+ The service copies and syncs data before publishing the completed snapshot. Failure does
28
+ not return a successful receipt or expose a partial completed snapshot. Source edits made
29
+ after a successful save do not change the copy. Treat saved copies as retained snapshots;
30
+ edit the original research folder and save a new copy for another checkpoint. Each call
31
+ creates a new saved copy, including a repeated call after a lost response.
32
+
33
+ Keep a directory stable for the save: detected concurrent edits are rejected. Copying
34
+ several files is not an atomic filesystem snapshot of a directory that other agents keep
35
+ changing. Symbolic links and special files are rejected rather than followed or silently
36
+ omitted. Select the actual intended regular file/directory. Do not save a directory that
37
+ contains the destination materials store. Traversal supports at most 100,000 entries and
38
+ 128 levels to bound inventory memory and recursion. Disk/permission failures return nonzero.
39
+
40
+ The saved bytes establish what was retained. Commands, tool versions and interpretations
41
+ written in a note remain the author's statements, not execution attestations. No upload,
42
+ tool execution or Ghidra publication is performed by saving materials.
43
+
44
+ Profile deletion/configuration invalidation is blocked while retained materials exist,
45
+ as with retained research work. Close tool contexts normally; preserve snapshots separately
46
+ if retiring a profile. There is no automatic registration, cleanup policy, graph database
47
+ or additional read API: read the receipt's path with normal file tools.
@@ -0,0 +1,40 @@
1
+ # Debug an input in its private context
2
+
3
+ Use the same `--session` and `--target` as static research. `debugger launch-offers` lists
4
+ available launchers and starts the owned GUI services when needed. `debugger launch` executes a
5
+ verified copy of the selected immutable input in an owned run directory. It accepts `--offer`,
6
+ `--args`, `--cwd`, a bounded launch timeout and the optional request ID. A second live process
7
+ uses another session; it does not replace this context's current process.
8
+
9
+ Read `debugger status`, `modules`, `registers`, `stack-trace` and `traces`. Address conversion
10
+ uses `static-to-dynamic` and `dynamic-to-static`; memory and breakpoint commands take dynamic
11
+ addresses. Lists are paged. Read results identify the logical context and current trace, and
12
+ report whether the trace is connected or retained after disconnection. `--trace` selects a
13
+ saved trace within this context; IDs from another context are rejected.
14
+
15
+ Changing commands include interrupt, resume, step into/over/out and breakpoint set/remove.
16
+ Their optional request ID retrieves the recorded result without executing again. A genuinely
17
+ unknown CPU action remains uncertain; a later program counter alone does not prove how many
18
+ instructions executed. Read-only observation remains available for uncertain debugger actions.
19
+ Program merge does not roll back execution, debugger I/O or other process side effects.
20
+
21
+ Trace databases are checkpointed separately from the private program and verified by independent
22
+ packed-database readback before acknowledgment. Reopening after process replacement restores
23
+ saved trace data as disconnected. It does not restart the debuggee or reconstruct CPU execution.
24
+ Ordinary static program edits remain private and retain the usual merge/refresh behavior.
25
+ Static breakpoint bookmarks created by debugger actions also count as pending program changes.
26
+ They follow explicit merge/refresh and complex-change conflict rules; CPU execution does not
27
+ wait for publication, and publishing a program never resumes another session's process.
28
+
29
+ On macOS, launch enforces the selected working directory, including paths with spaces and
30
+ quotes. A GUI backend crash ends the owned live debuggee through its debugger controller.
31
+ Verified trace data retained before a lost action response is adopted on disconnected continuation,
32
+ unless a later observation already saved a newer view. The CPU action itself remains uncertain.
33
+
34
+ On macOS, use an installed local LLDB and an executable supported by that host. GUI startup
35
+ prepares the Python wheels already supplied with Ghidra in owned storage; it does not install
36
+ packages into system Python. A launcher's optional Python executable and Windows debugger
37
+ directory are Factory profile settings. Native Windows/Linux acceptance remains deferred.
38
+
39
+ Use generated help for exact flags. A retained static breakpoint bookmark may remain after its live trace placement is
40
+ removed; `trace_location_count` distinguishes current placements from that static metadata.
@@ -0,0 +1,124 @@
1
+ # Managed extensions and synchronization
2
+
3
+ `insight-cli` keeps targets/sessions above tools. Both features below belong to the Ghidra
4
+ context/runtime selected by the existing profile; they introduce no new agent/session objects.
5
+ The Factory API uses the same command paths and options as these CLI examples.
6
+
7
+ ## Consume a ready-built SDK extension
8
+
9
+ Use an unpacked standard Ghidra 12.1.2 extension module, with `Module.manifest` and
10
+ `extension.properties` at its root. Directory basename and property `name` must agree.
11
+ The module can contain compiled `lib/*.jar`, `data/languages` (including compiled Sleigh `.sla`,
12
+ `.ldefs`, `.pspec`, `.cspec`) and `ghidra_scripts`. Build the extension with its own upstream
13
+ SDK build before consumption. ZIP acquisition/extraction, dependency resolution, building a
14
+ third-party extension and publishing extensions are outside this local management contract.
15
+
16
+ ```sh
17
+ insight-cli ghidra extensions inspect --directory ./MyExtension --json
18
+ insight-cli ghidra extensions install --directory ./MyExtension --sha256 <content-sha256> --json
19
+ insight-cli ghidra extensions list --json
20
+ ```
21
+
22
+ Inspect computes the content identity without executing extension code. Install requires the
23
+ `Destructive` permission, consumes all regular files into profile storage and verifies the
24
+ copy. It never edits the installed SDK or depends on the original directory after consumption.
25
+ The identity covers sorted relative paths, SHA256 and size for every file; it is not a ZIP hash.
26
+ Symlinks/special files, hidden/traversing paths and incompatible version metadata reject.
27
+ Limits: 32 modules/profile, 8192 files and 256 MiB/module, 16 path components.
28
+ A name stays pinned to one content identity; different builds use different module names or profiles.
29
+
30
+ ```sh
31
+ insight-cli ghidra extensions disable --name MyExtension --json
32
+ insight-cli ghidra extensions enable --name MyExtension --json
33
+ ```
34
+
35
+ Stop the Factory IPC owner after changing the enabled set, then run the next ordinary command.
36
+ A running owner refuses changed runtime configuration. Immutable module copies remain retained
37
+ when disabled, so saved contexts can resume with their original language/type dependencies after
38
+ re-enabling. Existing private work and unknown request/publication journals are preserved.
39
+ Disabling the language required by a saved program does not convert that program to another language.
40
+ Enablement/install are desired-state/content operations; repeating the same input is idempotent.
41
+ No automatic extension updates or network/package-manager installation occur.
42
+
43
+ Discover what the installed SDK actually provides:
44
+
45
+ ```sh
46
+ insight-cli ghidra extensions capabilities --kind languages --filter MyProcessor --json
47
+ insight-cli ghidra extensions capabilities --kind analyzers --filter MyExtension --json
48
+ insight-cli ghidra extensions capabilities --kind plugins --filter MyExtension --json
49
+ ```
50
+
51
+ These paged inventories return actual native IDs (and compiler IDs for languages); `managed`
52
+ on analyzer/plugin classes identifies consumed modules. Select a language/compiler using
53
+ `ghidra open --language <id> --compiler-spec <id>`. Use `analysis configure-analyzer --name <name>
54
+ --enabled true` and `analysis reanalyze` in an explicit context. Program writes remain complex
55
+ private changes and follow the existing saved-state verification/merge rules.
56
+ Extension scripts have explicit inventory IDs such as `extension:MyExtension/Example.java`;
57
+ run that ID through `scripts run`, never guess a process-global search path.
58
+
59
+ For a GUI plugin, use `ghidra plugins set --plugin <class-id> --enabled true|false` with
60
+ `--session` and `--target`. `plugins list` returns enabled managed plugins in that owned GUI tool.
61
+ Only classes from enabled managed modules can be toggled. Enablement is read back immediately;
62
+ its lifetime is the current GUI tool, rather than a promise to resurrect it after a crash.
63
+ Plugin constructors/disposal may change program state: the operation saves a private snapshot
64
+ and conservatively records a complex change. An uncertain effect is never replayed; close the
65
+ owned context when its live effect cannot be established. Configuration dialogs, arbitrary
66
+ plugin-specific option schemas, native libraries with platform installers and hot class unloading
67
+ are not promised by this module contract; the explicit script API remains available.
68
+
69
+ Extension code runs with the OS privileges of the owned JVM. Digest pinning establishes which
70
+ code runs, not a security sandbox or a guarantee of third-party compatibility. Workers, GUI,
71
+ inspection and publication helpers use the same verified enabled set. The storage-only local
72
+ Ghidra Server continues to use the pinned base SDK and does not run managed analysis plugins.
73
+
74
+ ## Optional synchronization for one context
75
+
76
+ The default remains explicit `merge` and `refresh`. Reads keep the private view. Configure an
77
+ existing `(session, target, ghidra)` context explicitly:
78
+
79
+ ```sh
80
+ insight-cli ghidra sync-policy get --session s_a --target t_exe --json
81
+ insight-cli ghidra sync-policy set --session s_a --target t_exe \
82
+ --publish after-edit --refresh before-edit --json
83
+ ```
84
+
85
+ | Setting | Behavior |
86
+ | --- | --- |
87
+ | `--publish manual` | Local edits and saves do not publish automatically. |
88
+ | `--publish after-edit` | After a supported program edit has a verified saved acknowledgment, merge all pending work in that context. Also publishes pending work on explicit `ghidra save`. |
89
+ | `--publish after-save` | Ordinary edits stay private; explicit scoped `ghidra save` merges all pending work after saving. |
90
+ | `--refresh manual` | No automatic incoming update. |
91
+ | `--refresh before-edit` | Refresh before a program-edit command; any returned conflict stops that edit before dispatch. Safe incoming changes from the refresh remain retained. |
92
+
93
+ Supported program-edit commands include ordinary names/comments, types, bytes/assembly,
94
+ analysis and scripts. Policy excludes control commands (`open`, `close`, `merge`, `refresh`,
95
+ policy/discard), cross-target transfer, GUI/debugger, archive/project/server operations, file
96
+ exports, library databases and Version Tracking. Session-wide `save-all` saves privately;
97
+ use scoped `save` for automatic publication. Read-only queries never trigger refresh/publication.
98
+ Automatic refresh/publication also requires the current Factory `Update` permission, including
99
+ when the edit itself is gated by `Destructive`. Revocation prevents starting those automatic
100
+ effects; retrieval of a completed workflow does not repeat them. No background timers, watchers
101
+ or automatic semantic conflict resolution are introduced.
102
+
103
+ A successful automatic edit includes its normal local result plus `automatic.refresh` and/or
104
+ `automatic.publication`, final `pendingChanges` and `sharedState`. After a publication conflict,
105
+ the command fails with `state: conflict`, `localApplied: true` and the retained `local` result.
106
+ Nothing from that merge is published. An incoming conflict reports `phase: refresh` and
107
+ `localApplied: false`; the requested edit was not started. Lost local replies may report
108
+ `localOutcome: unknown`; they do not falsely assert that the local effect failed.
109
+
110
+ Automatic merge uses exactly the manual contract: any conflict prevents the whole publication;
111
+ only verified scalar categories combine after divergence; complex divergence retains both
112
+ versions. Use explicit refresh, inspect/resolve scalar conflicts, or transfer complex changes
113
+ onto a current base. A failed automatic workflow does not silently retry after resolution;
114
+ use a new request or explicit merge for the new intention.
115
+
116
+ Policy survives owner replacement. Optional request IDs (up to 128 characters) bind the local edit, incoming refresh and publication workflow. Repeating the same ID/input
117
+ retrieves its result or reconciles the original publication; it never replays a check-in or
118
+ uncertain script. The original workflow keeps its original policy even if policy changes later.
119
+ Retrying an earlier manual edit does not retroactively publish it after enabling automatic mode.
120
+ Without a request ID, a call is a new intention, as elsewhere in the facade.
121
+
122
+ The caller ID reserves the complete automatic workflow in the common profile namespace, even
123
+ when incoming conflicts prevent the local command from starting. It cannot be reused by an
124
+ explicit merge, close, export or administration operation. Internal child effects have derived IDs.
@@ -0,0 +1,116 @@
1
+ # Managed Ghidra runtime
2
+
3
+ Use `ghidra install` for a complete compatible installation. Node 24+ is the bootstrap dependency;
4
+ no existing Java, Ghidra, Homebrew, Gradle, compiler or Python MCP bridge is required. Factory
5
+ profiles, permissions and OS secret storage remain in use. Follow the project's tool rules when
6
+ it specifies an external installation or server.
7
+
8
+ ```sh
9
+ insight-cli profile create local
10
+ insight-cli --profile local permissions grant Update
11
+ insight-cli --profile local ghidra install
12
+ insight-cli --profile local ghidra status
13
+ insight-cli --profile local ghidra open ./client.exe --session new --json
14
+ ```
15
+
16
+ `download` caches the complete pinned Ghidra/JDK archives, without selecting or starting a runtime.
17
+ `install` uses that cache or downloads missing archives, unpacks to a new stage, checks JDK 21 and
18
+ Ghidra 12.1.2, decompiles a known x86 function and starts a disposable local Ghidra Server. The
19
+ server probe authenticates its identity and reader/publisher permissions. Selection changes only
20
+ after all checks pass. The bridge and helper sources come from the version-matched npm package.
21
+ A failed install preserves its stage/diagnostics and the old selection. Retrying uses a fresh stage;
22
+ completed cached archives are reused. A later install/doctor/uninstall authenticates and stops
23
+ any leftover disposable probe server before proceeding; an unverified live identity blocks recovery. Interrupted partial downloads are never used as complete files.
24
+
25
+ `status` without scope is passive: selection, paths, missing components, installations, retained
26
+ stages, recorded checks and live process receipts. It works before installation. It does not start
27
+ Java or create a research workspace. `status --session S --target T` retains the scoped live health
28
+ check. `server status` also works without an installed runtime and explains missing prerequisites.
29
+ `doctor` explicitly runs disposable native decompiler/server probes and checks macOS LLDB Python.
30
+ It never imports a research target or publishes research changes. Readiness recorded by a doctor
31
+ run includes its runtime fingerprint; status identifies whether that record matches the selection.
32
+
33
+ ## Local archives and external installations
34
+
35
+ ```sh
36
+ insight-cli --profile local ghidra download
37
+ insight-cli --profile local ghidra install --offline
38
+ insight-cli --profile local ghidra install --archive ./ghidra.zip
39
+ insight-cli --profile local ghidra install --archive ./ghidra.zip \
40
+ --java-archive ./jdk.tar.gz --offline
41
+ insight-cli --profile local ghidra install --executable /tools/ghidra/ghidraRun
42
+ insight-cli --profile local ghidra install --executable /tools/ghidra \
43
+ --java /tools/jdk/bin/java --offline
44
+ ```
45
+
46
+ `--executable` accepts the actual Ghidra launcher (`ghidraRun[.bat]`, or
47
+ `support/analyzeHeadless[.bat]`) or installation directory. It needs the complete compatible
48
+ installation, including host native components. A target EXE is not a Ghidra launcher.
49
+ Common Homebrew launcher wrappers are resolved through the adjacent complete `libexec` tree.
50
+ The external Ghidra tree is never modified or deleted. Java is delivered automatically unless
51
+ `--java` or `--java-archive` is supplied. Legacy profile `java`/`ghidraHome` configuration still works
52
+ when no explicit selection exists; an explicit selection takes precedence and never silently
53
+ falls back to profile paths after failure or uninstall.
54
+
55
+ Local archives are caller-selected inputs, consumed into owned hash-addressed copies before
56
+ extraction so later source edits cannot change the installed bytes. Optional `--archive-sha256` and
57
+ `--java-archive-sha256` check the expected bytes; the actual digests are recorded in the installation
58
+ identity. `--offline` prohibits network acquisition: provide/cache every required archive. On macOS,
59
+ an official Ghidra zip also needs the pinned prebuilt native archive in cache. The managed macOS
60
+ distribution already includes these natives. Executable modes are preserved; paths, links and
61
+ expanded sizes are checked during portable Node extraction. Downloads use pinned SHA256 values.
62
+ No external unzip, tar or Python executable is needed for extraction.
63
+
64
+ ## Server, process and data ownership
65
+
66
+ The Ghidra distribution includes Ghidra Server. It uses the selected JDK and immutable tool code;
67
+ its repository, certificates, credentials and process settings are separate profile data.
68
+ Ordinary `open` starts it automatically. `server start` explicitly starts/enables it, and
69
+ `server stop` stops the identified owned server after all contexts are closed. It refuses to stop
70
+ a server under live clients. A later open can start it again; explicit `disconnect` disables shared
71
+ operations until `connect`/`start`. `server connect/disconnect` retain their connection-management API.
72
+ An external server remains configured through profile server/repository/account fields and Factory
73
+ secrets; `server stop` cannot stop that external service.
74
+
75
+ Code/cache/installation receipts live under profile AppData `runtime/`; research remains under
76
+ `workspace/`, and saved files under `materials/`. One selected immutable installation serves many
77
+ isolated JVM contexts; each has its own projects, home, settings, cache/temp and authenticated
78
+ endpoint. No per-agent copy of the Ghidra code distribution is required. This is process and data
79
+ isolation; it does not restrict arbitrary user scripts to an OS security sandbox.
80
+
81
+ Close scoped contexts and stop the owned server before selecting/reinstalling/removing a runtime.
82
+ A live receipt conservatively blocks these operations; it never authorizes killing a PID.
83
+ Download and doctor can run without switching the current runtime. Runtime commands serialize
84
+ within the Factory owner. Changing a selected runtime invalidates cached backend handles, without
85
+ removing saved research. There is no automatic version migration or floating upstream upgrade.
86
+
87
+ ```sh
88
+ insight-cli --profile local ghidra close --session S --target T
89
+ insight-cli --profile local ghidra server stop
90
+ insight-cli --profile local permissions grant Destructive
91
+ insight-cli --profile local ghidra uninstall
92
+ # Optional cache deletion; research and external installations remain preserved:
93
+ insight-cli --profile local ghidra uninstall --purge-cache
94
+ ```
95
+
96
+ Uninstall removes only selected owned installation files. It preserves the selection as an
97
+ uninstalled receipt, so later research reports a missing runtime instead of changing bindings.
98
+ Archives remain reusable unless `--purge-cache` is selected. Reinstalling the same archives restores
99
+ the same runtime identity. Sessions, private snapshots, unresolved publication journals, server
100
+ repositories and artifacts survive. Uninstall does not resolve an uncertain merge or replay it.
101
+
102
+ ## Sources and host boundary
103
+
104
+ The catalog pins Ghidra 12.1.2 and Temurin JDK 21.0.11+10. macOS uses public Homebrew-built Ghidra
105
+ bottles with native components (macOS 14+, ARM64 or x64); no installed Homebrew is used. Linux x64
106
+ and Windows x64 use the official Ghidra zip and Temurin archive. All source URLs, hashes and license
107
+ identities are in `src/runtime-catalog.ts`; downloaded distributions retain their license files.
108
+ Unsupported platforms fail explicitly and may use compatible external profile paths. Native
109
+ acceptance for this delivery is macOS ARM64; catalog availability is not Windows/Linux native proof.
110
+
111
+ The host provides Node/npm, OS frameworks, display/keychain access and debugger authorization.
112
+ macOS LLDB and its embedded Python come from Apple's developer tools; they are OS prerequisites,
113
+ not downloaded third-party Python dependencies. `doctor` reports a missing host debugger as a partial
114
+ failure even when static analysis/server pass. No root installation, developer-tools installer,
115
+ Gatekeeper disabling, shell-profile edit or global Java/Python selection is performed. Ghidra GUI
116
+ agents receive private copies of the Ghidra SDK's pinned debugger Python wheels.