client:codex
client:codex
Section titled “client:codex”| Field | Value |
|---|---|
| Prefix | client:codex |
| Namespace constant | codex |
| Kind | client |
| Schema record | <inline> |
| Tier | framework |
| Package | @makaio/client-codex |
| Defined in | clients/codex/src/runtime/namespace.ts |
Subjects
Section titled “Subjects”| Key | Wire | Type | Schema |
|---|---|---|---|
config.hooks.add | client:codex.config.hooks.add | rpc | config.ts |
config.hooks.list | client:codex.config.hooks.list | rpc | config.ts |
config.hooks.remove | client:codex.config.hooks.remove | rpc | config.ts |
wiring.apply | client:codex.wiring.apply | rpc | wiring.ts |
wiring.list | client:codex.wiring.list | rpc | wiring.ts |
wiring.remove | client:codex.wiring.remove | rpc | wiring.ts |
Subject Details
Section titled “Subject Details”client:codex.config.hooks.add (rpc)
Section titled “client:codex.config.hooks.add (rpc)”Add a new hook entry to a config scope.
Subject: client:codex.config.hooks.add
Type: Request (RPC)
Request:
| Field | Type | Required |
|---|---|---|
command | string | yes |
event | string | yes |
matcher | string | undefined | no |
projectDir | string | undefined | no |
scope | "global" | "project" | yes |
timeout | number | undefined | no |
Response:
| Field | Type | Required |
|---|---|---|
added | boolean | yes |
client:codex.config.hooks.list (rpc)
Section titled “client:codex.config.hooks.list (rpc)”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:
| Field | Type | Required |
|---|---|---|
eventName | string | undefined | no |
projectDir | string | undefined | no |
Response:
| Field | Type | Required |
|---|---|---|
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 |
client:codex.config.hooks.remove (rpc)
Section titled “client:codex.config.hooks.remove (rpc)”Remove hook entries matching an event and command substring from a scope.
Subject: client:codex.config.hooks.remove
Type: Request (RPC)
Request:
| Field | Type | Required |
|---|---|---|
event | string | yes |
match | { commandContains: string; } | yes |
projectDir | string | undefined | no |
scope | "global" | "project" | yes |
Response:
| Field | Type | Required |
|---|---|---|
removed | number | yes |
client:codex.wiring.apply (rpc)
Section titled “client:codex.wiring.apply (rpc)”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:
| Field | Type | Required |
|---|---|---|
makaioCommand | string | yes |
projectDir | string | undefined | no |
scope | "global" | "project" | yes |
Response:
| Field | Type | Required |
|---|---|---|
applied | number | yes |
skipped | number | yes |
client:codex.wiring.list (rpc)
Section titled “client:codex.wiring.list (rpc)”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:
| Field | Type | Required |
|---|---|---|
makaioCommand | string | yes |
projectDir | string | undefined | no |
Response:
| Field | Type | Required |
|---|---|---|
entries | { group: string; name: string; installed: boolean; command: string; }[] | yes |
client:codex.wiring.remove (rpc)
Section titled “client:codex.wiring.remove (rpc)”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:
| Field | Type | Required |
|---|---|---|
projectDir | string | undefined | no |
scope | "global" | "project" | yes |
Response:
| Field | Type | Required |
|---|---|---|
removed | number | yes |
Auto-generated by yarn docs:bus. Do not edit manually.