Skip to content

client:codex

FieldValue
Prefixclient:codex
Namespace constantcodex
Kindclient
Schema record<inline>
Tierframework
Package@makaio/client-codex
Defined inclients/codex/src/runtime/namespace.ts
KeyWireTypeSchema
config.hooks.addclient:codex.config.hooks.addrpcconfig.ts
config.hooks.listclient:codex.config.hooks.listrpcconfig.ts
config.hooks.removeclient:codex.config.hooks.removerpcconfig.ts
wiring.applyclient:codex.wiring.applyrpcwiring.ts
wiring.listclient:codex.wiring.listrpcwiring.ts
wiring.removeclient:codex.wiring.removerpcwiring.ts

Add a new hook entry to a config scope.

Subject: client:codex.config.hooks.add Type: Request (RPC)

Request:

FieldTypeRequired
commandstringyes
eventstringyes
matcherstring | undefinedno
projectDirstring | undefinedno
scope"global" | "project"yes
timeoutnumber | undefinedno

Response:

FieldTypeRequired
addedbooleanyes

List effective hook configuration for a project directory.

Merges global and project-scoped hooks and returns both the effective list and the per-scope breakdown.

Subject: client:codex.config.hooks.list Type: Request (RPC)

Request:

FieldTypeRequired
eventNamestring | undefinedno
projectDirstring | undefinedno

Response:

FieldTypeRequired
effective{ event: string; command: string; matcher?: string | undefined; timeout?: number | undefined; }[]yes
perScope{ scope: "global" | "project"; path: string; writable: boolean; hooks: { event: string; command: string; matcher?: string | undefined; timeout?: number | undefined; }[]; }[]yes

Remove hook entries matching an event and command substring from a scope.

Subject: client:codex.config.hooks.remove Type: Request (RPC)

Request:

FieldTypeRequired
eventstringyes
match{ commandContains: string; }yes
projectDirstring | undefinedno
scope"global" | "project"yes

Response:

FieldTypeRequired
removednumberyes

Install all wiring entries into the specified scope.

Entries already present are skipped (idempotent). The makaioCommand string is written verbatim as the shell command for hook entries.

Subject: client:codex.wiring.apply Type: Request (RPC)

Request:

FieldTypeRequired
makaioCommandstringyes
projectDirstring | undefinedno
scope"global" | "project"yes

Response:

FieldTypeRequired
appliednumberyes
skippednumberyes

List all known wiring entries for the target scope, indicating which are currently installed in the Codex native config.

When projectDir is absent, only the global scope entries are reported. Callers that need project-scope entries must supply the absolute path to the project root.

Subject: client:codex.wiring.list Type: Request (RPC)

Request:

FieldTypeRequired
makaioCommandstringyes
projectDirstring | undefinedno

Response:

FieldTypeRequired
entries{ group: string; name: string; installed: boolean; command: string; }[]yes

Uninstall all wiring entries from the specified scope.

Entries that are not present are silently ignored (idempotent). The removed count in the response reflects only entries that were actually deleted from the config file.

Subject: client:codex.wiring.remove Type: Request (RPC)

Request:

FieldTypeRequired
projectDirstring | undefinedno
scope"global" | "project"yes

Response:

FieldTypeRequired
removednumberyes

Auto-generated by yarn docs:bus. Do not edit manually.