ReferenceCLI reference
noodle solutions
Install and operate data-driven business solutions.
Install and operate data-driven business solutions.
Usage
noodle solutions installation-options|agreement|notice|operations|activity|connections|catalog|list|install|inspect|activate|pause|resume|grants|invitations|records|sourcesSubcommands
installation-options— List organizations currently authorized to install solutions.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.--cursor <cursor>— Opaque page cursor.--limit <count>— Bounded page size. (range 1-100)
agreement get— Read current state and mutation authority.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.
agreement accept— Accept the exact reviewed version as an organization owner.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.--version <version>— Current agreement version. (required)--document-digest <sha256>— Exact reviewed document digest. (required)--accept— Explicitly accept the reviewed documents for this organization. (required)
notice get <installation>— Read current state and mutation authority.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.
notice set <installation>— Save the business notice with revision protection.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.--expected-revision <revision>— Expected current resource revision. (required; minimum 0)--display-name <value>— Business identity shown to agent users. (required)--privacy-url <value>— Public HTTPS privacy notice. (required)--support-url <value>— HTTPS support page or mailto address. (required)
operations coordination list <installation>— List held operations in one installation.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.--limit <count>— Maximum records in this page. (range 1-100)--before-resource <hash>— Continuation resource returned by the previous list.
operations coordination resolve <installation>— Release an inactive exact hold after reviewing the external outcome.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.--resource <value>— Exact resource hash from list. (required)--token <value>— Exact custody token from list. (required)--reason <value>— Single-line review reason; 1 to 256 characters. (required)
activity list <installation>— List operation evidence; returned is not confirmed completion.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.--limit <count>— Maximum entries in this page. (range 1-100)--cursor <cursor>— Opaque continuation from the prior page.
activity export <installation>— Export one authorized page of operation evidence.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.--limit <count>— Maximum entries in this page. (range 1-100)--cursor <cursor>— Opaque continuation from the prior page.
activity preview <installation>— Preview hypothetical history impact at the verified paid-period end.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.
activity settings get <installation>— Read retention, plan maximum, edit permission and current revision.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.
activity settings set <installation>— Change retention with an explicit revision check.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.--retention-days <days>— Desired retention within the current plan maximum. (required; range 1-365)--expected-revision <hash>— Revision returned by activity settings get. (required)
connections list <installation>— List declared connection availability.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.
connections connect <installation>— Open the authenticated Portal account consent flow.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.--portal <origin>— Portal origin; defaults to NOODLE_PORTAL_URL or the managed Portal. (default https://portal.noodleseed.com)--no-open— Print the browser URL without opening it.
connections disconnect <installation> <connection>— Revoke Noodle access to a connected account.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.--expected-revision <revision>— Current connection revision.
catalog— List centrally managed solution profiles.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.
list— List solution installations for an organization or the current identity.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.--cursor <cursor>— Opaque page cursor.--limit <count>— Bounded page size. (range 1-100)
install [travel|ecommerce|restaurant]— Install a managed profile or immutable private deployment.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.--app <slug>— Application slug.--env <slug>— Environment slug.--retention-days 7|30|90— Managed-record retention in days. (default 30)--display-name <name>— Receiving business name; supply all three notice fields together.--privacy-url <url>— Business public HTTPS privacy notice.--support-url <url>— Business HTTPS support page or mailto address.--publisher-org <org>— Private definition publisher organization.--definition-app <app>— App containing the private definition deployment.--definition-env <env>— Environment containing the private definition deployment.--deployment <deployment>— Immutable private definition deployment identifier.
inspect <installation>— Inspect one solution installation.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.
activate <installation>— Retry activation of a saved installation without changing its intake setting.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.
pause <installation>— Pause anonymous public intake.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.--expected-revision <revision>— Expected current resource revision. (required; minimum 1)
resume <installation>— Resume anonymous public intake.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.--expected-revision <revision>— Expected current resource revision. (required; minimum 1)
grants list <installation>— List live and revoked business grants.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.
grants set <installation>— Create or update a business grant.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.--subject <subject>— Canonical business-user subject. (required)--email <email>— Business-user email address. (required)--role administrator|manager|operator|viewer— Business role. (required)--expected-revision <revision>— Expected current grant revision; 0 for a new grant.
grants revoke <installation>— Revoke a business grant using optimistic concurrency.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.--subject <subject>— Canonical business-user subject. (required)--expected-revision <revision>— Expected current grant revision. (required)
invitations list <installation>— List installation-scoped staff invitations.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.
invitations create <installation>— Create one expiring staff invitation link.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.--email <email>— Verified email address the invitee must use. (required)--role administrator|manager|operator|viewer— Installation business role. (required)--idempotency-key <key>— Retry-safe operation key. (required)
invitations revoke <installation> <invitation>— Revoke a pending staff invitation.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.--expected-revision <revision>— Expected current resource revision. (required; minimum 1)
invitations accept <token>— Accept an invitation as the signed-in verified identity.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.
records list <installation> <collection>— List managed records.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.--data <json>— Structured JSON record data.--idempotency-key <key>— Retry-safe create key.--expected-revision <revision>— Expected current record revision.--status <status>— Record status or list filter.--assignee <subject>— Assignee subject or list filter.--note <text>— Operator note text.--cursor <cursor>— Opaque page cursor.--limit <count>— Bounded page size. (range 1-100)--include-deleted— Include payload-free tombstones.--filters <json>— JSON array of up to eight field/value equality filters, combined with AND. Only declared fields.--sort-field <field>— Declared native collection sort field.--sort-direction <asc|desc>— Sort direction; requires --sort-field.--created-at-from <timestamp>— Inclusive creation-time lower bound; narrows the 10,000-record payload-query scan.--created-at-to <timestamp>— Inclusive creation-time upper bound.
records create <installation> <collection>— Create managed records.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.--data <json>— Structured JSON record data.--idempotency-key <key>— Retry-safe create key.--expected-revision <revision>— Expected current record revision.--status <status>— Record status or list filter.--assignee <subject>— Assignee subject or list filter.--note <text>— Operator note text.--cursor <cursor>— Opaque page cursor.--limit <count>— Bounded page size. (range 1-100)--include-deleted— Include payload-free tombstones.
records get <installation> <collection> <record>— Get managed records.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.--data <json>— Structured JSON record data.--idempotency-key <key>— Retry-safe create key.--expected-revision <revision>— Expected current record revision.--status <status>— Record status or list filter.--assignee <subject>— Assignee subject or list filter.--note <text>— Operator note text.--cursor <cursor>— Opaque page cursor.--limit <count>— Bounded page size. (range 1-100)--include-deleted— Include payload-free tombstones.
records update <installation> <collection> <record>— Update managed records.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.--data <json>— Structured JSON record data.--idempotency-key <key>— Retry-safe create key.--expected-revision <revision>— Expected current record revision.--status <status>— Record status or list filter.--assignee <subject>— Assignee subject or list filter.--note <text>— Operator note text.--cursor <cursor>— Opaque page cursor.--limit <count>— Bounded page size. (range 1-100)--include-deleted— Include payload-free tombstones.--unset <fields>— Comma-separated optional field keys to remove; cannot overlap --data. May be used without --data.
records assign <installation> <collection> <record>— Assign managed records.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.--data <json>— Structured JSON record data.--idempotency-key <key>— Retry-safe create key.--expected-revision <revision>— Expected current record revision.--status <status>— Record status or list filter.--assignee <subject>— Assignee subject or list filter.--note <text>— Operator note text.--cursor <cursor>— Opaque page cursor.--limit <count>— Bounded page size. (range 1-100)--include-deleted— Include payload-free tombstones.
records status <installation> <collection> <record>— Status managed records.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.--data <json>— Structured JSON record data.--idempotency-key <key>— Retry-safe create key.--expected-revision <revision>— Expected current record revision.--status <status>— Record status or list filter.--assignee <subject>— Assignee subject or list filter.--note <text>— Operator note text.--cursor <cursor>— Opaque page cursor.--limit <count>— Bounded page size. (range 1-100)--include-deleted— Include payload-free tombstones.
records note <installation> <collection> <record>— Note managed records.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.--data <json>— Structured JSON record data.--idempotency-key <key>— Retry-safe create key.--expected-revision <revision>— Expected current record revision.--status <status>— Record status or list filter.--assignee <subject>— Assignee subject or list filter.--note <text>— Operator note text.--cursor <cursor>— Opaque page cursor.--limit <count>— Bounded page size. (range 1-100)--include-deleted— Include payload-free tombstones.
records activity <installation> <collection> <record>— Read native record history newest first; default 50, maximum 100, with --cursor for older pages.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.--data <json>— Structured JSON record data.--idempotency-key <key>— Retry-safe create key.--expected-revision <revision>— Expected current record revision.--status <status>— Record status or list filter.--assignee <subject>— Assignee subject or list filter.--note <text>— Operator note text.--cursor <cursor>— Opaque page cursor.--limit <count>— Bounded page size. (range 1-100)--include-deleted— Include payload-free tombstones.
records delete <installation> <collection> <record>— Delete managed records.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.--data <json>— Structured JSON record data.--idempotency-key <key>— Retry-safe create key.--expected-revision <revision>— Expected current record revision.--status <status>— Record status or list filter.--assignee <subject>— Assignee subject or list filter.--note <text>— Operator note text.--cursor <cursor>— Opaque page cursor.--limit <count>— Bounded page size. (range 1-100)--include-deleted— Include payload-free tombstones.
records migrate-schema <installation> <collection> <record>— Administrator-only conversion of an eligible legacy request record with revision protection.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.--data <json>— Structured JSON record data.--idempotency-key <key>— Retry-safe create key.--expected-revision <revision>— Expected current record revision.--status <status>— Record status or list filter.--assignee <subject>— Assignee subject or list filter.--note <text>— Operator note text.--cursor <cursor>— Opaque page cursor.--limit <count>— Bounded page size. (range 1-100)--include-deleted— Include payload-free tombstones.
records export <installation> <collection>— Export managed records.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.--data <json>— Structured JSON record data.--idempotency-key <key>— Retry-safe create key.--expected-revision <revision>— Expected current record revision.--status <status>— Record status or list filter.--assignee <subject>— Assignee subject or list filter.--note <text>— Operator note text.--cursor <cursor>— Opaque page cursor.--limit <count>— Bounded page size. (range 1-100)--include-deleted— Include payload-free tombstones.
sources show <installation> <collection>— Inspect collection source authority and health.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.
sources configure <installation> <collection>— Bind and explicitly enable an external collection source.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.--expected-revision <revision>— Expected current resource revision. (required; minimum 1)--binding-reference <binding>— Credential connection ID compiled into the installed artifact. (required)--binding-generation <generation>— Immutable source binding generation. (required)--configuration-reference <config>— Credential configuration revision compiled into the installed artifact. (required)--enable— Consent to enable synchronization for this source. (required)--replace— Replace an existing source binding with optimistic concurrency.
sources pause <installation> <collection>— Pause collection source synchronization.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.--expected-revision <revision>— Expected current resource revision. (required; minimum 1)
sources resume <installation> <collection>— Resume collection source synchronization.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.--expected-revision <revision>— Expected current resource revision. (required; minimum 1)
sources refresh <installation> <collection>— Queue a coalesced collection source refresh.--org <slug>— Organization slug.--service <url>— Control-plane service URL.--auth-token <token>— Control-plane authentication token.--json— Emit JSON output.--expected-revision <revision>— Expected current resource revision. (required; minimum 1)--idempotency-key <key>— Retry-safe operation key. (required)
Run noodle solutions --help for the latest options and details.