Files
openclaw/src/cli/program/route-args.ts
Peter Steinberger 0b8aabe864 docs: document auth profile failure policy contract (#89613)
* docs: document markdown marker renderer

* docs: document rendered markdown chunking

* docs: document markdown text chunking

* docs: document shared text chunking

* docs: document plugin text chunking exports

* docs: document avatar policy constants

* docs: document node match candidates

* docs: document scoped expiring id cache

* docs: document runtime import normalization

* docs: document string sample summaries

* docs: document session usage timeseries types

* docs: document session usage response types

* docs: document manifest frontmatter shapes

* docs: document channel route input metadata

* docs: document pair loop guard settings

* docs: document migration config patch helpers

* docs: document api provider registry

* docs: document tool call repair payloads

* docs: document plugin tool payload helpers

* docs: document lazy promise loader

* docs: document store writer queue state

* docs: document thread binding lifecycle

* docs: document concurrency helper contract

* docs: document gateway client info contract

* docs: document delivery context contracts

* docs: document secret ref defaults contract

* docs: document command gating contract

* docs: document avatar policy contract

* docs: document node match policy

* docs: document message channel normalization

* docs: document boolean parsing contract

* docs: document zod parse helpers

* docs: document direct dm guard policy

* docs: document fixed window limiter contract

* docs: document node presence event contract

* docs: document secret normalization contract

* docs: document progress draft line removal

* docs: document usage formatting contracts

* docs: document agent run status contract

* docs: document runtime import helpers

* docs: document provider utility ownership

* docs: document invalid config helpers

* docs: document json compat parser

* docs: document channel config metadata ownership

* docs: document channel logging helpers

* docs: document sender identity validation ownership

* docs: document string sampling helper

* docs: document global singleton helpers

* docs: document transcript tool helpers

* docs: document exec safe-bin normalization

* docs: document reaction level resolver

* docs: document account snapshot redaction boundary

* docs: document messaging target helpers

* docs: document thread binding messages

* docs: document conversation binding context

* docs: document conversation resolution helper

* docs: document owner display secret retention

* docs: document provider request config types

* docs: document skills config types

* docs: document memory config types

* docs: document imessage config types

* docs: document crestodian config types

* docs: document tools config policies

* docs: document shared config base types

* docs: document channel config contracts

* docs: document openclaw config state types

* docs: document model config contracts

* docs: document shared agent config types

* docs: document agent defaults config types

* docs: document secret input contracts

* docs: document auth config contracts

* docs: document gateway config contracts

* docs: document tool call stream repair contracts

* docs: document memory host facades

* docs: document llm core contracts

* docs: document markdown core contracts

* docs: document gateway connect error contracts

* docs: document gateway protocol primitives

* docs: document gateway frame schemas

* docs: document gateway device schemas

* docs: document gateway environment schemas

* docs: document gateway push schemas

* docs: document gateway plugin schemas

* docs: document gateway artifact schemas

* docs: document gateway command schemas

* docs: document gateway task schemas

* docs: document gateway exec approval schemas

* docs: document gateway secret schemas

* docs: document gateway config schemas

* docs: document gateway snapshot schemas

* docs: document gateway chat schemas

* docs: document gateway wizard schemas

* docs: document gateway node schemas

* docs: document gateway plugin approval schemas

* docs: document gateway talk schemas

* docs: document gateway agent schemas

* docs: document gateway session schemas

* docs: document gateway cron schemas

* docs: document gateway agent model skill schemas

* docs: document gateway skill proposal tool schemas

* docs: document gateway protocol registry

* docs: document gateway channel status schemas

* docs: document gateway schema regression tests

* docs: document gateway schema barrel

* docs: document gateway validator tests

* docs: document gateway primitive push tests

* docs: document gateway contract tests

* docs: document native protocol guard

* docs: document channel schema tests

* docs: document gateway protocol smoke tests

* docs: document gateway protocol entrypoint

* docs: document gateway protocol type exports

* docs: document gateway error codes

* docs: document protocol schema registry

* docs: document talk audio codec

* docs: document talk activation names

* docs: document talk consult questions

* docs: document talk consult tool

* docs: document talk run control contracts

* docs: document talk run control adapter

* docs: document talkback consult queue

* docs: document talk consult transcript guard

* docs: document talk fast context runtime

* docs: document forced talk consult coordinator

* docs: document talk output activity tracker

* docs: document talk event metrics

* docs: document talk diagnostics

* docs: document talk observability hook

* docs: document talk provider resolver

* docs: document talk provider registry

* docs: document talk runtime primitives

* docs: document talk consult controller logs

* docs: document channel identity helpers

* docs: document channel account allowlist helpers

* docs: document channel metadata draft controls

* docs: document channel ingress policy

* docs: document channel sender access gates

* docs: document channel catalog message contracts

* docs: document channel account plugin helpers

* docs: document configured binding helpers

* docs: document channel acp approval config helpers

* docs: document channel bundled config write helpers

* docs: document channel plugin utility contracts

* docs: document channel config access helpers

* docs: document channel message action helpers

* docs: document channel outbound runtime helpers

* docs: document channel pairing promotion helpers

* docs: document channel registry helpers

* docs: document channel setup wizard helpers

* docs: document channel lifecycle status helpers

* docs: document channel target thread helpers

* docs: document channel session binding helpers

* docs: document channel package module probes

* docs: document channel setup wizard contracts

* docs: document channel plugin API barrels

* docs: document channel contract test helpers

* docs: document channel core helpers

* docs: document small core facades

* docs: document provider runtime helpers

* docs: document persistence and realtime helpers

* docs: document mcp and state helpers

* docs: document tool planner contracts

* docs: document music generation runtime

* docs: document crestodian command flow

* docs: document utility helpers

* docs: document node host helpers

* docs: document transcript contracts

* docs: document trajectory export contracts

* docs: document image generation contracts

* docs: document routing helper contracts

* docs: document session helper contracts

* docs: document video generation contracts

* docs: document model catalog contracts

* docs: document proxy capture contracts

* docs: document status rendering contracts

* docs: document test helper contracts

* docs: document wizard setup contracts

* docs: document process contracts

* docs: document memory host sdk contracts

* docs: document tts contracts

* docs: document secrets runtime contracts

* docs: document shared helper contracts

* docs: document hook runtime contracts

* docs: document security audit contracts

* docs: document flow contracts

* docs: document media understanding contracts

* docs: document tui contracts

* docs: document logging contracts

* docs: document llm contracts

* docs: document cron contracts

* docs: document daemon contracts

* docs: document task contracts

* docs: document acp contracts

* docs: document test utility contracts

* docs: document skill contracts

* docs: document config contracts

* docs: document outbound infra contracts

* docs: document command analysis contracts

* docs: document provider usage infra contracts

* docs: document file safety infra contracts

* docs: document exec approval infra contracts

* docs: document gateway runtime infra contracts

* docs: document infra utility contracts

* docs: document infra queue storage contracts

* docs: document heartbeat infra contracts

* docs: document remaining infra contracts

* docs: document gateway auth contracts

* docs: document gateway display helpers

* docs: document gateway http helpers

* docs: document gateway node helpers

* docs: document gateway mcp helpers

* docs: document gateway support helpers

* docs: document gateway server runtime helpers

* docs: document gateway runtime bootstrap helpers

* docs: document gateway session events

* docs: document gateway utility helpers

* docs: document gateway talk helpers

* docs: document gateway helper contracts

* docs: document gateway server method helpers

* docs: document gateway server auth helpers

* docs: document gateway server tests

* docs: document gateway test helpers

* docs: document gateway node tests

* docs: document gateway channel tests

* docs: document gateway session tests

* docs: document gateway server startup tests

* docs: document gateway tool test helpers

* docs: document gateway server test helpers

* docs: document gateway server method tests

* docs: document remaining gateway tests

* docs: document plugin sdk public subpaths

* docs: document plugin sdk runtime helpers

* docs: document plugin sdk memory provider helpers

* docs: document plugin sdk runtime facades

* docs: document plugin sdk command approval helpers

* docs: document plugin sdk runtime types

* docs: document plugin sdk browser account helpers

* docs: document plugin sdk media memory helpers

* docs: document plugin sdk core tests

* docs: document plugin sdk contract helpers

* docs: document plugin sdk test helpers

* docs: document remaining plugin sdk tests

* docs: document cli utility helpers

* docs: document cli runtime helpers

* docs: document cli command registration helpers

* docs: document node cli helpers

* docs: document cli program registration

* docs: document message cli registration

* docs: document daemon cli helpers

* docs: document cli route parsers
2026-06-03 15:20:39 -07:00

388 lines
10 KiB
TypeScript

// Route-first argv parsers for commands that can skip full Commander startup.
import { isValueToken } from "../../infra/cli-root-options.js";
import {
getCommandPositionalsWithRootOptions,
getFlagValue,
getPositiveIntFlagValue,
getVerboseFlag,
hasFlag,
} from "../argv.js";
import { parseStrictPositiveIntOrUndefined } from "./helpers.js";
type OptionalFlagParse = {
ok: boolean;
value?: string;
};
function parseOptionalFlagValue(argv: string[], name: string): OptionalFlagParse {
const value = getFlagValue(argv, name);
if (value === null) {
return { ok: false };
}
return { ok: true, value };
}
function parseRepeatedFlagValues(argv: string[], name: string): string[] | null {
const values: string[] = [];
const args = argv.slice(2);
for (let i = 0; i < args.length; i += 1) {
const arg = args[i];
if (!arg || arg === "--") {
break;
}
if (arg === name) {
const next = args[i + 1];
if (!isValueToken(next)) {
// Invalid fast-path shapes fall back to Commander so its normal errors and help text win.
return null;
}
values.push(next);
i += 1;
continue;
}
if (arg.startsWith(`${name}=`)) {
const value = arg.slice(name.length + 1).trim();
if (!value) {
return null;
}
values.push(value);
}
}
return values;
}
function parseSinglePositional(
argv: string[],
params: {
commandPath: string[];
booleanFlags?: string[];
},
): string | null {
const positionals = getCommandPositionalsWithRootOptions(argv, params);
if (!positionals || positionals.length !== 1) {
return null;
}
return positionals[0] ?? null;
}
/** Parse `openclaw health` flags for the route-first status family. */
export function parseHealthRouteArgs(argv: string[]) {
const timeoutMs = getPositiveIntFlagValue(argv, "--timeout");
if (timeoutMs === null) {
return null;
}
return {
json: hasFlag(argv, "--json"),
verbose: getVerboseFlag(argv, { includeDebug: true }),
timeoutMs,
};
}
/** Parse `openclaw status` flags without registering the full command tree. */
export function parseStatusRouteArgs(argv: string[]) {
const timeoutMs = getPositiveIntFlagValue(argv, "--timeout");
if (timeoutMs === null) {
return null;
}
return {
json: hasFlag(argv, "--json"),
deep: hasFlag(argv, "--deep"),
all: hasFlag(argv, "--all"),
usage: hasFlag(argv, "--usage"),
verbose: getVerboseFlag(argv, { includeDebug: true }),
timeoutMs,
};
}
/** Parse `openclaw gateway status` RPC-only flags accepted by the fast route. */
export function parseGatewayStatusRouteArgs(argv: string[]) {
const url = parseOptionalFlagValue(argv, "--url");
if (!url.ok) {
return null;
}
const token = parseOptionalFlagValue(argv, "--token");
if (!token.ok) {
return null;
}
const password = parseOptionalFlagValue(argv, "--password");
if (!password.ok) {
return null;
}
const timeout = parseOptionalFlagValue(argv, "--timeout");
if (!timeout.ok) {
return null;
}
const ssh = parseOptionalFlagValue(argv, "--ssh");
if (!ssh.ok || ssh.value !== undefined) {
// SSH probe options need the full command because they resolve host aliases and identity files.
return null;
}
const sshIdentity = parseOptionalFlagValue(argv, "--ssh-identity");
if (!sshIdentity.ok || sshIdentity.value !== undefined) {
return null;
}
if (hasFlag(argv, "--ssh-auto")) {
return null;
}
return {
rpc: {
url: url.value,
token: token.value,
password: password.value,
timeout: timeout.value,
},
deep: hasFlag(argv, "--deep"),
json: hasFlag(argv, "--json"),
requireRpc: hasFlag(argv, "--require-rpc"),
probe: !hasFlag(argv, "--no-probe"),
};
}
/** Parse `openclaw sessions` filters for JSON/list route execution. */
export function parseSessionsRouteArgs(argv: string[]) {
const agent = parseOptionalFlagValue(argv, "--agent");
if (!agent.ok) {
return null;
}
const store = parseOptionalFlagValue(argv, "--store");
if (!store.ok) {
return null;
}
const active = parseOptionalFlagValue(argv, "--active");
if (!active.ok) {
return null;
}
const limit = parseOptionalFlagValue(argv, "--limit");
if (!limit.ok) {
return null;
}
return {
json: hasFlag(argv, "--json"),
allAgents: hasFlag(argv, "--all-agents"),
agent: agent.value,
store: store.value,
active: active.value,
limit: limit.value,
};
}
/** Parse `openclaw agents list` display switches for route-first execution. */
export function parseAgentsListRouteArgs(argv: string[]) {
return {
json: hasFlag(argv, "--json"),
bindings: hasFlag(argv, "--bindings"),
};
}
/** Parse `openclaw config get <path>` while preserving root option handling. */
export function parseConfigGetRouteArgs(argv: string[]) {
const path = parseSinglePositional(argv, {
commandPath: ["config", "get"],
booleanFlags: ["--json"],
});
if (!path) {
return null;
}
return {
path,
json: hasFlag(argv, "--json"),
};
}
/** Parse `openclaw config unset <path>` and its mutation guard flags. */
export function parseConfigUnsetRouteArgs(argv: string[]) {
const path = parseSinglePositional(argv, {
commandPath: ["config", "unset"],
booleanFlags: ["--dry-run", "--allow-exec", "--json"],
});
if (!path) {
return null;
}
return {
path,
cliOptions: {
dryRun: hasFlag(argv, "--dry-run"),
allowExec: hasFlag(argv, "--allow-exec"),
json: hasFlag(argv, "--json"),
},
};
}
/** Parse `openclaw models list` filters for the lightweight model catalog route. */
export function parseModelsListRouteArgs(argv: string[]) {
const provider = parseOptionalFlagValue(argv, "--provider");
if (!provider.ok) {
return null;
}
return {
provider: provider.value,
all: hasFlag(argv, "--all"),
local: hasFlag(argv, "--local"),
json: hasFlag(argv, "--json"),
plain: hasFlag(argv, "--plain"),
};
}
/** Parse `openclaw models status` probe controls for the route-first status path. */
export function parseModelsStatusRouteArgs(argv: string[]) {
const probeProvider = parseOptionalFlagValue(argv, "--probe-provider");
if (!probeProvider.ok) {
return null;
}
const probeTimeout = parseOptionalFlagValue(argv, "--probe-timeout");
if (!probeTimeout.ok) {
return null;
}
const probeConcurrency = parseOptionalFlagValue(argv, "--probe-concurrency");
if (!probeConcurrency.ok) {
return null;
}
const probeMaxTokens = parseOptionalFlagValue(argv, "--probe-max-tokens");
if (!probeMaxTokens.ok) {
return null;
}
const agent = parseOptionalFlagValue(argv, "--agent");
if (!agent.ok) {
return null;
}
const probeProfileValues = parseRepeatedFlagValues(argv, "--probe-profile");
if (probeProfileValues === null) {
return null;
}
const probeProfile =
probeProfileValues.length === 0
? undefined
: probeProfileValues.length === 1
? probeProfileValues[0]
: probeProfileValues;
return {
probeProvider: probeProvider.value,
probeTimeout: probeTimeout.value,
probeConcurrency: probeConcurrency.value,
probeMaxTokens: probeMaxTokens.value,
agent: agent.value,
probeProfile,
json: hasFlag(argv, "--json"),
plain: hasFlag(argv, "--plain"),
check: hasFlag(argv, "--check"),
probe: hasFlag(argv, "--probe"),
};
}
/** Parse `openclaw channels list` display flags for the route-first list path. */
export function parseChannelsListRouteArgs(argv: string[]) {
return {
json: hasFlag(argv, "--json"),
all: hasFlag(argv, "--all"),
};
}
/** Parse `openclaw channels status` probe flags without full CLI registration. */
export function parseChannelsStatusRouteArgs(argv: string[]) {
const timeout = parseOptionalFlagValue(argv, "--timeout");
const channel = parseOptionalFlagValue(argv, "--channel");
if (!timeout.ok) {
return null;
}
if (!channel.ok) {
return null;
}
return {
channel: channel.value,
json: hasFlag(argv, "--json"),
probe: hasFlag(argv, "--probe"),
timeout: timeout.value,
};
}
/** Parse JSON-only `openclaw plugins list` flags for plugin inventory output. */
export function parsePluginsListRouteArgs(argv: string[]) {
if (!hasFlag(argv, "--json")) {
return null;
}
const positionals = getCommandPositionalsWithRootOptions(argv, {
commandPath: ["plugins", "list"],
booleanFlags: ["--json", "--enabled", "--verbose"],
});
if (!positionals || positionals.length !== 0) {
return null;
}
return {
json: true as const,
enabled: hasFlag(argv, "--enabled"),
verbose: hasFlag(argv, "--verbose"),
};
}
function parseTasksListRouteArgsForCommandPath(argv: string[], commandPath: string[]) {
if (!hasFlag(argv, "--json")) {
return null;
}
const positionals = getCommandPositionalsWithRootOptions(argv, {
commandPath,
booleanFlags: ["--json"],
valueFlags: ["--runtime", "--status"],
});
if (!positionals || positionals.length !== 0) {
return null;
}
const runtime = parseOptionalFlagValue(argv, "--runtime");
if (!runtime.ok) {
return null;
}
const status = parseOptionalFlagValue(argv, "--status");
if (!status.ok) {
return null;
}
return {
json: true as const,
runtime: runtime.value,
status: status.value,
};
}
/** Parse both `openclaw tasks --json` and `openclaw tasks list --json` aliases. */
export function parseTasksListRouteArgs(argv: string[]) {
return (
parseTasksListRouteArgsForCommandPath(argv, ["tasks"]) ??
parseTasksListRouteArgsForCommandPath(argv, ["tasks", "list"])
);
}
/** Parse JSON-only `openclaw tasks audit` filters for the route-first audit path. */
export function parseTasksAuditRouteArgs(argv: string[]) {
if (!hasFlag(argv, "--json")) {
return null;
}
const positionals = getCommandPositionalsWithRootOptions(argv, {
commandPath: ["tasks", "audit"],
booleanFlags: ["--json"],
valueFlags: ["--severity", "--code", "--limit"],
});
if (!positionals || positionals.length !== 0) {
return null;
}
const severity = parseOptionalFlagValue(argv, "--severity");
if (!severity.ok) {
return null;
}
const code = parseOptionalFlagValue(argv, "--code");
if (!code.ok) {
return null;
}
const rawLimit = getFlagValue(argv, "--limit");
if (rawLimit === null) {
return null;
}
const limit = rawLimit === undefined ? undefined : parseStrictPositiveIntOrUndefined(rawLimit);
if (rawLimit !== undefined && limit === undefined) {
return null;
}
return {
json: true as const,
severity: severity.value,
code: code.value,
limit,
};
}