build: add canonical product catalog and docs drift checks
Derive package, tool-family, provider, setup-client, schema-version, and CLI facts from the runtime contract sources into a deterministic checked-in catalog. Add non-mutating generated-file checks, exact TypeDoc regenerate-and-compare validation, caller-visible documentation fact checks, and CI enforcement through docs:check. Cover command-router parity, source-derived catalog values, deliberate documentation drift, and stale generated artifacts while preserving runtime behavior.
This commit is contained in:
@@ -8,46 +8,69 @@ export interface SetupClient {
|
||||
readonly format?: "json" | "toml" | "unsupported";
|
||||
}
|
||||
|
||||
/** Describe every client location that setup, doctor, or uninstall may inspect. */
|
||||
export const supportedClients = (home: string): readonly SetupClient[] => [
|
||||
/** Stable product metadata used to derive setup discovery and documentation. */
|
||||
export const SUPPORTED_CLIENT_DEFINITIONS = [
|
||||
{
|
||||
name: "claude_code",
|
||||
configPath: join(home, ".claude.json"),
|
||||
markerPath: join(home, ".claude"),
|
||||
displayName: "Claude Code",
|
||||
configPath: [".claude.json"],
|
||||
markerPath: [".claude"],
|
||||
format: "json",
|
||||
},
|
||||
{
|
||||
name: "claude_desktop",
|
||||
configPath: join(
|
||||
home,
|
||||
"Library/Application Support/Claude/claude_desktop_config.json",
|
||||
),
|
||||
markerPath: join(home, "Library/Application Support/Claude"),
|
||||
displayName: "Claude Desktop",
|
||||
configPath: [
|
||||
"Library",
|
||||
"Application Support",
|
||||
"Claude",
|
||||
"claude_desktop_config.json",
|
||||
],
|
||||
markerPath: ["Library", "Application Support", "Claude"],
|
||||
format: "json",
|
||||
},
|
||||
{
|
||||
name: "codex",
|
||||
configPath: join(home, ".codex/config.toml"),
|
||||
markerPath: join(home, ".codex"),
|
||||
displayName: "Codex",
|
||||
configPath: [".codex", "config.toml"],
|
||||
markerPath: [".codex"],
|
||||
format: "toml",
|
||||
},
|
||||
{
|
||||
name: "cursor",
|
||||
configPath: join(home, ".cursor/mcp.json"),
|
||||
markerPath: join(home, ".cursor"),
|
||||
displayName: "Cursor",
|
||||
configPath: [".cursor", "mcp.json"],
|
||||
markerPath: [".cursor"],
|
||||
format: "json",
|
||||
},
|
||||
{
|
||||
name: "gemini_cli",
|
||||
configPath: join(home, ".gemini/settings.json"),
|
||||
markerPath: join(home, ".gemini"),
|
||||
displayName: "Gemini CLI",
|
||||
configPath: [".gemini", "settings.json"],
|
||||
markerPath: [".gemini"],
|
||||
format: "json",
|
||||
},
|
||||
{
|
||||
name: "windsurf",
|
||||
configPath: join(home, ".codeium/windsurf/mcp_config.json"),
|
||||
markerPath: join(home, ".codeium/windsurf"),
|
||||
displayName: "Windsurf",
|
||||
configPath: [".codeium", "windsurf", "mcp_config.json"],
|
||||
markerPath: [".codeium", "windsurf"],
|
||||
format: "json",
|
||||
},
|
||||
{
|
||||
name: "devin",
|
||||
configPath: join(home, ".devin"),
|
||||
markerPath: join(home, ".devin"),
|
||||
displayName: "Devin",
|
||||
configPath: [".devin"],
|
||||
markerPath: [".devin"],
|
||||
format: "unsupported",
|
||||
},
|
||||
];
|
||||
] as const;
|
||||
|
||||
/** Describe every client location that setup, doctor, or uninstall may inspect. */
|
||||
export const supportedClients = (home: string): readonly SetupClient[] =>
|
||||
SUPPORTED_CLIENT_DEFINITIONS.map((definition) => ({
|
||||
name: definition.name,
|
||||
configPath: join(home, ...definition.configPath),
|
||||
markerPath: join(home, ...definition.markerPath),
|
||||
format: definition.format,
|
||||
}));
|
||||
|
||||
@@ -65,11 +65,13 @@ import { discoverWebMcp } from "./CdpWebMcpDiscovery.js";
|
||||
import { captureCdpScreenshot } from "./CdpScreenshot.js";
|
||||
import { comparePngScreenshots } from "./PngVisualDiff.js";
|
||||
|
||||
const IDENTITY: ProviderIdentity = {
|
||||
/** Public identity committed by passive browser observations. */
|
||||
export const CDP_BROWSER_PROVIDER_IDENTITY: ProviderIdentity = Object.freeze({
|
||||
id: "rea-cdp-browser",
|
||||
name: "REA Chrome DevTools Protocol observation provider",
|
||||
version: "2",
|
||||
};
|
||||
});
|
||||
const IDENTITY = CDP_BROWSER_PROVIDER_IDENTITY;
|
||||
const CLEANUP_DOMAINS = ["Network", "Debugger", "Runtime", "Page"] as const;
|
||||
|
||||
/** Passive, origin-scoped browser observation through a user-owned CDP endpoint. */
|
||||
|
||||
@@ -34,11 +34,13 @@ import {
|
||||
canonicalElectronRoots,
|
||||
} from "./ElectronFileScope.js";
|
||||
|
||||
const IDENTITY: ProviderIdentity = {
|
||||
/** Public identity committed by passive Electron observations. */
|
||||
export const CDP_ELECTRON_PROVIDER_IDENTITY: ProviderIdentity = Object.freeze({
|
||||
id: "rea-cdp-electron",
|
||||
name: "REA Electron file-page CDP observation provider",
|
||||
version: "1",
|
||||
};
|
||||
});
|
||||
const IDENTITY = CDP_ELECTRON_PROVIDER_IDENTITY;
|
||||
|
||||
/** Passive Electron provider with canonical file-root confinement. */
|
||||
export class CdpElectronProvider implements ElectronObservationPort {
|
||||
|
||||
+2
-41
@@ -5,48 +5,9 @@ import { z } from "zod";
|
||||
|
||||
import { PROMPT_CONTRACTS } from "./contracts/promptContracts.js";
|
||||
import { TOOL_CONTRACTS } from "./contracts/toolContracts.js";
|
||||
import { CLI_COMMAND_NAMES } from "./cliCommandNames.js";
|
||||
|
||||
/** Explicit CLI command inventory, kept separate from MCP tool counts. */
|
||||
export const CLI_COMMAND_NAMES = [
|
||||
"analyze",
|
||||
"inspect",
|
||||
"decompile",
|
||||
"setup",
|
||||
"doctor",
|
||||
"uninstall",
|
||||
"upgrade",
|
||||
"xrefs",
|
||||
"trace",
|
||||
"capabilities",
|
||||
"providers",
|
||||
"function",
|
||||
"search",
|
||||
"import-reference-source",
|
||||
"inventory-artifact",
|
||||
"extract-artifact",
|
||||
"inspect-macho",
|
||||
"inspect-signature",
|
||||
"list-architectures",
|
||||
"inspect-plist",
|
||||
"demangle-swift",
|
||||
"evidence-import",
|
||||
"evidence-export",
|
||||
"compare",
|
||||
"investigate-versions",
|
||||
"capture-process",
|
||||
"compare-process-captures",
|
||||
"policy",
|
||||
"list-browser-targets",
|
||||
"inspect-web-page",
|
||||
"analyze-web-bundle",
|
||||
"observe-web-session",
|
||||
"discover-webmcp-tools",
|
||||
"compare-web-captures",
|
||||
"capture-web-screenshot",
|
||||
"compare-web-screenshots",
|
||||
"list-electron-targets",
|
||||
"inspect-electron-page",
|
||||
] as const;
|
||||
export { CLI_COMMAND_NAMES } from "./cliCommandNames.js";
|
||||
|
||||
const toolCatalog = TOOL_CONTRACTS.map((contract) => ({
|
||||
name: contract.name,
|
||||
|
||||
+24
-20
@@ -30,6 +30,7 @@ import { registerPolicyCommands } from "./cliPolicyCommands.js";
|
||||
import { registerBrowserCommands } from "./cliBrowserCommands.js";
|
||||
import { registerAdvancedBrowserCommands } from "./cliBrowserAdvancedCommands.js";
|
||||
import { registerElectronCommands } from "./cliElectronCommands.js";
|
||||
import { CLI_COMMANDS } from "./cliCommandNames.js";
|
||||
|
||||
/**
|
||||
* Build the one-shot Incur CLI without starting Hopper at import time.
|
||||
@@ -95,7 +96,7 @@ const registerCoreCommands = (
|
||||
.optional()
|
||||
.describe("Load and update a local analysis snapshot"),
|
||||
});
|
||||
cli.command("analyze", {
|
||||
cli.command(CLI_COMMANDS.analyze, {
|
||||
description: "Get an overview of an app",
|
||||
args: z.object({
|
||||
path: z.string().describe("App, program, or Hopper database path"),
|
||||
@@ -111,7 +112,7 @@ const registerCoreCommands = (
|
||||
),
|
||||
),
|
||||
});
|
||||
cli.command("inspect", {
|
||||
cli.command(CLI_COMMANDS.inspect, {
|
||||
description: "Inspect an app overview with evidence",
|
||||
args: z.object({
|
||||
path: z.string().describe("App, program, or Hopper database path"),
|
||||
@@ -127,7 +128,7 @@ const registerCoreCommands = (
|
||||
),
|
||||
),
|
||||
});
|
||||
cli.command("decompile", {
|
||||
cli.command(CLI_COMMANDS.decompile, {
|
||||
description: "Read one part of an app as code",
|
||||
args: z.object({
|
||||
path: z.string().describe("App or program path"),
|
||||
@@ -150,7 +151,7 @@ const registerSetupCommands = (
|
||||
cli: ReturnType<typeof Cli.create>,
|
||||
logger: Logger,
|
||||
): void => {
|
||||
cli.command("setup", {
|
||||
cli.command(CLI_COMMANDS.setup, {
|
||||
description: "Install requirements and configure agents",
|
||||
options: z.object({
|
||||
yes: z
|
||||
@@ -178,7 +179,7 @@ const registerSetupCommands = (
|
||||
),
|
||||
),
|
||||
});
|
||||
cli.command("doctor", {
|
||||
cli.command(CLI_COMMANDS.doctor, {
|
||||
description: "Check whether REA is ready",
|
||||
options: z.object({
|
||||
target: z.string().optional().describe("Optional app path to check"),
|
||||
@@ -186,7 +187,7 @@ const registerSetupCommands = (
|
||||
run: ({ options }) =>
|
||||
logCliCommand(logger, "doctor", () => runDoctor(options.target)),
|
||||
});
|
||||
cli.command("uninstall", {
|
||||
cli.command(CLI_COMMANDS.uninstall, {
|
||||
description: "Remove REA-owned agent configuration and skill files",
|
||||
options: z.object({
|
||||
purgeData: z
|
||||
@@ -198,7 +199,7 @@ const registerSetupCommands = (
|
||||
run: ({ options }) =>
|
||||
logCliCommand(logger, "uninstall", () => runUninstall(options.purgeData)),
|
||||
});
|
||||
cli.command("upgrade", {
|
||||
cli.command(CLI_COMMANDS.upgrade, {
|
||||
description: "Upgrade a global npm installation to the latest REA release",
|
||||
run: ({ formatExplicit }) =>
|
||||
logCliCommand(logger, "upgrade", () =>
|
||||
@@ -237,7 +238,7 @@ const registerXrefsCommand = (
|
||||
cli: ReturnType<typeof Cli.create>,
|
||||
logger: Logger,
|
||||
): void => {
|
||||
cli.command("xrefs", {
|
||||
cli.command(CLI_COMMANDS.xrefs, {
|
||||
description: "List bounded references to an analyzed address",
|
||||
args: z.object({
|
||||
path: z.string().describe("App or program path"),
|
||||
@@ -260,7 +261,7 @@ const registerTraceCommand = (
|
||||
cli: ReturnType<typeof Cli.create>,
|
||||
logger: Logger,
|
||||
): void => {
|
||||
cli.command("trace", {
|
||||
cli.command(CLI_COMMANDS.trace, {
|
||||
description: "Trace a bounded literal feature through analyzed references",
|
||||
args: z.object({
|
||||
path: z.string().describe("App or program path"),
|
||||
@@ -297,7 +298,10 @@ const registerCapabilityCommands = (
|
||||
cli: ReturnType<typeof Cli.create>,
|
||||
logger: Logger,
|
||||
): void => {
|
||||
for (const command of ["capabilities", "providers"] as const) {
|
||||
for (const command of [
|
||||
CLI_COMMANDS.capabilities,
|
||||
CLI_COMMANDS.providers,
|
||||
] as const) {
|
||||
cli.command(command, {
|
||||
description:
|
||||
command === "capabilities"
|
||||
@@ -312,7 +316,7 @@ const registerFunctionCommand = (
|
||||
cli: ReturnType<typeof Cli.create>,
|
||||
logger: Logger,
|
||||
): void => {
|
||||
cli.command("function", {
|
||||
cli.command(CLI_COMMANDS.function, {
|
||||
description: "Analyze one bounded function with evidence",
|
||||
args: z.object({
|
||||
path: z.string().describe("App or program path"),
|
||||
@@ -352,7 +356,7 @@ const registerSearchCommand = (
|
||||
cli: ReturnType<typeof Cli.create>,
|
||||
logger: Logger,
|
||||
): void => {
|
||||
cli.command("search", {
|
||||
cli.command(CLI_COMMANDS.search, {
|
||||
description: "Search bounded analyzed strings or procedure names",
|
||||
args: z.object({
|
||||
path: z.string().describe("App or program path"),
|
||||
@@ -389,7 +393,7 @@ const registerReferenceSourceCommand = (
|
||||
cli: ReturnType<typeof Cli.create>,
|
||||
logger: Logger,
|
||||
): void => {
|
||||
cli.command("import-reference-source", {
|
||||
cli.command(CLI_COMMANDS.importReferenceSource, {
|
||||
description: "Import a bounded source tree as historical reference only",
|
||||
args: z.object({
|
||||
root: z
|
||||
@@ -455,7 +459,7 @@ const registerArtifactCommands = (
|
||||
cli: ReturnType<typeof Cli.create>,
|
||||
logger: Logger,
|
||||
): void => {
|
||||
cli.command("inventory-artifact", {
|
||||
cli.command(CLI_COMMANDS.inventoryArtifact, {
|
||||
description: "Build a bounded deterministic artifact graph",
|
||||
args: z.object({
|
||||
path: z.string().describe("Application or package path"),
|
||||
@@ -495,7 +499,7 @@ const registerArtifactCommands = (
|
||||
),
|
||||
),
|
||||
});
|
||||
cli.command("extract-artifact", {
|
||||
cli.command(CLI_COMMANDS.extractArtifact, {
|
||||
description: "Extract explicitly selected artifact occurrences safely",
|
||||
args: z.object({
|
||||
path: z.string().describe("Application or package path"),
|
||||
@@ -527,9 +531,9 @@ const registerNativeCommands = (
|
||||
logger: Logger,
|
||||
): void => {
|
||||
for (const [command, tool] of [
|
||||
["inspect-macho", "inspect_macho"],
|
||||
["inspect-signature", "inspect_signature"],
|
||||
["list-architectures", "list_architectures"],
|
||||
[CLI_COMMANDS.inspectMacho, "inspect_macho"],
|
||||
[CLI_COMMANDS.inspectSignature, "inspect_signature"],
|
||||
[CLI_COMMANDS.listArchitectures, "list_architectures"],
|
||||
] as const) {
|
||||
cli.command(command, {
|
||||
description: `Run ${tool} without launching Hopper`,
|
||||
@@ -540,7 +544,7 @@ const registerNativeCommands = (
|
||||
),
|
||||
});
|
||||
}
|
||||
cli.command("inspect-plist", {
|
||||
cli.command(CLI_COMMANDS.inspectPlist, {
|
||||
description: "Parse app plist metadata without launching Hopper",
|
||||
args: z.object({ path: z.string().describe("App or Mach-O path") }),
|
||||
options: z.object({
|
||||
@@ -557,7 +561,7 @@ const registerNativeCommands = (
|
||||
),
|
||||
),
|
||||
});
|
||||
cli.command("demangle-swift", {
|
||||
cli.command(CLI_COMMANDS.demangleSwift, {
|
||||
description: "Demangle a bounded Swift symbol batch without Hopper",
|
||||
args: z.object({
|
||||
path: z.string().describe("Artifact path used for evidence identity"),
|
||||
|
||||
@@ -19,6 +19,7 @@ import {
|
||||
} from "./domain/webScreenshot.js";
|
||||
import type { JsonValue } from "./domain/jsonValue.js";
|
||||
import type { Logger } from "./logger.js";
|
||||
import { CLI_COMMANDS } from "./cliCommandNames.js";
|
||||
|
||||
const scopeOptions = {
|
||||
allowedOrigins: z.array(z.string().min(1)).optional(),
|
||||
@@ -40,7 +41,7 @@ const registerWebMcp = (
|
||||
cli: ReturnType<typeof Cli.create>,
|
||||
logger: Logger,
|
||||
): void => {
|
||||
cli.command("discover-webmcp-tools", {
|
||||
cli.command(CLI_COMMANDS.discoverWebMcpTools, {
|
||||
description: "Passively discover page-declared WebMCP tools",
|
||||
args: z.object({ endpoint: z.string(), targetId: z.string() }),
|
||||
options: z.object({
|
||||
@@ -87,7 +88,7 @@ const registerCaptureDiff = (
|
||||
cli: ReturnType<typeof Cli.create>,
|
||||
logger: Logger,
|
||||
): void => {
|
||||
cli.command("compare-web-captures", {
|
||||
cli.command(CLI_COMMANDS.compareWebCaptures, {
|
||||
description: "Compare two normalized web capture JSON values",
|
||||
args: z.object({ beforeJson: z.string(), afterJson: z.string() }),
|
||||
options: z.object({
|
||||
@@ -116,7 +117,7 @@ const registerScreenshot = (
|
||||
cli: ReturnType<typeof Cli.create>,
|
||||
logger: Logger,
|
||||
): void => {
|
||||
cli.command("capture-web-screenshot", {
|
||||
cli.command(CLI_COMMANDS.captureWebScreenshot, {
|
||||
description: "Capture an explicitly approved visible page viewport",
|
||||
args: z.object({ endpoint: z.string(), targetId: z.string() }),
|
||||
options: z.object({
|
||||
@@ -157,7 +158,7 @@ const registerScreenshotDiff = (
|
||||
cli: ReturnType<typeof Cli.create>,
|
||||
logger: Logger,
|
||||
): void => {
|
||||
cli.command("compare-web-screenshots", {
|
||||
cli.command(CLI_COMMANDS.compareWebScreenshots, {
|
||||
description: "Compare two self-verifying PNG artifact JSON values",
|
||||
args: z.object({ beforeJson: z.string(), afterJson: z.string() }),
|
||||
options: z.object({
|
||||
|
||||
@@ -19,6 +19,7 @@ import { observeWebSessionInputSchema } from "./domain/browserSession.js";
|
||||
import { AnalysisInputError, projectAnalysisError } from "./domain/errors.js";
|
||||
import type { JsonValue } from "./domain/jsonValue.js";
|
||||
import type { Logger } from "./logger.js";
|
||||
import { CLI_COMMANDS } from "./cliCommandNames.js";
|
||||
|
||||
const browserScopeOptions = {
|
||||
allowedOrigins: z
|
||||
@@ -45,7 +46,7 @@ const registerTargetList = (
|
||||
cli: ReturnType<typeof Cli.create>,
|
||||
logger: Logger,
|
||||
): void => {
|
||||
cli.command("list-browser-targets", {
|
||||
cli.command(CLI_COMMANDS.listBrowserTargets, {
|
||||
description: "List approved pages from a user-owned loopback CDP browser",
|
||||
args: z.object({
|
||||
endpoint: z.string().describe("Configured loopback CDP HTTP endpoint"),
|
||||
@@ -83,7 +84,7 @@ const registerPageInspection = (
|
||||
cli: ReturnType<typeof Cli.create>,
|
||||
logger: Logger,
|
||||
): void => {
|
||||
cli.command("inspect-web-page", {
|
||||
cli.command(CLI_COMMANDS.inspectWebPage, {
|
||||
description: "Passively inspect one approved page through CDP",
|
||||
args: z.object({
|
||||
endpoint: z.string().describe("Configured loopback CDP HTTP endpoint"),
|
||||
@@ -236,7 +237,7 @@ const registerBundleAnalysis = (
|
||||
cli: ReturnType<typeof Cli.create>,
|
||||
logger: Logger,
|
||||
): void => {
|
||||
cli.command("analyze-web-bundle", {
|
||||
cli.command(CLI_COMMANDS.analyzeWebBundle, {
|
||||
description: "Capture and statically analyze an approved page bundle",
|
||||
args: z.object({
|
||||
endpoint: z.string().describe("Configured loopback CDP HTTP endpoint"),
|
||||
@@ -312,7 +313,7 @@ const registerObservationSession = (
|
||||
cli: ReturnType<typeof Cli.create>,
|
||||
logger: Logger,
|
||||
): void => {
|
||||
cli.command("observe-web-session", {
|
||||
cli.command(CLI_COMMANDS.observeWebSession, {
|
||||
description: "Observe user-driven page navigation during a bounded window",
|
||||
args: z.object({
|
||||
endpoint: z.string().describe("Configured loopback CDP HTTP endpoint"),
|
||||
|
||||
@@ -0,0 +1,44 @@
|
||||
/** Canonical names used by every one-shot CLI command registration. */
|
||||
export const CLI_COMMANDS = Object.freeze({
|
||||
analyze: "analyze",
|
||||
inspect: "inspect",
|
||||
decompile: "decompile",
|
||||
setup: "setup",
|
||||
doctor: "doctor",
|
||||
uninstall: "uninstall",
|
||||
upgrade: "upgrade",
|
||||
xrefs: "xrefs",
|
||||
trace: "trace",
|
||||
capabilities: "capabilities",
|
||||
providers: "providers",
|
||||
function: "function",
|
||||
search: "search",
|
||||
importReferenceSource: "import-reference-source",
|
||||
inventoryArtifact: "inventory-artifact",
|
||||
extractArtifact: "extract-artifact",
|
||||
inspectMacho: "inspect-macho",
|
||||
inspectSignature: "inspect-signature",
|
||||
listArchitectures: "list-architectures",
|
||||
inspectPlist: "inspect-plist",
|
||||
demangleSwift: "demangle-swift",
|
||||
evidenceImport: "evidence-import",
|
||||
evidenceExport: "evidence-export",
|
||||
compare: "compare",
|
||||
investigateVersions: "investigate-versions",
|
||||
captureProcess: "capture-process",
|
||||
compareProcessCaptures: "compare-process-captures",
|
||||
policy: "policy",
|
||||
listBrowserTargets: "list-browser-targets",
|
||||
inspectWebPage: "inspect-web-page",
|
||||
analyzeWebBundle: "analyze-web-bundle",
|
||||
observeWebSession: "observe-web-session",
|
||||
discoverWebMcpTools: "discover-webmcp-tools",
|
||||
compareWebCaptures: "compare-web-captures",
|
||||
captureWebScreenshot: "capture-web-screenshot",
|
||||
compareWebScreenshots: "compare-web-screenshots",
|
||||
listElectronTargets: "list-electron-targets",
|
||||
inspectElectronPage: "inspect-electron-page",
|
||||
});
|
||||
|
||||
/** Ordered primary CLI inventory; aliases are intentionally excluded. */
|
||||
export const CLI_COMMAND_NAMES = Object.freeze(Object.values(CLI_COMMANDS));
|
||||
@@ -15,6 +15,7 @@ import {
|
||||
import { AnalysisInputError, projectAnalysisError } from "./domain/errors.js";
|
||||
import type { JsonValue } from "./domain/jsonValue.js";
|
||||
import type { Logger } from "./logger.js";
|
||||
import { CLI_COMMANDS } from "./cliCommandNames.js";
|
||||
|
||||
const scopeOptions = {
|
||||
allowedFileRoots: z
|
||||
@@ -29,7 +30,7 @@ export const registerElectronCommands = (
|
||||
cli: ReturnType<typeof Cli.create>,
|
||||
logger: Logger,
|
||||
): void => {
|
||||
cli.command("list-electron-targets", {
|
||||
cli.command(CLI_COMMANDS.listElectronTargets, {
|
||||
description: "List root-confined file pages from Electron CDP",
|
||||
args: z.object({ endpoint: z.string() }),
|
||||
options: z.object({
|
||||
@@ -58,7 +59,7 @@ export const registerElectronCommands = (
|
||||
return result.ok ? result.value : cliError(result.error);
|
||||
}),
|
||||
});
|
||||
cli.command("inspect-electron-page", {
|
||||
cli.command(CLI_COMMANDS.inspectElectronPage, {
|
||||
description: "Passively inspect one root-confined Electron file page",
|
||||
args: z.object({ endpoint: z.string(), targetId: z.string() }),
|
||||
options: z.object({
|
||||
|
||||
@@ -8,6 +8,7 @@ import {
|
||||
import { parseConfig } from "./config.js";
|
||||
import { logCliCommand } from "./cliLogging.js";
|
||||
import type { Logger } from "./logger.js";
|
||||
import { CLI_COMMANDS } from "./cliCommandNames.js";
|
||||
import type { JsonValue } from "./domain/jsonValue.js";
|
||||
import {
|
||||
AnalysisProtocolError,
|
||||
@@ -23,7 +24,7 @@ export const registerEvidenceCommands = (
|
||||
cli: ReturnType<typeof Cli.create>,
|
||||
logger: Logger,
|
||||
): void => {
|
||||
cli.command("evidence-import", {
|
||||
cli.command(CLI_COMMANDS.evidenceImport, {
|
||||
description: "Validate and import a bounded local Evidence v2 bundle",
|
||||
args: z.object({
|
||||
path: z.string().describe("Evidence bundle JSON path"),
|
||||
@@ -43,7 +44,7 @@ export const registerEvidenceCommands = (
|
||||
return imported.ok ? imported.value : cliError(imported.error);
|
||||
}),
|
||||
});
|
||||
cli.command("evidence-export", {
|
||||
cli.command(CLI_COMMANDS.evidenceExport, {
|
||||
description: "Validate and atomically export canonical Evidence v2 JSON",
|
||||
args: z.object({
|
||||
source: z.string().describe("Existing evidence bundle JSON path"),
|
||||
@@ -70,7 +71,7 @@ export const registerEvidenceCommands = (
|
||||
return exported.ok ? exported.value : cliError(exported.error);
|
||||
}),
|
||||
});
|
||||
cli.command("compare", {
|
||||
cli.command(CLI_COMMANDS.compare, {
|
||||
aliases: ["compare-bundles"],
|
||||
description: "Compare two canonical Evidence v2 bundles",
|
||||
args: z.object({
|
||||
|
||||
@@ -10,6 +10,7 @@ import {
|
||||
authorizeFileReadWithDeferredWrite,
|
||||
authorizeRootPermission,
|
||||
} from "./application/DeferredFileAuthorization.js";
|
||||
import { CLI_COMMANDS } from "./cliCommandNames.js";
|
||||
|
||||
const investigationOptionsSchema = z.object({
|
||||
yes: z
|
||||
@@ -48,7 +49,7 @@ export const registerInvestigationCommands = (
|
||||
cli: ReturnType<typeof Cli.create>,
|
||||
logger: Logger,
|
||||
): void => {
|
||||
cli.command("investigate-versions", {
|
||||
cli.command(CLI_COMMANDS.investigateVersions, {
|
||||
description:
|
||||
"Run or resume a persistent cross-version artifact investigation",
|
||||
args: z.object({
|
||||
|
||||
@@ -14,6 +14,7 @@ import {
|
||||
} from "./domain/errors.js";
|
||||
import type { PermissionCapability } from "./domain/permissionPolicy.js";
|
||||
import type { Logger } from "./logger.js";
|
||||
import { CLI_COMMANDS } from "./cliCommandNames.js";
|
||||
|
||||
const capabilitySchema = z.enum([
|
||||
"process_capture",
|
||||
@@ -54,7 +55,7 @@ export const registerPolicyCommands = (
|
||||
cli: ReturnType<typeof Cli.create>,
|
||||
logger: Logger,
|
||||
): void => {
|
||||
cli.command("policy", {
|
||||
cli.command(CLI_COMMANDS.policy, {
|
||||
description: "Inspect, explain, or revoke unified local permission grants",
|
||||
args: z.object({
|
||||
action: z.enum(["status", "list", "explain", "revoke"]),
|
||||
|
||||
@@ -6,13 +6,14 @@ import {
|
||||
} from "./application/ProcessCli.js";
|
||||
import { logCliCommand } from "./cliLogging.js";
|
||||
import type { Logger } from "./logger.js";
|
||||
import { CLI_COMMANDS } from "./cliCommandNames.js";
|
||||
|
||||
/** Register Process Capture v4 one-shot commands through shared application services. */
|
||||
export const registerProcessCommands = (
|
||||
cli: ReturnType<typeof Cli.create>,
|
||||
logger: Logger,
|
||||
): void => {
|
||||
cli.command("capture-process", {
|
||||
cli.command(CLI_COMMANDS.captureProcess, {
|
||||
description: "Capture one approved Process Capture v4 JSON scenario",
|
||||
args: z.object({ scenario: z.string().describe("Scenario JSON path") }),
|
||||
run: ({ args }) =>
|
||||
@@ -20,7 +21,7 @@ export const registerProcessCommands = (
|
||||
captureProcessScenarioFile(args.scenario),
|
||||
),
|
||||
});
|
||||
cli.command("compare-process-captures", {
|
||||
cli.command(CLI_COMMANDS.compareProcessCaptures, {
|
||||
description: "Compare two Process Capture v4 Evidence JSON files",
|
||||
args: z.object({
|
||||
left: z.string().describe("Left capture Evidence JSON path"),
|
||||
|
||||
@@ -76,7 +76,7 @@ const entrySchema = z.object({
|
||||
});
|
||||
|
||||
/** Provider-neutral, deterministic cache of successful immutable analysis calls. */
|
||||
const analysisSnapshotSchema = z.object({
|
||||
export const analysisSnapshotSchema = z.object({
|
||||
snapshot_version: z.literal(1),
|
||||
target: targetSchema,
|
||||
entries: z.array(entrySchema).max(10_000),
|
||||
|
||||
@@ -161,7 +161,8 @@ export const investigationRunSummarySchema = z.object({
|
||||
limitations: z.array(z.string().max(4_096)).max(100),
|
||||
});
|
||||
|
||||
const investigationWorkspaceSchema = z.object({
|
||||
/** Durable schema for one revisioned cross-version investigation workspace. */
|
||||
export const investigationWorkspaceSchema = z.object({
|
||||
workspace_version: z.literal(1),
|
||||
workspace_id: z.string().regex(/^ws_[a-f0-9]{64}$/u),
|
||||
name: z.string().trim().min(1).max(200),
|
||||
|
||||
@@ -19,11 +19,13 @@ import {
|
||||
import { HopperApplicationLauncher } from "./BridgeLauncher.js";
|
||||
import { HopperClient } from "./HopperClient.js";
|
||||
|
||||
const IDENTITY: ProviderIdentity = Object.freeze({
|
||||
/** Public identity committed by every Hopper-backed observation. */
|
||||
export const HOPPER_PROVIDER_IDENTITY: ProviderIdentity = Object.freeze({
|
||||
id: "hopper",
|
||||
name: "Hopper Disassembler",
|
||||
version: null,
|
||||
});
|
||||
const IDENTITY = HOPPER_PROVIDER_IDENTITY;
|
||||
const MUTATING_OPERATIONS = new Set([
|
||||
"set_address_name",
|
||||
"set_addresses_names",
|
||||
@@ -33,15 +35,16 @@ const MUTATING_OPERATIONS = new Set([
|
||||
"unset_bookmark",
|
||||
]);
|
||||
|
||||
const PROVIDER_TOOL_CONTRACTS = [
|
||||
/** Tool contracts implemented directly by the Hopper adapter. */
|
||||
export const HOPPER_PROVIDER_TOOL_CONTRACTS = Object.freeze([
|
||||
...OFFICIAL_TOOL_CONTRACTS,
|
||||
...ENHANCED_TOOL_CONTRACTS.filter(
|
||||
(contract) => contract.name === "analyze_function",
|
||||
),
|
||||
];
|
||||
]);
|
||||
|
||||
const CAPABILITIES: readonly CapabilityDescriptor[] = Object.freeze(
|
||||
PROVIDER_TOOL_CONTRACTS.map((contract) =>
|
||||
HOPPER_PROVIDER_TOOL_CONTRACTS.map((contract) =>
|
||||
Object.freeze({
|
||||
provider: IDENTITY,
|
||||
operation: contract.name,
|
||||
|
||||
@@ -50,11 +50,13 @@ import {
|
||||
inspectNativeMacho,
|
||||
} from "./NativeMachoInspection.js";
|
||||
|
||||
const IDENTITY: ProviderIdentity = Object.freeze({
|
||||
/** Public identity committed by macOS-native inspection observations. */
|
||||
export const NATIVE_MACOS_PROVIDER_IDENTITY: ProviderIdentity = Object.freeze({
|
||||
id: "native-macos",
|
||||
name: "macOS native inspection utilities",
|
||||
version: null,
|
||||
});
|
||||
const IDENTITY = NATIVE_MACOS_PROVIDER_IDENTITY;
|
||||
const TIMEOUT_MS = 30_000;
|
||||
const OUTPUT_LIMIT = 4 * 1024 * 1024;
|
||||
|
||||
|
||||
Reference in New Issue
Block a user