Generated CLI commands

These commands are generated from the Ligantic OpenAPI spec, so the CLI covers every public API operation. The hand-written commands in the CLI command reference take precedence where both exist: for example records list is hand-written, and records json-patch is generated. Find a command with ligantic cli search "<what you want to do>".

Every generated command follows the same conventions:

Space — operations inside a Space use the current Space, or --space <id>.
Path parameters — the other ids in the route are positional arguments, in route order. A <schemaId> also accepts a Schema name.
Query parameters and body fields — typed flags named after the field in kebab case (flowVersionId → --flow-version-id). Boolean flags take an optional true/false, repeatable values take several arguments, and fields marked JSON take a JSON value.
--data <json|@file|-> — the whole request body as inline JSON, a file, or stdin. Field flags override the matching keys. Fields marked required must be set by a flag or in --data.
--dry-run — print the request (method, url, query, body) instead of sending it. Secret-named fields (such as password or clientSecret) are shown as [REDACTED].
--yes — destructive operations fail with exit code 2 unless --yes is passed. On a terminal in table mode they ask for confirmation instead.
Output — the API response as JSON, following the output and exit code rules. In table mode an array of objects is a table of its scalar fields and an object is a key/value block. An operation with no response body prints { "ok": true }.

`ligantic spaces`

Manage Spaces and the current Space

`ligantic spaces secrets delete [options]`

Delete a Space secret.

Option	Description
`--path <values...>`	path (required)

`ligantic spaces secrets list [options]`

List a Space's secrets (paths only, never values).

Option	Description
`--path <values...>`	path
`--recursive [bool]`	recursive

`ligantic spaces auth-strategies create [options]`

Create a Space authentication strategy.

Option	Description
`--type <value>`	type (required) One of: `guest`, `authenticated`, `magic_link`, `jwt`.
`--name <value>`	name (required)
`--default-space-role-id <value>`	default space role id
`--success-redirect-experience-id <value>`	success redirect experience id
`--failure-redirect-experience-id <value>`	failure redirect experience id
`--logout-redirect-experience-id <value>`	logout redirect experience id
`--jwks-url <value>`	jwks url
`--issuer <value>`	issuer
`--audience <value>`	audience
`--client-id-claim <value>`	client id claim
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic spaces auth-strategies delete [options] <spaceAuthenticationStrategyId>`

Delete a Space authentication strategy.

Argument	Description
`<spaceAuthenticationStrategyId>`	The space authentication strategy id

`ligantic spaces auth-strategies list [options]`

List a Space's authentication strategies.

`ligantic spaces auth-strategies show [options] <spaceAuthenticationStrategyId>`

Get a Space authentication strategy.

Argument	Description
`<spaceAuthenticationStrategyId>`	The space authentication strategy id

`ligantic spaces auth-strategies update [options] <spaceAuthenticationStrategyId>`

Update a Space authentication strategy.

Argument	Description
`<spaceAuthenticationStrategyId>`	The space authentication strategy id

Option	Description
`--name <value>`	name (required)
`--default-space-role-id <value>`	default space role id
`--success-redirect-experience-id <value>`	success redirect experience id
`--failure-redirect-experience-id <value>`	failure redirect experience id
`--logout-redirect-experience-id <value>`	logout redirect experience id
`--jwks-url <value>`	jwks url
`--issuer <value>`	issuer
`--audience <value>`	audience
`--client-id-claim <value>`	client id claim
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic spaces create [options]`

Create a Space.

Option	Description
`--title <value>`	title (required)
`--parent-space-id <value>`	parent space id
`--organisation-id <value>`	organisation id
`--organisation-billing-account-id <value>`	organisation billing account id
`--clone-from-space-id <value>`	clone from space id
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic spaces delete [options]`

Delete a Space.

`ligantic spaces domains create [options]`

Add a custom domain to a Space.

Option	Description
`--domain <value>`	domain (required)
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic spaces domains delete [options] <domainId>`

Remove a custom domain from a Space.

Argument	Description
`<domainId>`	The domain id

`ligantic spaces domains list [options]`

List a Space's custom domains.

`ligantic spaces domains set-primary [options]`

Set a Space's primary domain.

Option	Description
`--domain-id <value>`	domain id (required)
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic spaces domains show [options] <domainId>`

Get a Space custom domain.

Argument	Description
`<domainId>`	The domain id

`ligantic spaces export [options]`

Export Schemas, Flows, Experiences, and other resources from a Space.

Option	Description
`--schema-ids <values...>`	schema ids
`--flow-ids <values...>`	flow ids
`--experience-ids <values...>`	experience ids
`--space-role-ids <values...>`	space role ids
`--space-authentication-strategy-ids <values...>`	space authentication strategy ids
`--oauth-credential-ids <values...>`	oauth credential ids
`--sql-credential-ids <values...>`	sql credential ids
`--folder-ids <values...>`	folder ids
`--endpoint-ids <values...>`	endpoint ids
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic spaces identities create [options]`

Create a Space identity.

Option	Description
`--space-authentication-strategy-id <value>`	space authentication strategy id (required)
`--space-role-id <value>`	space role id (required)
`--display-name <value>`	display name
`--external-identifier <value>`	external identifier
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic spaces identities delete [options] <spaceIdentityId>`

Remove an identity from a Space.

Argument	Description
`<spaceIdentityId>`	The space identity id

`ligantic spaces identities list [options]`

List a Space's identities.

`ligantic spaces identities set-role [options] <spaceIdentityId>`

Change a Space identity's role.

Argument	Description
`<spaceIdentityId>`	The space identity id

Option	Description
`--role <value>`	role One of: `USER`, `ADMIN`.
`--space-role-id <value>`	space role id
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic spaces identities show [options] <userId>`

Get a user's identity in a Space.

Argument	Description
`<userId>`	The user id

`ligantic spaces import [options]`

Import an export into a Space.

Option	Description
`--flows <json>`	flows (required; JSON)
`--schemas <json>`	schemas (required; JSON)
`--experiences <json>`	experiences (required; JSON)
`--space-roles <json>`	space roles (required; JSON)
`--space-authentication-strategies <json>`	space authentication strategies (JSON)
`--space-oauth-credentials <json>`	space oauth credentials (JSON)
`--space-sql-credentials <json>`	space sql credentials (JSON)
`--folders <json>`	folders (JSON)
`--artifacts <json>`	artifacts (JSON)
`--canvases <json>`	canvases (JSON)
`--canvas-system <json>`	canvas system (JSON)
`--endpoints <json>`	endpoints (JSON)
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic spaces invites accept [options] <inviteId>`

Accept a Space invite.

Argument	Description
`<inviteId>`	The invite id

`ligantic spaces invites cancel [options] <inviteId>`

Cancel a pending Space invite.

Argument	Description
`<inviteId>`	The invite id

`ligantic spaces invites create [options]`

Invite a user to a Space by email.

Option	Description
`--email <value>`	email (required)
`--role <value>`	role One of: `USER`, `ADMIN`.
`--space-role-id <value>`	space role id
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic spaces invites decline [options] <inviteId>`

Decline a Space invite.

Argument	Description
`<inviteId>`	The invite id

`ligantic spaces invites list [options]`

List a Space's invites.

`ligantic spaces invites pending [options]`

List your pending Space invites.

`ligantic spaces invites pending-by-space [options]`

List your pending invites to a Space.

`ligantic spaces invites set-role [options] <inviteId>`

Change the role of a pending Space invite.

Argument	Description
`<inviteId>`	The invite id

Option	Description
`--role <value>`	role One of: `USER`, `ADMIN`.
`--space-role-id <value>`	space role id
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic spaces oauth-credentials create [options]`

Create a Space OAuth credential.

Option	Description
`--name <value>`	name (required)
`--endpoint-source <value>`	endpoint source One of: `discovered`, `manual`.
`--issuer-endpoint <value>`	issuer endpoint
`--authorization-endpoint <value>`	authorization endpoint
`--token-endpoint <value>`	token endpoint
`--client-authentication-method <value>`	client authentication method One of: `client_secret_basic`, `client_secret_post`.
`--client-id <value>`	client id (required)
`--client-secret-path <values...>`	client secret path (required)
`--scopes <values...>`	scopes
`--refresh-period-days <number>`	refresh period days
`--grant-type <value>`	grant type One of: `authorization_code`, `client_credentials`.
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic spaces oauth-credentials delete [options] <oauthCredentialId>`

Delete a Space OAuth credential.

Argument	Description
`<oauthCredentialId>`	The oauth credential id

`ligantic spaces oauth-credentials list [options]`

List a Space's OAuth credentials.

`ligantic spaces oauth-credentials revoke [options] <oauthCredentialId>`

Revoke a Space OAuth credential's tokens.

Argument	Description
`<oauthCredentialId>`	The oauth credential id

`ligantic spaces oauth-credentials show [options] <oauthCredentialId>`

Get a Space OAuth credential.

Argument	Description
`<oauthCredentialId>`	The oauth credential id

`ligantic spaces oauth-credentials update [options] <oauthCredentialId>`

Update a Space OAuth credential.

Argument	Description
`<oauthCredentialId>`	The oauth credential id

Option	Description
`--name <value>`	name
`--issuer-endpoint <value>`	issuer endpoint
`--authorization-endpoint <value>`	authorization endpoint
`--token-endpoint <value>`	token endpoint
`--client-authentication-method <json>`	client authentication method (JSON)
`--client-id <value>`	client id
`--client-secret-path <values...>`	client secret path
`--scopes <values...>`	scopes
`--refresh-period-days <number>`	refresh period days
`--endpoint-source <value>`	endpoint source One of: `discovered`, `manual`.
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic spaces roles create [options]`

Create a Space role.

Option	Description
`--name <value>`	name (required)
`--capabilities <json>`	capabilities (required; JSON)
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic spaces roles delete [options] <spaceRoleId>`

Delete a Space role.

Argument	Description
`<spaceRoleId>`	The space role id

Option	Description
`--transfer-space-role-id <value>`	transfer space role id

`ligantic spaces roles list [options]`

List a Space's roles.

`ligantic spaces roles show [options] <spaceRoleId>`

Get a Space role.

Argument	Description
`<spaceRoleId>`	The space role id

`ligantic spaces roles update [options] <spaceRoleId>`

Update a Space role.

Argument	Description
`<spaceRoleId>`	The space role id

Option	Description
`--name <value>`	name (required)
`--capabilities <json>`	capabilities (required; JSON)
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic spaces set-billing-mode [options]`

Change how a Space is billed.

Option	Description
`--billing-mode <value>`	billing mode (required) One of: `user_pays`, `space_pays`.
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic spaces set-billing-user [options]`

Make yourself the billing user of a Space.

`ligantic spaces set-name [options]`

Change a Space's name (its URL slug).

Option	Description
`--name <value>`	name
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic spaces set-parent [options]`

Move a Space under another parent Space.

Option	Description
`--parent-space-id <value>`	parent space id
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic spaces set-title [options]`

Change a Space's title.

Option	Description
`--title <value>`	title (required)
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic spaces users list [options]`

List the Ligantic users with access to a Space.

`ligantic schemas`

Manage Schemas

`ligantic schemas config [options] <schemaId>`

Get the field configuration of a Schema's current version.

GET /spaces/{spaceId}/schemas/{schemaId}/config

Argument	Description
`<schemaId>`	The Schema (id or name)

`ligantic schemas create [options]`

Create a Schema.

POST /spaces/{spaceId}/schemas

Option	Description
`--name <value>`	name (required)
`--display-name-template <value>`	display name template (required)
`--auto-save [bool]`	auto save (server default: false)
`--schema <json>`	schema (JSON)
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic schemas delete [options] <schemaId>`

Delete a Schema.

DELETE /spaces/{spaceId}/schemas/{schemaId} — destructive, requires --yes

Argument	Description
`<schemaId>`	The Schema (id or name)

`ligantic schemas fields add [options] <schemaId>`

Add a field to a Schema.

Adds one field without sending the whole Schema, and returns its generated id. parent nests it inside an object field (or an array of objects).

POST /spaces/{spaceId}/schemas/{schemaId}/fields

Argument	Description
`<schemaId>`	The Schema (id or name)

Option	Description
`--field <json>`	The field, such as `{"name":"Email","type":"string"}` or `{"name":"Status","type":"string","display":"select","options":["Open","Closed"]}` (required; JSON)
`--parent <value>`	The object field to add it to, by id, name, or dot path (the top level by default)
`--field-id <value>`	The field's id, the key of its value in Record data (generated by default)
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic schemas fields delete [options] <schemaId> <field>`

Remove a field from a Schema.

Existing Records keep any value stored under the field's id, but it is no longer part of the Schema.

DELETE /spaces/{spaceId}/schemas/{schemaId}/fields/{field} — destructive, requires --yes

Argument	Description
`<schemaId>`	The Schema (id or name)
`<field>`	The field (id, name, or dot path such as address.city)

`ligantic schemas fields update [options] <schemaId> <field>`

Change one field of a Schema.

Merges changes into the field, such as {"required":true} or {"name":"Email address"}. A null value removes a property.

PATCH /spaces/{spaceId}/schemas/{schemaId}/fields/{field}

Argument	Description
`<schemaId>`	The Schema (id or name)
`<field>`	The field (id, name, or dot path such as address.city)

Option	Description
`--changes <json>`	Field properties to set (required; JSON)
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic schemas relationships create [options]`

Create a relationship between two Schemas.

POST /spaces/{spaceId}/schemas-relationships

Option	Description
`--name <value>`	name (required)
`--from-name <value>`	from name
`--from-schema-version-id <value>`	from schema version id (required)
`--to-schema-version-id <value>`	to schema version id (required)
`--directional [bool]`	directional (required)
`--multiple-from [bool]`	multiple from (required)
`--multiple-to [bool]`	multiple to (required)
`--from-show-in-table [bool]`	from show in table (server default: false)
`--to-show-in-table [bool]`	to show in table (server default: false)
`--from-display-mode <value>`	from display mode (server default: "list") One of: `list`, `table`.
`--to-display-mode <value>`	to display mode (server default: "list") One of: `list`, `table`.
`--from-schema-path <values...>`	from schema path
`--to-schema-path <values...>`	to schema path
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic schemas relationships delete [options] <schemaRelationshipVersionId>`

Delete a Schema relationship.

DELETE /spaces/{spaceId}/schemas-relationships/{schemaRelationshipVersionId} — destructive, requires --yes

Argument	Description
`<schemaRelationshipVersionId>`	The schema relationship version id

`ligantic schemas relationships reorder [options]`

Reorder the relationships shown on a Schema version.

PATCH /spaces/{spaceId}/schemas-relationships/order

Option	Description
`--schema-version-id <value>`	schema version id (required)
`--schema-relationship-version-ids <values...>`	schema relationship version ids (required)
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic schemas relationships update [options] <schemaRelationshipVersionId>`

Update a Schema relationship.

PATCH /spaces/{spaceId}/schemas-relationships/{schemaRelationshipVersionId}

Argument	Description
`<schemaRelationshipVersionId>`	The schema relationship version id

Option	Description
`--name <value>`	name (required)
`--from-name <value>`	from name
`--from-schema-version-id <value>`	from schema version id (required)
`--to-schema-version-id <value>`	to schema version id (required)
`--directional [bool]`	directional (required)
`--multiple-from [bool]`	multiple from (required)
`--multiple-to [bool]`	multiple to (required)
`--from-show-in-table [bool]`	from show in table (server default: false)
`--to-show-in-table [bool]`	to show in table (server default: false)
`--from-display-mode <value>`	from display mode (server default: "list") One of: `list`, `table`.
`--to-display-mode <value>`	to display mode (server default: "list") One of: `list`, `table`.
`--from-schema-path <values...>`	from schema path
`--to-schema-path <values...>`	to schema path
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic schemas update [options] <schemaId>`

Update a Schema's name, display template, or fields.

PATCH /spaces/{spaceId}/schemas/{schemaId}

Argument	Description
`<schemaId>`	The Schema (id or name)

Option	Description
`--display-name-template <value>`	Omit it to keep the current display name template
`--auto-save [bool]`	auto save
`--schema <json>`	schema (JSON)
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic records`

Work with Records

`ligantic records confirm-uploads [options] <schemaId> <entityId>`

Confirm a Record's file uploads finished, so its create or update Flows run.

POST /spaces/{spaceId}/schemas/{schemaId}/entities/{entityId}/confirm-uploads-complete

Argument	Description
`<schemaId>`	The Schema (id or name)
`<entityId>`	The Record id

Option	Description
`--action <value>`	action (required) One of: `create`, `update`.
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic records json-patch [options] <schemaId> <entityId>`

Apply RFC 6902 JSON Patch operations to a Record's data.

PATCH /spaces/{spaceId}/schemas/{schemaId}/entities/{entityId}/json-patch

Argument	Description
`<schemaId>`	The Schema (id or name)
`<entityId>`	The Record id

Option	Description
`--operations <json>`	operations (required; JSON)
`--has-pending-uploads [bool]`	has pending uploads (server default: false)
`--name-based [bool]`	name based (server default: false)
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic records update-link [options] <schemaRelationshipVersionId> <entityRelationshipId>`

Change the Records a relationship link connects.

PATCH /spaces/{spaceId}/schemas-relationships/{schemaRelationshipVersionId}/entities/{entityRelationshipId}

Argument	Description
`<schemaRelationshipVersionId>`	The schema relationship version id
`<entityRelationshipId>`	The entity relationship id

Option	Description
`--from-id <value>`	from id (required)
`--to-id <value>`	to id (required)
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic flows`

Work with Flows

`ligantic flows runs cancel [options] <flowId> <executionId>`

Cancel a Flow run.

POST /spaces/{spaceId}/flows/{flowId}/executions/{executionId}/cancel — destructive, requires --yes

Argument	Description
`<flowId>`	The flow id
`<executionId>`	The Flow run id

`ligantic flows runs confirm-uploads [options] <flowId> <executionId>`

Confirm a Flow run's file uploads finished, so the run can start.

POST /spaces/{spaceId}/flows/{flowId}/executions/{executionId}/confirm-uploads-complete

Argument	Description
`<flowId>`	The flow id
`<executionId>`	The Flow run id

`ligantic flows runs list [options] <flowId>`

List a Flow's runs.

GET /spaces/{spaceId}/flows/{flowId}/executions

Argument	Description
`<flowId>`	The flow id

Option	Description
`--limit <number>`	limit (server default: 10)
`--offset <number>`	offset (server default: 0)

`ligantic flows clone [options] <flowId>`

Clone a Flow.

POST /spaces/{spaceId}/flows/{flowId}/clone

Argument	Description
`<flowId>`	The flow id

Option	Description
`--flow-version-id <value>`	flow version id
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic flows create [options]`

Create a Flow.

POST /spaces/{spaceId}/flows

Option	Description
`--name <value>`	name (required)
`--nodes <json>`	The whole graph. Omit nodes and edges to start with one `flow:trigger` node (nodeId `trigger`), then build with `flows nodes add` and `flows edges add`. (JSON)
`--edges <json>`	edges (JSON)
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic flows delete [options] <flowId>`

Delete a Flow.

DELETE /spaces/{spaceId}/flows/{flowId} — destructive, requires --yes

Argument	Description
`<flowId>`	The flow id

`ligantic flows edges add [options] <flowId>`

Connect two nodes of a Flow.

Connects an output handle of source to an input handle of target; flows nodes list shows each node's handle ids. Node and edge edits change the Flow's draft version; when the latest version is published, a new draft is created from it first. Publish with flows versions publish.

POST /spaces/{spaceId}/flows/{flowId}/edges

Argument	Description
`<flowId>`	The flow id

Option	Description
`--source <value>`	The nodeId the edge starts from (required)
`--source-handle <value>`	An output handle id of the source node (required)
`--target <value>`	The nodeId the edge goes to (required)
`--target-handle <value>`	An input handle id of the target node (required)
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic flows edges delete [options] <flowId> <edgeId>`

Remove an edge from a Flow.

Node and edge edits change the Flow's draft version; when the latest version is published, a new draft is created from it first. Publish with flows versions publish.

DELETE /spaces/{spaceId}/flows/{flowId}/edges/{edgeId} — destructive, requires --yes

Argument	Description
`<flowId>`	The flow id
`<edgeId>`	The edge id

`ligantic flows list-by-schema [options] <schemaId>`

List the Flows attached to a Schema.

GET /spaces/{spaceId}/flows/by-schema/{schemaId}

Argument	Description
`<schemaId>`	The Schema (id or name)

Option	Description
`--show-on-entity [bool]`	show on entity (server default: false)
`--show-on-table [bool]`	show on table (server default: false)

`ligantic flows node-types list [options]`

List the Flow node types.

GET /flow-node-types

`ligantic flows node-types show [options] <nodeType>`

Describe the configuration a Flow node type accepts.

Returns the node's data properties and their types, for flows nodes add --node-data.

GET /flow-node-types/{nodeType}

Argument	Description
`<nodeType>`	The node type

`ligantic flows nodes add [options] <flowId>`

Add a node to a Flow.

Returns the new node's id and its handles, ready to connect with flows edges add. Node and edge edits change the Flow's draft version; when the latest version is published, a new draft is created from it first. Publish with flows versions publish.

POST /spaces/{spaceId}/flows/{flowId}/nodes

Argument	Description
`<flowId>`	The flow id

Option	Description
`--type <value>`	type (required) One of: `flow:trigger`, `flow:result`, `flow:execute`, `flow:cancel`, `control:if`, `control:switch`, `control:wait`, `data:literal`, `data:context`, `data:expression`, `object:pick`, `object:pack`, `object:create`, `object:update`, `object:remove`, `object:link`, `object:unlink`, `object:query`, `object:queryLink`, `list:map`, `list:filter`, `list:aggregate`, `text:template`, `text:parseHTMLToContent`, `text:parseDocumentToContent`, `text:parseMarkdownToContent`, `text:contentToText`, `text:extractListItems`, `text:recursiveSplit`, `file:json:parse`, `file:xlsx:read`, `file:zip:create`, `file:zip:extract`, `stream:collect`, `system:ingest`, `text:html:queryAndTransform`, `endpoint:respond`, `integration:http`, `integration:smtp`, `integration:sql:connect`, `integration:sql:disconnect`, `integration:sql:query`, `ai:llm:chatMessage`, `ai:llm:computeEmbedding`, `ai:dataExtraction`, `ai:router`, `ai:text-to-speech`, `ai:transcribe`, `ai:image-generate`, `ai:vectorContext:add`, `ai:vectorContext:query`, `ai:vectorContext:remove`, `media:audio:process`, `media:video:audio:extract`, `ux:message`, `ux:action`, `browser:actions`, `browser:navigate`, `secret:get`, `secret:set`, `secret:remove`, `secret:unwrap`, `auth:magic-link:generate`, `auth:space-identity:create`, `auth:oauth:getAccessToken`, `experience:buildUrl`, `experience:pdf:create`.
`--node-data <json>`	The node's configuration (its `data`). `label` defaults to a name based on the type. (JSON)
`--position <json>`	Canvas position (below the lowest node by default) (JSON)
`--node-id <value>`	The node's id within the Flow, used by edges (generated by default)
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic flows nodes delete [options] <flowId> <nodeId>`

Remove a node, and its edges, from a Flow.

Node and edge edits change the Flow's draft version; when the latest version is published, a new draft is created from it first. Publish with flows versions publish.

DELETE /spaces/{spaceId}/flows/{flowId}/nodes/{nodeId} — destructive, requires --yes

Argument	Description
`<flowId>`	The flow id
`<nodeId>`	The node's nodeId within the Flow

`ligantic flows nodes list [options] <flowId>`

List a Flow's nodes, their handles, and edges.

Returns the latest version's graph: each node's id, type, label, and the handle ids to connect edges to, plus every edge. Use flows nodes show for a node's full configuration.

GET /spaces/{spaceId}/flows/{flowId}/nodes

Argument	Description
`<flowId>`	The flow id

Option	Description
`--flow-version-id <value>`	flow version id

`ligantic flows nodes show [options] <flowId> <nodeId>`

Get one node of a Flow with its handles and edges.

GET /spaces/{spaceId}/flows/{flowId}/nodes/{nodeId}

Argument	Description
`<flowId>`	The flow id
`<nodeId>`	The node's nodeId within the Flow

Option	Description
`--flow-version-id <value>`	flow version id

`ligantic flows nodes update [options] <flowId> <nodeId>`

Change one node of a Flow.

Merges data into the node's configuration. Node and edge edits change the Flow's draft version; when the latest version is published, a new draft is created from it first. Publish with flows versions publish.

PATCH /spaces/{spaceId}/flows/{flowId}/nodes/{nodeId}

Argument	Description
`<flowId>`	The flow id
`<nodeId>`	The node's nodeId within the Flow

Option	Description
`--node-data <json>`	Configuration to merge into the node's `data`. A `null` value removes the key. (JSON)
`--position <json>`	position (JSON)
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic flows versions create [options] <flowId>`

Add a new version to a Flow.

POST /spaces/{spaceId}/flows/{flowId}/versions

Argument	Description
`<flowId>`	The flow id

Option	Description
`--name <value>`	name (required)
`--default-log-level <value>`	default log level One of: `none`, `error`, `warn`, `info`, `debug`.
`--nodes <json>`	nodes (required; JSON)
`--edges <json>`	edges (required; JSON)
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic flows versions publish [options] <flowId> <flowVersionId>`

Publish a Flow version.

POST /spaces/{spaceId}/flows/{flowId}/versions/{flowVersionId}/publish

Argument	Description
`<flowId>`	The flow id
`<flowVersionId>`	The flow version id

`ligantic flows versions run [options] <flowId> <flowVersionId>`

Run a specific Flow version.

POST /spaces/{spaceId}/flows/{flowId}/versions/{flowVersionId}/execute

Argument	Description
`<flowId>`	The flow id
`<flowVersionId>`	The flow version id

Option	Description
`--trigger-node-id <value>`	trigger node id
`--inputs <json>`	inputs (JSON)
`--has-pending-upload-files [bool]`	has pending upload files (server default: false)
`--log-level <value>`	log level One of: `none`, `error`, `warn`, `info`, `debug`.
`--scheduled-at <value>`	scheduled at
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic flows versions show [options] <flowId>`

Get a Flow version (the latest published version by default).

GET /spaces/{spaceId}/flows/{flowId}/versions

Argument	Description
`<flowId>`	The flow id

Option	Description
`--flow-version-id <value>`	flow version id

`ligantic flows versions update [options] <flowId> <flowVersionId>`

Update a draft Flow version.

Replaces the version's nodes and edges. Only draft versions can be changed; create a new version with flows versions create to change a published one.

PATCH /spaces/{spaceId}/flows/{flowId}/versions/{flowVersionId}

Argument	Description
`<flowId>`	The flow id
`<flowVersionId>`	The flow version id

Option	Description
`--name <value>`	name (required)
`--default-log-level <value>`	default log level One of: `none`, `error`, `warn`, `info`, `debug`.
`--nodes <json>`	nodes (required; JSON)
`--edges <json>`	edges (required; JSON)
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic billing`

Your credit balance and usage

`ligantic billing credits list [options]`

List your credit grants and how much of each is used.

GET /billing/credits

`ligantic billing credits usages [options] <creditId>`

List the usage recorded against one of your credit grants.

GET /billing/credits/{creditId}/usages

Argument	Description
`<creditId>`	The credit id

Option	Description
`--offset <number>`	offset (server default: 0)
`--limit <number>`	limit (server default: 10)

`ligantic endpoints`

Manage a Space's API endpoints

`ligantic endpoints create [options]`

Create a Space API endpoint.

POST /spaces/{spaceId}/endpoints

Option	Description
`--name <value>`	name (required)
`--method <value>`	method (server default: "GET") One of: `GET`, `POST`, `PUT`, `PATCH`, `DELETE`.
`--path-template <json>`	path template (required; JSON)
`--param-schema <json>`	param schema (JSON; server default: {})
`--handler <value>`	handler (required) One of: `flow`.
`--handler-config <json>`	handler config (required; JSON)
`--request-contract <json>`	request contract (JSON; server default: {})
`--response-contract <json>`	response contract (JSON; server default: {})
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic endpoints delete [options] <endpointId>`

Delete a Space API endpoint.

DELETE /spaces/{spaceId}/endpoints/{endpointId} — destructive, requires --yes

Argument	Description
`<endpointId>`	The endpoint id

`ligantic endpoints list [options]`

List a Space's API endpoints.

GET /spaces/{spaceId}/endpoints

`ligantic endpoints openapi [options]`

Get the OpenAPI document for a Space's published endpoints.

GET /spaces/{spaceId}/endpoints/openapi.json

`ligantic endpoints publish [options] <endpointId>`

Publish a Space API endpoint.

POST /spaces/{spaceId}/endpoints/{endpointId}/publish

Argument	Description
`<endpointId>`	The endpoint id

`ligantic endpoints retire [options] <endpointId>`

Retire a Space API endpoint so it stops serving requests.

POST /spaces/{spaceId}/endpoints/{endpointId}/retire

Argument	Description
`<endpointId>`	The endpoint id

`ligantic endpoints show [options] <endpointId>`

Get a Space API endpoint.

GET /spaces/{spaceId}/endpoints/{endpointId}

Argument	Description
`<endpointId>`	The endpoint id

`ligantic endpoints update [options] <endpointId>`

Update a Space API endpoint.

PATCH /spaces/{spaceId}/endpoints/{endpointId}

Argument	Description
`<endpointId>`	The endpoint id

Option	Description
`--name <value>`	name
`--method <value>`	method One of: `GET`, `POST`, `PUT`, `PATCH`, `DELETE`.
`--path-template <json>`	path template (JSON)
`--param-schema <json>`	param schema (JSON; server default: {})
`--handler-config <json>`	handler config (JSON)
`--request-contract <json>`	request contract (JSON; server default: {})
`--response-contract <json>`	response contract (JSON; server default: {})
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic experiences`

Work with Experiences

`ligantic experiences block-types list [options]`

List the Experience block types.

GET /experience-block-types

`ligantic experiences block-types show [options] <blockType>`

Describe the properties an Experience block type accepts.

Returns the block's properties and their types, for experiences blocks add --block and blocks update --changes.

GET /experience-block-types/{blockType}

Argument	Description
`<blockType>`	The block type

`ligantic experiences blocks add [options] <experienceId>`

Add a block to an Experience.

Adds the block, with any nested children, under parentId (the root block by default) and returns the new block's id. Block edits change the Experience's draft version; when the latest version is published, a new draft is created from it first. Publish with experiences versions publish.

POST /spaces/{spaceId}/experiences/{experienceId}/blocks

Argument	Description
`<experienceId>`	The experience id

Option	Description
`--block <json>`	A block, such as `{"type":"text","text":"Hello"}`. `id` is optional and generated when omitted, as are the ids of nested `children`. (required; JSON)
`--parent-id <value>`	The box, link, or button block to add to (the root block by default). With no content yet, omit it to add the root block.
`--index <number>`	Position among the parent's children (the end by default)
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic experiences blocks delete [options] <experienceId> <blockId>`

Remove a block, with its children, from an Experience's draft.

DELETE /spaces/{spaceId}/experiences/{experienceId}/blocks/{blockId} — destructive, requires --yes

Argument	Description
`<experienceId>`	The experience id
`<blockId>`	The block id

`ligantic experiences blocks move [options] <experienceId> <blockId>`

Move a block, with its children, within an Experience's draft.

POST /spaces/{spaceId}/experiences/{experienceId}/blocks/{blockId}/move

Argument	Description
`<experienceId>`	The experience id
`<blockId>`	The block id

Option	Description
`--parent-id <value>`	The box, link, or button block to move it into (required)
`--index <number>`	Position among the new parent's children (the end by default)
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic experiences blocks outline [options] <experienceId>`

Outline an Experience version's blocks.

Returns the latest version's block tree as ids, types, names, and short text previews, without the other block properties. Use experiences blocks show to read one block in full.

GET /spaces/{spaceId}/experiences/{experienceId}/blocks

Argument	Description
`<experienceId>`	The experience id

Option	Description
`--experience-version-id <value>`	experience version id
`--block-id <value>`	block id
`--depth <number>`	depth

`ligantic experiences blocks replace [options] <experienceId> <blockId>`

Replace one block, and its children, in an Experience's draft.

PUT /spaces/{spaceId}/experiences/{experienceId}/blocks/{blockId}

Argument	Description
`<experienceId>`	The experience id
`<blockId>`	The block id

Option	Description
`--block <json>`	A block, such as `{"type":"text","text":"Hello"}`. `id` is optional and generated when omitted, as are the ids of nested `children`. (required; JSON)
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic experiences blocks show [options] <experienceId> <blockId>`

Get one block of an Experience, with its children.

GET /spaces/{spaceId}/experiences/{experienceId}/blocks/{blockId}

Argument	Description
`<experienceId>`	The experience id
`<blockId>`	The block id

Option	Description
`--experience-version-id <value>`	experience version id

`ligantic experiences blocks update [options] <experienceId> <blockId>`

Change properties of one block in an Experience's draft.

PATCH /spaces/{spaceId}/experiences/{experienceId}/blocks/{blockId}

Argument	Description
`<experienceId>`	The experience id
`<blockId>`	The block id

Option	Description
`--changes <json>`	Properties to set on the block, merged into it. A `null` value removes the property. `children` replaces the block's children. (required; JSON)
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic experiences clone [options] <experienceId>`

Clone an Experience.

POST /spaces/{spaceId}/experiences/{experienceId}/clone

Argument	Description
`<experienceId>`	The experience id

Option	Description
`--experience-version-id <value>`	experience version id
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic experiences create [options]`

Create an Experience.

POST /spaces/{spaceId}/experiences

Option	Description
`--name <value>`	name (required)
`--title <value>`	title
`--pathname <value>`	pathname
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic experiences delete [options] <experienceId>`

Delete an Experience.

DELETE /spaces/{spaceId}/experiences/{experienceId} — destructive, requires --yes

Argument	Description
`<experienceId>`	The experience id

`ligantic experiences list [options]`

List Experiences in a Space.

GET /spaces/{spaceId}/experiences

Option	Description
`--omit-unpublished [bool]`	omit unpublished
`--omit-experiences-with-required-path-variables [bool]`	omit experiences with required path variables

`ligantic experiences rename [options] <experienceId>`

Rename an Experience.

PATCH /spaces/{spaceId}/experiences/{experienceId}

Argument	Description
`<experienceId>`	The experience id

Option	Description
`--name <value>`	name (required)
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic experiences show [options] <experienceId>`

Get an Experience.

Returns the latest version of the Experience, or experienceVersionId when given.

GET /spaces/{spaceId}/experiences/{experienceId}

Argument	Description
`<experienceId>`	The experience id

Option	Description
`--experience-version-id <value>`	experience version id

`ligantic experiences versions create [options] <experienceId>`

Create a draft Experience version.

Creates a new draft version. version defaults to the latest version with its patch number incremented. Pass sourceExperienceVersionId to copy that version's metadata.

POST /spaces/{spaceId}/experiences/{experienceId}/versions

Argument	Description
`<experienceId>`	The experience id

Option	Description
`--source-experience-version-id <value>`	source experience version id
`--title <value>`	title (required)
`--pathname <value>`	pathname (required)
`--powered-by-logo-removed [bool]`	powered by logo removed (required)
`--block <json>`	block (JSON)
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic experiences versions list [options] <experienceId>`

List an Experience's versions.

Newest first. Pass the returned nextCursor back as cursor to fetch the next page.

GET /spaces/{spaceId}/experiences/{experienceId}/versions

Argument	Description
`<experienceId>`	The experience id

Option	Description
`--limit <number>`	limit
`--cursor <json>`	cursor (JSON)

`ligantic experiences versions metadata delete [options] <experienceId> <experienceVersionId> <name>`

Remove an Experience version metadata entry.

Only draft versions can be changed.

DELETE /spaces/{spaceId}/experiences/{experienceId}/versions/{experienceVersionId}/metadata/{name} — destructive, requires --yes

Argument	Description
`<experienceId>`	The experience id
`<experienceVersionId>`	The experience version id
`<name>`	The name

`ligantic experiences versions metadata rename [options] <experienceId> <experienceVersionId> <currentName>`

Rename an Experience version metadata entry.

Moves the value to newName, replacing any value already set there. Only draft versions can be changed.

POST /spaces/{spaceId}/experiences/{experienceId}/versions/{experienceVersionId}/metadata/{currentName}/rename

Argument	Description
`<experienceId>`	The experience id
`<experienceVersionId>`	The experience version id
`<currentName>`	The current name

Option

Description

--new-name <value>

new name (required) One of: icon, description, og:title, og:description, og:type, og:url, og:determiner, og:locale, og:locale:alternate, og:site_name, og:image, og:image:alt, og:image:height, og:image:secure_url, og:image:type, og:image:url, og:image:width, og:audio, og:audio:secure_url, og:audio:type, og:video, og:video:height, og:video:secure_url, og:video:type, og:video:width, twitter:card, twitter:title, twitter:description, twitter:image.

--data <json>

The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic experiences versions metadata set [options] <experienceId> <experienceVersionId> <name>`

Set an Experience version metadata value.

Creates or replaces the metadata value, such as description or og:image. Only draft versions can be changed.

PUT /spaces/{spaceId}/experiences/{experienceId}/versions/{experienceVersionId}/metadata/{name}

Argument	Description
`<experienceId>`	The experience id
`<experienceVersionId>`	The experience version id
`<name>`	The name

Option	Description
`--value <json>`	value (required; JSON)
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic experiences versions publish [options] <experienceId> <experienceVersionId>`

Publish an Experience version.

POST /spaces/{spaceId}/experiences/{experienceId}/versions/{experienceVersionId}/publish

Argument	Description
`<experienceId>`	The experience id
`<experienceVersionId>`	The experience version id

`ligantic experiences versions set-content [options] <experienceId> <experienceVersionId>`

Replace a draft Experience version's content.

Replaces the version's root block. Only draft versions can be changed.

PUT /spaces/{spaceId}/experiences/{experienceId}/versions/{experienceVersionId}/content

Argument	Description
`<experienceId>`	The experience id
`<experienceVersionId>`	The experience version id

Option	Description
`--block <json>`	block (JSON)
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic experiences versions update [options] <experienceId> <experienceVersionId>`

Update an Experience version's title and pathname.

Only draft versions can be changed.

PATCH /spaces/{spaceId}/experiences/{experienceId}/versions/{experienceVersionId}

Argument	Description
`<experienceId>`	The experience id
`<experienceVersionId>`	The experience version id

Option	Description
`--title <value>`	title (required)
`--pathname <value>`	pathname
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic folders`

Organise a Space's Schemas, Flows, and Experiences into folders

`ligantic folders create [options]`

Create a folder.

POST /spaces/{spaceId}/folders

Option	Description
`--parent-folder-id <value>`	parent folder id
`--name <value>`	name (required)
`--icon <value>`	icon
`--default-open [bool]`	default open
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic folders delete [options] <folderId>`

Delete a folder.

DELETE /spaces/{spaceId}/folders/{folderId} — destructive, requires --yes

Argument	Description
`<folderId>`	The folder id

`ligantic folders move [options]`

Move folders, Flows, Schemas, or Experiences into a folder.

POST /spaces/{spaceId}/folders/move-items

Option	Description
`--folder-id <value>`	folder id (required)
`--folder-ids <values...>`	folder ids
`--flow-ids <values...>`	flow ids
`--schema-ids <values...>`	schema ids
`--experience-ids <values...>`	experience ids
`--new-children-order <values...>`	new children order
`--destination-children-hash <value>`	destination children hash
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic folders reorder [options]`

Reorder the items in a folder.

POST /spaces/{spaceId}/folders/reorder-children

Option	Description
`--folder-id <value>`	folder id (required)
`--children <values...>`	children (required)
`--children-hash <value>`	children hash
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic folders tree [options]`

Get a Space's folder tree.

GET /spaces/{spaceId}/folders

`ligantic folders update [options] <folderId>`

Rename or restyle a folder.

PATCH /spaces/{spaceId}/folders/{folderId}

Argument	Description
`<folderId>`	The folder id

Option	Description
`--name <value>`	name
`--icon <value>`	icon
`--default-open [bool]`	default open
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic organisations`

Manage organisations

`ligantic organisations agents api-keys create [options] <controllingOrganisationId> <agentId>`

Create an API key for an organisation agent.

POST /organisations/{controllingOrganisationId}/agents/{agentId}/api-keys

Argument	Description
`<controllingOrganisationId>`	The controlling organisation id
`<agentId>`	The agent id

Option	Description
`--name <value>`	name
`--expires-at <value>`	expires at
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic organisations agents api-keys delete [options] <controllingOrganisationId> <agentId> <apiKeyId>`

Delete an organisation agent's API key.

DELETE /organisations/{controllingOrganisationId}/agents/{agentId}/api-keys/{apiKeyId} — destructive, requires --yes

Argument	Description
`<controllingOrganisationId>`	The controlling organisation id
`<agentId>`	The agent id
`<apiKeyId>`	The api key id

`ligantic organisations agents api-keys list [options] <controllingOrganisationId> <agentId>`

List an organisation agent's API keys.

GET /organisations/{controllingOrganisationId}/agents/{agentId}/api-keys

Argument	Description
`<controllingOrganisationId>`	The controlling organisation id
`<agentId>`	The agent id

`ligantic organisations agents create [options] <controllingOrganisationId>`

Create an organisation agent.

POST /organisations/{controllingOrganisationId}/agents

Argument	Description
`<controllingOrganisationId>`	The controlling organisation id

Option	Description
`--name <value>`	name
`--join-organisation-as-member [bool]`	If true, the agent will be added as a member of the organisation. By default, the agent will not be added as a member. (server default: false)
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic organisations agents delete [options] <controllingOrganisationId> <agentId>`

Delete an organisation agent.

DELETE /organisations/{controllingOrganisationId}/agents/{agentId} — destructive, requires --yes

Argument	Description
`<controllingOrganisationId>`	The controlling organisation id
`<agentId>`	The agent id

`ligantic organisations agents list [options] <controllingOrganisationId>`

List an organisation's agents.

GET /organisations/{controllingOrganisationId}/agents

Argument	Description
`<controllingOrganisationId>`	The controlling organisation id

`ligantic organisations agents show [options] <controllingOrganisationId> <agentId>`

Get an organisation agent.

GET /organisations/{controllingOrganisationId}/agents/{agentId}

Argument	Description
`<controllingOrganisationId>`	The controlling organisation id
`<agentId>`	The agent id

`ligantic organisations agents spaces [options] <controllingOrganisationId> <agentId>`

List the Spaces an organisation agent belongs to.

GET /organisations/{controllingOrganisationId}/agents/{agentId}/spaces

Argument	Description
`<controllingOrganisationId>`	The controlling organisation id
`<agentId>`	The agent id

`ligantic organisations billing accounts create [options] <organisationId>`

Create an organisation billing account.

Create a new billing account for an organisation

POST /organisations/{organisationId}/billing/accounts

Argument	Description
`<organisationId>`	The organisation id

Option	Description
`--name <value>`	name (required)
`--organisation-address-id <value>`	organisation address id (required)
`--tax-id <json>`	tax id (required; JSON)
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic organisations billing accounts list [options] <organisationId>`

List an organisation's billing accounts.

Get all billing accounts for an organisation

GET /organisations/{organisationId}/billing/accounts

Argument	Description
`<organisationId>`	The organisation id

`ligantic organisations billing accounts show [options] <organisationId> <organisationBillingAccountId>`

Get an organisation billing account.

Get a specific billing account for an organisation

GET /organisations/{organisationId}/billing/accounts/{organisationBillingAccountId}

Argument	Description
`<organisationId>`	The organisation id
`<organisationBillingAccountId>`	The organisation billing account id

`ligantic organisations billing addresses create [options] <organisationId>`

Create an organisation billing address.

Create a new billing address for an organisation

POST /organisations/{organisationId}/billing/addresses

Argument	Description
`<organisationId>`	The organisation id

Option	Description
`--type <value>`	type (required) One of: `Billing`, `Shipping`.
`--name <value>`	name (required)
`--address-line1 <value>`	address line1 (required)
`--address-line2 <value>`	address line2
`--city <value>`	city (required)
`--state <value>`	state (required)
`--postal-code <value>`	postal code (required)
`--country <value>`	country (required)
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic organisations billing addresses list [options] <organisationId>`

List an organisation's billing addresses.

Get all billing addresses for an organisation

GET /organisations/{organisationId}/billing/addresses

Argument	Description
`<organisationId>`	The organisation id

`ligantic organisations billing addresses show [options] <organisationId> <organisationAddressId>`

Get an organisation billing address.

Get a specific billing address for an organisation

GET /organisations/{organisationId}/billing/addresses/{organisationAddressId}

Argument	Description
`<organisationId>`	The organisation id
`<organisationAddressId>`	The organisation address id

`ligantic organisations billing credits list [options] <organisationId> <organisationBillingAccountId>`

List the credits of an organisation billing account.

Get all credits for a billing account

GET /organisations/{organisationId}/billing/accounts/{organisationBillingAccountId}/credits

Argument	Description
`<organisationId>`	The organisation id
`<organisationBillingAccountId>`	The organisation billing account id

`ligantic organisations billing credits usages [options] <organisationId> <organisationBillingAccountId> <organisationCreditId>`

List the usage recorded against an organisation credit.

Get usage statistics for a specific credit

GET /organisations/{organisationId}/billing/accounts/{organisationBillingAccountId}/credits/{organisationCreditId}/usages

Argument	Description
`<organisationId>`	The organisation id
`<organisationBillingAccountId>`	The organisation billing account id
`<organisationCreditId>`	The organisation credit id

Option	Description
`--offset <number>`	offset (server default: 0)
`--limit <number>`	limit (server default: 10)

`ligantic organisations create [options]`

Create an organisation.

Create a new organisation

POST /organisations

Option	Description
`--display-name <value>`	display name (required)
`--labels <json>`	labels (JSON)
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic organisations delete [options] <organisationId>`

Delete an organisation.

Remove an organisation

DELETE /organisations/{organisationId} — destructive, requires --yes

Argument	Description
`<organisationId>`	The organisation id

`ligantic organisations invites accept [options] <organisationInviteId>`

Accept an organisation invite.

POST /organisations/invites/{organisationInviteId}/accept

Argument	Description
`<organisationInviteId>`	The organisation invite id

`ligantic organisations invites decline [options] <organisationInviteId>`

Decline an organisation invite.

POST /organisations/invites/{organisationInviteId}/decline

Argument	Description
`<organisationInviteId>`	The organisation invite id

`ligantic organisations invites pending [options]`

List your pending organisation invites.

Get all pending invites for the authenticated user

GET /organisations/invites/pending

`ligantic organisations leave [options] <organisationId>`

Leave an organisation.

POST /organisations/{organisationId}/leave — destructive, requires --yes

Argument	Description
`<organisationId>`	The organisation id

`ligantic organisations list [options]`

List your organisations.

Get all organisations for the authenticated user

GET /organisations

`ligantic organisations members set-role [options] <organisationId> <membershipId>`

Change an organisation member's role.

Update a member's role in an organisation

PATCH /organisations/{organisationId}/members/{membershipId}/role

Argument	Description
`<organisationId>`	The organisation id
`<membershipId>`	The membership id

Option	Description
`--membership-type <value>`	membership type (required) One of: `owner`, `member`.
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic organisations show [options] <organisationId>`

Get an organisation.

Get an organisation by ID

GET /organisations/{organisationId}

Argument	Description
`<organisationId>`	The organisation id

`ligantic organisations spaces join [options] <organisationId>`

Join an organisation's Space.

Join a space within an organisation

POST /organisations/{organisationId}/spaces/{spaceId}/join

Argument	Description
`<organisationId>`	The organisation id

Option	Description
`--as-agent-id <value>`	as agent id
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic organisations spaces list [options] <organisationId>`

List an organisation's Spaces.

Get all spaces for an organisation

GET /organisations/{organisationId}/spaces

Argument	Description
`<organisationId>`	The organisation id

Option	Description
`--as-agent-id <value>`	as agent id

`ligantic organisations spaces set-billing-account [options] <organisationId>`

Set the billing account of an organisation's Space.

Set the billing account for a space

POST /organisations/{organisationId}/spaces/{spaceId}/set-billing-account

Argument	Description
`<organisationId>`	The organisation id

Option	Description
`--organisation-billing-account-id <value>`	organisation billing account id (required)
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic organisations spaces transfer-to-organisation [options] <organisationId>`

Transfer a Space to an organisation.

Transfer a space to another organisation

POST /organisations/{organisationId}/spaces/{spaceId}/transfer-to-organisation — destructive, requires --yes

Argument	Description
`<organisationId>`	The organisation id

Option	Description
`--organisation-billing-account-id <value>`	organisation billing account id
`--data <json>`	The request body as JSON, @file, or - for stdin; flags override its fields

`ligantic organisations spaces transfer-to-user [options] <organisationId>`

Transfer a Space to a user.

Transfer a space to your user

POST /organisations/{organisationId}/spaces/{spaceId}/transfer-to-user — destructive, requires --yes

Argument	Description
`<organisationId>`	The organisation id