Class GhidraClient

Owns one authenticated, private, read-only Ghidra headless session.

Index

Constructors

Methods

close diagnostics ping start

Constructors

constructor

new GhidraClient(options: GhidraClientOptions): GhidraClient
Parameters
- options: GhidraClientOptions
Returns GhidraClient
- Defined in src/ghidra/GhidraClient.ts:96

Methods

close

close(): Promise<void>
Stop the owned process group and remove all project/runtime artifacts.

Returns Promise<void>
- Defined in src/ghidra/GhidraClient.ts:147

diagnostics

diagnostics(): Readonly<Record<string, JsonValue>>
Latest bounded local diagnostics, with bearer material redacted.

Returns Readonly<Record<string, JsonValue>>
- Defined in src/ghidra/GhidraClient.ts:158

ping

ping(
    options?: { signal?: AbortSignal; timeoutMs?: number },
): Promise<
    Result<
        {
            analysis_complete: boolean;
            analysis_timed_out: boolean;
            bridge_version: 1;
            capabilities: ("shutdown" | "ping")[];
            name: "REA Ghidra bridge";
            profile_digest: string;
            provider: { id: "ghidra"; version: string };
            read_only: true;
            run_id: string;
            target: { compiler_spec_id: string; language_id: string; name: string };
        },
        GhidraSessionError,
    >,
>
Revalidate live bridge, provider, run, and profile metadata.
Parameters
- options: { signal?: AbortSignal; timeoutMs?: number } = {}
Returns Promise<
    Result<
        {
            analysis_complete: boolean;
            analysis_timed_out: boolean;
            bridge_version: 1;
            capabilities: ("shutdown" | "ping")[];
            name: "REA Ghidra bridge";
            profile_digest: string;
            provider: { id: "ghidra"; version: string };
            read_only: true;
            run_id: string;
            target: { compiler_spec_id: string; language_id: string; name: string };
        },
        GhidraSessionError,
    >,
>
- Defined in src/ghidra/GhidraClient.ts:133

start

start(signal?: AbortSignal): Promise<GhidraStartResult>
Launch Ghidra once and require its exact post-analysis handshake.
Parameters
- Optionalsignal: AbortSignal
Returns Promise<GhidraStartResult>
- Defined in src/ghidra/GhidraClient.ts:106