AgentKit
ReferenceCLI commands
BetaYou are reading docs for the beta channel (2.4.1-beta.1) — updated automatically on every beta release.Switch to stable →

CLI commands

ak codex-agent-runtime unregister

Idempotently remove ak-agent-runtime from ~/.codex/config.toml.

Removes the AgentKit-managed [mcp_servers.ak-agent-runtime] entry, leaving every other entry under [mcp_servers.*] intact. A missing entry is not an error: exits 0 with Changed=false.

Who it's for: Power devs removing or reconfiguring the Codex adapter for AgentKit.

When to use it: When you want to stop Codex from auto-loading the AgentKit MCP runtime, or before switching to a different MCP server configuration.

What changes on disk: Writes ~/.codex/config.toml (CODEX_HOME or --codex-home overrides the base dir). Idempotent: a missing entry exits 0 unchanged.

Usage

ak codex-agent-runtime unregister [flags]

Examples

ak codex-agent-runtime unregister                          # remove from ~/.codex/config.toml
ak codex-agent-runtime unregister --codex-home ~/.codex   # explicit config dir
ak codex-agent-runtime unregister --json                   # machine-readable result

Flags

FlagDescription
--codex-home stringOverride $CODEX_HOME (defaults to ~/.codex)
-h, --helphelp for unregister
--jsonEmit machine-readable JSON (implies --no-interactive)
--no-interactiveDisable interactive prompts (CI-safe)
-q, --quietSuppress non-error output on stderr
-V, --verboseExtra diagnostic output on stderr (loses to --quiet)
-y, --yesAssume yes for all prompts

Output modes

ModeBehavior
prettydefault on TTY (colors, ASCII markers)
plainauto when stdout piped or --no-interactive
json--json (single-object envelope, NDJSON-safe)

Exit codes

CodeMeaning
0success
1runtime error
2invalid flags
3user-cancel (SIGINT, prompt-cancel)
5config file could not be read or written

On this page