ReferenceCLI reference
noodle assistant
Configure and validate the customer-branded embedded assistant boundary.
Configure and validate the customer-branded embedded assistant boundary.
Usage
noodle assistant doctor|appearance|clients|embeds|budget|sponsorship|usage|embedSubcommands
doctor— Verify the active deployment, backend client credential, exact origin, and delegated credential exchanges.--origin <https-origin>— Exact browser origin used by the embedding application.--client-id <id>— Backend assistant client identifier.--user-id <id>— Optional customer user identifier exercised by the diagnostic.--org <slug>— Organization slug.--app <slug>— Application slug.--env <slug>— Environment slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit one JSON result envelope.
appearance show— Show the active revision and field provenance without printing values.--org <slug>— Organization slug.--app <slug>— Application slug.--env <slug>— Environment slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit one JSON result envelope.
appearance apply— Replace the complete browser-safe appearance override from JSON.--file <appearance.json>— Complete browser-safe appearance override. (required)--revision <n>— Appearance revision reviewed before this mutation. (minimum 0)--org <slug>— Organization slug.--app <slug>— Application slug.--env <slug>— Environment slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit one JSON result envelope.
appearance reset— Remove the operator override and restore inherited defaults.--revision <n>— Appearance revision reviewed before this mutation. (minimum 0)--org <slug>— Organization slug.--app <slug>— Application slug.--env <slug>— Environment slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit one JSON result envelope.
clients create— Create a deployment-bound assistant client.--name <name>— Display name for the new assistant client. (default web)--org <slug>— Organization slug.--app <slug>— Application slug.--env <slug>— Environment slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit one JSON result envelope.
clients list— List deployment-bound assistant clients.--org <slug>— Organization slug.--app <slug>— Application slug.--env <slug>— Environment slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit one JSON result envelope.
clients rotate <client-id>— Rotate one assistant client credential.--org <slug>— Organization slug.--app <slug>— Application slug.--env <slug>— Environment slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit one JSON result envelope.
clients revoke <client-id>— Revoke one assistant client.--org <slug>— Organization slug.--app <slug>— Application slug.--env <slug>— Environment slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit one JSON result envelope.
embeds list— List public embed ids with their live origins, capabilities, caps, and today’s consumption.--org <slug>— Organization slug.--app <slug>— Application slug.--env <slug>— Environment slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit one JSON result envelope.
budget set— Raise, lower, or switch off a public surface’s daily caps.--turns-per-day <count>— Model turns this surface may run per UTC day. 0 stops it serving anyone.--mints-per-day <count>— Sessions this surface may open per UTC day. 0 stops it serving anyone.--mints-per-address-hour <count>— Sessions one source address may open per hour. The abuse bound, not fairness.--turns-per-address-hour <count>— Model turns one source address may run per hour. The abuse bound, not fairness.--bridge-calls-per-session <count>— Tool calls a browser agent may make in one session over the WebMCP bridge.--bridge-calls-per-day <count>— Bridge tool calls this surface may serve per UTC day. 0 closes the bridge.--surface <embed-id>— Which surface to change. Optional when the app has exactly one.--org <slug>— Organization slug.--app <slug>— Application slug.--env <slug>— Environment slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit one JSON result envelope.
sponsorship inspect <billing-account-id>— Show one billing account’s allowance, usage, reset, and grants.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit one JSON result envelope.
sponsorship grant <billing-account-id>— Add a bounded daily allowance until an explicit expiry.--turns-per-day <count>— Additional sponsored turns per UTC day. (required; range 1-100000)--starts-at <timestamp>— Optional ISO timestamp; defaults to now. (default now)--expires-at <timestamp>— Required ISO timestamp after which the grant stops applying. (required)--reason <text>— Auditable reason for granting or revoking sponsored usage. (required)--idempotency-key <key>— Stable retry key for exactly-once mutation semantics. (required)--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit one JSON result envelope.
sponsorship revoke <billing-account-id> <grant-id>— Revoke one bonus grant without deleting its audit history.--reason <text>— Auditable reason for granting or revoking sponsored usage. (required)--idempotency-key <key>— Stable retry key for exactly-once mutation semantics. (required)--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit one JSON result envelope.
usage— Show assistant sessions, conversation depth, engagement, latency, and model tokens.--window 24h|7d|30d— Aggregation window. (default 7d)--org <slug>— Organization slug.--app <slug>— Application slug.--env <slug>— Environment slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit one JSON result envelope.
embed— Install the selected website integration with explicit application-owned seams and verification guidance.--framework nextjs|django-vue— Embedding profile: nextjs or authenticated django-vue. (default nextjs)--dir <path>— Existing web application directory. (default .)--force— Overwrite user-modified scaffold files.--dry-run— Preview generated files, hashes, conflicts, and next steps without writing files.--no-agents— Skip writing agent instructions.--check— Check host environment presence and statically detectable CSP without writing files.--require-env <NAME>— Additional application-owned host environment name required by the integration. (repeatable)--surface authenticated|public|mixed— Surface to install or check; public omits backend exchange, mixed adds the existing-login handoff. (default authenticated)--env-alias <NAME=HOST_NAME>— Check a host-repo environment name in place of the canonical one. (repeatable)--json— Emit one JSON result envelope.
Run noodle assistant --help for the latest options and details.