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|clients|embeds|budget|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.
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.--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.
embed— Scaffold the embedding web app: session route, client-only mount, env example, and coding-agent instructions.--framework nextjs— Embedding scaffold framework. (default nextjs)--dir <path>— Existing web application directory. (default .)--force— Overwrite user-modified scaffold 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)--json— Emit one JSON result envelope.
Run noodle assistant --help for the latest options and details.