Prismatic CLI Command Reference

The Prismatic CLI tool allows you to interact with the Prismatic API programmatically so you can build, deploy, and support integrations from the command line. This page lists the subcommands of prism that you can invoke. For an introduction on using the Prismatic CLI tool, see the CLI usage page.

---

Alerts CLI Commands

alerts events list

List Alert Events for an Alert Monitor

prism alerts events list <alertMonitorId> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--columns <string>] [--csv] [--extended] [--filter <string>] [--[no-]header] [--[no-]truncate] [--output {csv,json,yaml}] [--sort <string>]

Flag	Shorthand	Description	Required
alertMonitorId		ID of an alert monitor	true
--agent		Force structured output optimized for AI agents	false
--columns		only show provided columns (comma-separated)	false
--csv		output is csv format [alias: --output=csv]	false
--extended	-x	show extra columns	false
--filter		filter property by regex, ex: name=^foo (prefix key with - to invert)	false
--[no-]header		show table headers (use --no-header to hide them)	false
--output csv,json,yaml		output in a more machine friendly format	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--sort		property to sort by, comma-separated for multi-key (prepend '-' for descending)	false
--[no-]truncate		truncate output to fit the screen (use --no-truncate for full values)	false
--yes		Approve non-interactive confirmation prompts	false

alerts groups create

Create an Alert Group

prism alerts groups create [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] --name <string> [--users <string>] [--webhooks <string>]

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--name		name of the group to be created	true
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--users		JSON-formatted list of Prismatic user IDs to alert	false
--webhooks		JSON-formatted list of Alert Webhook IDs to alert	false
--yes		Approve non-interactive confirmation prompts	false

Create a group for 'DevOps':

prism alerts groups create --name DevOps --users [\"$(prism organization:users:list --columns id --filter 'Name=John Doe' --no-header)\"]

alerts groups delete

Delete an Alert Group

prism alerts groups delete <group> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes]

Flag	Shorthand	Description	Required
group		ID of the group to delete	true
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

alerts groups list

List Alert Groups in your Organization

prism alerts groups list [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--columns <string>] [--csv] [--extended] [--filter <string>] [--[no-]header] [--[no-]truncate] [--output {csv,json,yaml}] [--sort <string>] [--after <string>] [--all] [--first <number>]

Flag	Shorthand	Description	Required
--after		Resume listing after this API cursor	false
--agent		Force structured output optimized for AI agents	false
--all		Fetch every page instead of returning one resumable page	false
--columns		only show provided columns (comma-separated)	false
--csv		output is csv format [alias: --output=csv]	false
--extended	-x	show extra columns	false
--filter		filter property by regex, ex: name=^foo (prefix key with - to invert)	false
--first		Maximum number of records to request per API page	false
--[no-]header		show table headers (use --no-header to hide them)	false
--output csv,json,yaml		output in a more machine friendly format	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--sort		property to sort by, comma-separated for multi-key (prepend '-' for descending)	false
--[no-]truncate		truncate output to fit the screen (use --no-truncate for full values)	false
--yes		Approve non-interactive confirmation prompts	false

Fetch the ID and Name of all alert groups in JSON format, sorted descending by name:

prism alerts groups list --columns id,name --output json --sort name

alerts monitors clear

Clear an Alert Monitor

prism alerts monitors clear <monitor> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes]

Flag	Shorthand	Description	Required
monitor		ID of the monitor to clear	true
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

alerts monitors create

Create an Alert Monitor by attaching an Alert Trigger and a set of users and webhooks to an Instance. While individual users and webhooks can be tied to alert monitors, it is recommended that you create alert groups and attach alert groups to alert monitors. This helps in the case that you need to add a user to a set of monitors: it's simpler to edit a single alert group than to edit dozens of alert monitors.

prism alerts monitors create [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] --name <string> --instance <string> --triggers <string> [--duration <number>] [--log-severity <number>] [--groups <string>] [--users <string>]

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--duration		greatest time allowed (in seconds) for time-based triggers	false
--groups		JSON-formatted list of group IDs to alert	false
--instance		ID of the instance to monitor	true
--log-severity		greatest log level (debug, info, warn, error) allowed for log-based triggers	false
--name		name of the alert monitor to be created	true
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--triggers		JSON-formatted list of trigger IDs that should trigger this monitor	true
--users		JSON-formatted list of Prismatic user IDs alert	false
--yes		Approve non-interactive confirmation prompts	false

Create an alert monitor that alerts the DevOps group when an instance execution takes longer than 10 seconds:

prism alerts monitors create --name Alert Devops of slow execution --instance INSTANCE_ID --triggers ["TRIGGER_ID"] --duration 10 --groups ["ALERT_GROUP_ID"]

alerts monitors delete

Delete an Alert Monitor

prism alerts monitors delete <monitor> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes]

Flag	Shorthand	Description	Required
monitor		ID of the monitor to delete	true
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

alerts monitors list

List Alert Monitors for Customer Instances

prism alerts monitors list [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--columns <string>] [--csv] [--extended] [--filter <string>] [--[no-]header] [--[no-]truncate] [--output {csv,json,yaml}] [--sort <string>] [--after <string>] [--all] [--first <number>]

Flag	Shorthand	Description	Required
--after		Resume listing after this API cursor	false
--agent		Force structured output optimized for AI agents	false
--all		Fetch every page instead of returning one resumable page	false
--columns		only show provided columns (comma-separated)	false
--csv		output is csv format [alias: --output=csv]	false
--extended	-x	show extra columns	false
--filter		filter property by regex, ex: name=^foo (prefix key with - to invert)	false
--first		Maximum number of records to request per API page	false
--[no-]header		show table headers (use --no-header to hide them)	false
--output csv,json,yaml		output in a more machine friendly format	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--sort		property to sort by, comma-separated for multi-key (prepend '-' for descending)	false
--[no-]truncate		truncate output to fit the screen (use --no-truncate for full values)	false
--yes		Approve non-interactive confirmation prompts	false

alerts triggers list

List Alert Triggers

prism alerts triggers list [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--columns <string>] [--csv] [--extended] [--filter <string>] [--[no-]header] [--[no-]truncate] [--output {csv,json,yaml}] [--sort <string>]

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--columns		only show provided columns (comma-separated)	false
--csv		output is csv format [alias: --output=csv]	false
--extended	-x	show extra columns	false
--filter		filter property by regex, ex: name=^foo (prefix key with - to invert)	false
--[no-]header		show table headers (use --no-header to hide them)	false
--output csv,json,yaml		output in a more machine friendly format	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--sort		property to sort by, comma-separated for multi-key (prepend '-' for descending)	false
--[no-]truncate		truncate output to fit the screen (use --no-truncate for full values)	false
--yes		Approve non-interactive confirmation prompts	false

alerts webhooks create

Create an Alert Webhook

prism alerts webhooks create [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] --name <string> --url <string> [--headers <string>] --payload-template <string>

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--headers		JSON-formatted object of key/value pairs to include in the request header	false
--name		name of the webhook to be created	true
--payload-template		template string that will be used as the request body, see documentation for details	true
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--url		URL that will receive a POST request for an alert	true
--yes		Approve non-interactive confirmation prompts	false

alerts webhooks delete

Delete an Alert Webhook

prism alerts webhooks delete <webhook> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes]

Flag	Shorthand	Description	Required
webhook		ID of the webhook to delete	true
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

alerts webhooks list

List Alert Webhooks

prism alerts webhooks list [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--columns <string>] [--csv] [--extended] [--filter <string>] [--[no-]header] [--[no-]truncate] [--output {csv,json,yaml}] [--sort <string>] [--after <string>] [--all] [--first <number>]

Flag	Shorthand	Description	Required
--after		Resume listing after this API cursor	false
--agent		Force structured output optimized for AI agents	false
--all		Fetch every page instead of returning one resumable page	false
--columns		only show provided columns (comma-separated)	false
--csv		output is csv format [alias: --output=csv]	false
--extended	-x	show extra columns	false
--filter		filter property by regex, ex: name=^foo (prefix key with - to invert)	false
--first		Maximum number of records to request per API page	false
--[no-]header		show table headers (use --no-header to hide them)	false
--output csv,json,yaml		output in a more machine friendly format	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--sort		property to sort by, comma-separated for multi-key (prepend '-' for descending)	false
--[no-]truncate		truncate output to fit the screen (use --no-truncate for full values)	false
--yes		Approve non-interactive confirmation prompts	false

---

Autocomplete CLI Commands

autocomplete

Display autocomplete installation instructions.

prism autocomplete [<shell>] [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--refresh-cache]

Flag	Shorthand	Description	Required
shell			false
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--refresh-cache		Refresh cache (ignores displaying instructions)	false
--yes		Approve non-interactive confirmation prompts	false

prism autocomplete

prism autocomplete bash

prism autocomplete zsh

prism autocomplete powershell

prism autocomplete --refresh-cache true

autocomplete script

outputs autocomplete config script for shells

prism autocomplete script [<shell>] [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes]

Flag	Shorthand	Description	Required
shell			false
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

---

Components CLI Commands

components actions get

Describe one action: capabilities, inputs, example payload, and output schema

prism components actions get <componentKey> <actionKey> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--public] [--private] [--version <number>]

Flag	Shorthand	Description	Required
actionKey		The key of the action (e.g. 'postMessage')	true
componentKey		The key of the component that provides the action (e.g. 'salesforce')	true
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--private		Show actions for the private component with the given key. Use this flag when you have a private component with the same key as a public component.	false
--profile		Use a profile	false
--public		Show actions for the public component with the given key. Use this flag when you have a private component with the same key as a public component.	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--version		Pin a specific component version (defaults to the latest version)	false
--yes		Approve non-interactive confirmation prompts	false

Describe an action of the Slack component:

prism components actions get slack postMessage

components actions list

List Actions that Components implement

prism components actions list <componentKey> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--columns <string>] [--csv] [--extended] [--filter <string>] [--[no-]header] [--[no-]truncate] [--output {csv,json,yaml}] [--sort <string>] [--after <string>] [--all] [--first <number>] [--public] [--private] [--version <number>] [--search <string>]

Flag	Shorthand	Description	Required
componentKey		The key of the component to show actions for (e.g. 'salesforce')	true
--after		Resume listing after this API cursor	false
--agent		Force structured output optimized for AI agents	false
--all		Fetch every page instead of returning one resumable page	false
--columns		only show provided columns (comma-separated)	false
--csv		output is csv format [alias: --output=csv]	false
--extended	-x	show extra columns	false
--filter		filter property by regex, ex: name=^foo (prefix key with - to invert)	false
--first		Maximum number of records to request per API page	false
--[no-]header		show table headers (use --no-header to hide them)	false
--output csv,json,yaml		output in a more machine friendly format	false
--print-requests		Print all GraphQL requests that are issued	false
--private		Show actions for the private component with the given key. Use this flag when you have a private component with the same key as a public component.	false
--profile		Use a profile	false
--public		Show actions for the public component with the given key. Use this flag when you have a private component with the same key as a public component.	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--search		Full-text search across action labels and descriptions	false
--sort		property to sort by, comma-separated for multi-key (prepend '-' for descending)	false
--[no-]truncate		truncate output to fit the screen (use --no-truncate for full values)	false
--version		Pin a specific component version (defaults to the latest version)	false
--yes		Approve non-interactive confirmation prompts	false

List actions of the Slack component:

prism components actions list slack

Search the actions of a component by keyword:

prism components actions list salesforce --search record

components connections get

Describe one connection: authentication type, templates, and every input field

prism components connections get <componentKey> <connectionKey> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--public] [--private] [--version <number>]

Flag	Shorthand	Description	Required
componentKey		The key of the component that provides the connection (e.g. 'salesforce')	true
connectionKey		The key of the connection (for example 'oauth2')	true
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--private		Show details for the private component with the given key. Use this flag when you have a private component with the same key as a public component.	false
--profile		Use a profile	false
--public		Show details for the public component with the given key. Use this flag when you have a private component with the same key as a public component.	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--version		Pin a specific component version (defaults to the latest version)	false
--yes		Approve non-interactive confirmation prompts	false

Describe the Slack OAuth 2.0 connection:

prism components connections get slack oauth2

components connections list

List the connections a component provides and the inputs each one requires

prism components connections list <componentKey> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--columns <string>] [--csv] [--extended] [--filter <string>] [--[no-]header] [--[no-]truncate] [--output {csv,json,yaml}] [--sort <string>] [--public] [--private] [--version <number>]

Flag	Shorthand	Description	Required
componentKey		The key of the component to list connections for (e.g. 'salesforce')	true
--agent		Force structured output optimized for AI agents	false
--columns		only show provided columns (comma-separated)	false
--csv		output is csv format [alias: --output=csv]	false
--extended	-x	show extra columns	false
--filter		filter property by regex, ex: name=^foo (prefix key with - to invert)	false
--[no-]header		show table headers (use --no-header to hide them)	false
--output csv,json,yaml		output in a more machine friendly format	false
--print-requests		Print all GraphQL requests that are issued	false
--private		Show details for the private component with the given key. Use this flag when you have a private component with the same key as a public component.	false
--profile		Use a profile	false
--public		Show details for the public component with the given key. Use this flag when you have a private component with the same key as a public component.	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--sort		property to sort by, comma-separated for multi-key (prepend '-' for descending)	false
--[no-]truncate		truncate output to fit the screen (use --no-truncate for full values)	false
--version		Pin a specific component version (defaults to the latest version)	false
--yes		Approve non-interactive confirmation prompts	false

List connections of the Slack component:

prism components connections list slack

components data-sources get

Describe one data source: capabilities, inputs, example payload, and output schema

prism components data-sources get <componentKey> <dataSourceKey> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--public] [--private] [--version <number>]

Flag	Shorthand	Description	Required
componentKey		The key of the component that provides the data source (e.g. 'salesforce')	true
dataSourceKey		The key of the data source (e.g. 'selectChannels')	true
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--private		Show data sources for the private component with the given key. Use this flag when you have a private component with the same key as a public component.	false
--profile		Use a profile	false
--public		Show data sources for the public component with the given key. Use this flag when you have a private component with the same key as a public component.	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--version		Pin a specific component version (defaults to the latest version)	false
--yes		Approve non-interactive confirmation prompts	false

Describe a data source of the Slack component:

prism components data-sources get slack selectChannels

components data-sources list

List Data Sources that Components implement

prism components data-sources list <componentKey> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--columns <string>] [--csv] [--extended] [--filter <string>] [--[no-]header] [--[no-]truncate] [--output {csv,json,yaml}] [--sort <string>] [--after <string>] [--all] [--first <number>] [--public] [--private] [--version <number>] [--search <string>] [--type <string>]

Flag	Shorthand	Description	Required
componentKey		The key of the component to show data sources for (e.g. 'salesforce')	true
--after		Resume listing after this API cursor	false
--agent		Force structured output optimized for AI agents	false
--all		Fetch every page instead of returning one resumable page	false
--columns		only show provided columns (comma-separated)	false
--csv		output is csv format [alias: --output=csv]	false
--extended	-x	show extra columns	false
--filter		filter property by regex, ex: name=^foo (prefix key with - to invert)	false
--first		Maximum number of records to request per API page	false
--[no-]header		show table headers (use --no-header to hide them)	false
--output csv,json,yaml		output in a more machine friendly format	false
--print-requests		Print all GraphQL requests that are issued	false
--private		Show data sources for the private component with the given key. Use this flag when you have a private component with the same key as a public component.	false
--profile		Use a profile	false
--public		Show data sources for the public component with the given key. Use this flag when you have a private component with the same key as a public component.	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--search		Full-text search across data source labels and descriptions	false
--sort		property to sort by, comma-separated for multi-key (prepend '-' for descending)	false
--[no-]truncate		truncate output to fit the screen (use --no-truncate for full values)	false
--type		Only list data sources that produce this type (for example picklist or jsonform)	false
--version		Pin a specific component version (defaults to the latest version)	false
--yes		Approve non-interactive confirmation prompts	false

List data sources of the Slack component:

prism components data-sources list slack

List only picklist data sources:

prism components data-sources list salesforce --type picklist

components delete

Delete a Component

prism components delete <component> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes]

Flag	Shorthand	Description	Required
component		ID of the component to delete	true
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

components dev run

Fetch an integration's active connection and execute a CLI command with that connection's fields as an environment variable. After specifying an integration ID and connection config variable name, this command executes a CLI command with that connection's fields saved as a config variable named PRISMATIC_CONNECTION_VALUE.

prism components dev run [<command>...] [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--integration-id <string>] [--instance-id <string>] --connection-key <string>

Flag	Shorthand	Description	Required
command		Local command and arguments to run	false
--agent		Force structured output optimized for AI agents	false
--connection-key		Key of the connection config variable to fetch meta/state for	true
--instance-id		Instance ID.	false
--integration-id		Integration ID	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

components dev test

Run an action of a component within a test integration in the integration runner

prism components dev test [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--action <string>] [--action-inputs <string>] [--env-path <string>] [--[no-]build] [--output-file <string>] [--print-results] [--clean-up] [--connection <string>] [--connection-inputs <string>]

Flag	Shorthand	Description	Required
--action		Action key to test (required in agent mode)	false
--action-inputs		JSON object containing action input values (agent mode)	false
--agent		Force structured output optimized for AI agents	false
--[no-]build		Build the component prior to testing	false
--clean-up		Clean up the integration and temporary component after running the action	false
--connection		Connection key to test (agent mode)	false
--connection-inputs		JSON object containing connection input values (agent mode)	false
--env-path		Path to dotenv file to load for supplying testing values	false
--output-file		Output the results of the action to a specified file	false
--print-requests		Print all GraphQL requests that are issued	false
--print-results		Print the results of the action to stdout	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

components get

Describe a component: identity, version, and every action, trigger, data source, and connection it provides

prism components get <componentKey> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--public] [--private] [--version <number>]

Flag	Shorthand	Description	Required
componentKey		The key of the component to describe (e.g. 'salesforce')	true
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--private		Show details for the private component with the given key. Use this flag when you have a private component with the same key as a public component.	false
--profile		Use a profile	false
--public		Show details for the public component with the given key. Use this flag when you have a private component with the same key as a public component.	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--version		Pin a specific component version (defaults to the latest version)	false
--yes		Approve non-interactive confirmation prompts	false

Describe the latest Slack component:

prism components get slack

Describe a pinned version of a private component:

prism components get acme --private true --version 3

components init

Initialize a new Component

prism components init <name> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--npm-package <string>] [--wsdl-path <string>] [--open-api-path <string>] [--verbose] [--toolchain {modern,legacy}]

Flag	Shorthand	Description	Required
name		Name of the new component to create (alphanumeric characters, hyphens, and underscores)	true
--agent		Force structured output optimized for AI agents	false
--npm-package		Enable npm registry publishing with this package name (for example @your-org/acme); does not make the platform component public	false
--open-api-path		The path to an OpenAPI Specification file (JSON or YAML) used to generate a Component	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--toolchain modern,legacy		Toolchain to scaffold: 'modern' (tsdown + vitest + Biome) or 'legacy' (webpack + jest + eslint)	false
--verbose		Output more verbose logging from Component generation	false
--wsdl-path		Path to the WSDL definition file used to generate a Component	false
--yes		Approve non-interactive confirmation prompts	false

Initialize a new component directory for a component named 'send-customer-invoices':

prism components init send-customer-invoices

Initialize a component from a WSDL definition file:

prism components init example-wsdl --wsdl-path ./example.wsdl

components init component

Initialize a new Component

prism components init component [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--name <string>] [--description <string>]

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--description		Description for the component	false
--name		Name of the component	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

components list

List available Components

prism components list [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--columns <string>] [--csv] [--extended] [--filter <string>] [--[no-]header] [--[no-]truncate] [--output {csv,json,yaml}] [--sort <string>] [--after <string>] [--all] [--first <number>] [--public] [--private] [--show-all-versions] [--search <string>] [--fulltext <string>] [--category <string>] [--has-actions] [--has-triggers] [--has-data-sources] [--data-source-type <string>] [--has-connections]

Flag	Shorthand	Description	Required
--after		Resume listing after this API cursor	false
--agent		Force structured output optimized for AI agents	false
--all		Fetch every page instead of returning one resumable page	false
--category		Only list components in this category	false
--columns		only show provided columns (comma-separated)	false
--csv		output is csv format [alias: --output=csv]	false
--data-source-type		Only list components that provide data sources of this type (for example PICKLIST)	false
--extended	-x	show extra columns	false
--filter		filter property by regex, ex: name=^foo (prefix key with - to invert)	false
--first		Maximum number of records to request per API page	false
--fulltext		Full-text search across component and action labels and descriptions	false
--has-actions		Only list components that provide actions	false
--has-connections		Only list components that provide connections	false
--has-data-sources		Only list components that provide data sources	false
--has-triggers		Only list components that provide triggers	false
--[no-]header		show table headers (use --no-header to hide them)	false
--output csv,json,yaml		output in a more machine friendly format	false
--print-requests		Print all GraphQL requests that are issued	false
--private		Only include private components	false
--profile		Use a profile	false
--public		Only include public components	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--search		Search components by label first, then by key (case insensitive)	false
--show-all-versions		If specified this command returns all versions of all components rather than only the latest version	false
--sort		property to sort by, comma-separated for multi-key (prepend '-' for descending)	false
--[no-]truncate		truncate output to fit the screen (use --no-truncate for full values)	false
--yes		Approve non-interactive confirmation prompts	false

List every component you can use:

prism components list

Find components whose key or label mentions Salesforce:

prism components list --search sales

List private components that provide triggers:

prism components list --private true --hasTriggers true

List components that provide picklist data sources:

prism components list --dataSourceType picklist

components publish

Publish a Component to Prismatic

prism components publish [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--comment <string>] [--[no-]check-signature] [--skip-on-signature-match] [--customer <string>] [--commit-hash <string>] [--commit-url <string>] [--repo-url <string>] [--pull-request-url <string>] [--include-source] [--[no-]wait] [--wait-timeout <number>]

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--[no-]check-signature		Check signature of existing component and confirm publish if matched	false
--comment		Comment about changes in this Publish	false
--commit-hash		Commit hash corresponding to the component version being published	false
--commit-url		URL to the commit details for this component version	false
--customer		ID of customer with which to associate the component	false
--include-source		Include source code in the component publish	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--pull-request-url		URL to the pull request that modified this component version	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--repo-url		URL to the repository containing the component definition	false
--skip-on-signature-match		Skips component publish if the new signature matches the existing signature	false
--[no-]wait		Wait until the published version is available for use (use --no-wait to return as soon as the publish is submitted)	false
--wait-timeout		Seconds to wait until the published version is available for use	false
--yes		Approve non-interactive confirmation prompts	false

Publish a component after building it with npm run build:

prism components publish

components search

Search components, actions, triggers, and data sources with the same ranked search the Designer uses

prism components search <terms> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--columns <string>] [--csv] [--extended] [--filter <string>] [--[no-]header] [--[no-]truncate] [--output {csv,json,yaml}] [--sort <string>] [--kind {all,components,actions,triggers,data-sources}] [--category <string>] [--public] [--private]

Flag	Shorthand	Description	Required
terms		Search terms matched against component and action metadata	true
--agent		Force structured output optimized for AI agents	false
--category		Only include components in this category (see 'prism components list')	false
--columns		only show provided columns (comma-separated)	false
--csv		output is csv format [alias: --output=csv]	false
--extended	-x	show extra columns	false
--filter		filter property by regex, ex: name=^foo (prefix key with - to invert)	false
--[no-]header		show table headers (use --no-header to hide them)	false
--kind all,components,actions,triggers,data-sources		Restrict results to one kind of catalog entry	false
--output csv,json,yaml		output in a more machine friendly format	false
--print-requests		Print all GraphQL requests that are issued	false
--private		Only include private components	false
--profile		Use a profile	false
--public		Only include public components	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--sort		property to sort by, comma-separated for multi-key (prepend '-' for descending)	false
--[no-]truncate		truncate output to fit the screen (use --no-truncate for full values)	false
--yes		Approve non-interactive confirmation prompts	false

Find anything related to posting Slack messages:

prism components search slack message

Find triggers that fire when records change:

prism components search new record --kind triggers

Find picklist data sources for a config wizard:

prism components search select channel --kind data-sources

components signature

Generate a Component signature

prism components signature [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--skip-signature-verify]

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--skip-signature-verify		This consistently returns a signature, regardless of whether the corresponding component has been published to the platform or not.	false
--yes		Approve non-interactive confirmation prompts	false

components triggers get

Describe one trigger: capabilities, inputs, example payload, and output schema

prism components triggers get <componentKey> <triggerKey> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--public] [--private] [--version <number>]

Flag	Shorthand	Description	Required
componentKey		The key of the component that provides the trigger (e.g. 'salesforce')	true
triggerKey		The key of the trigger (e.g. 'webhook')	true
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--private		Show actions for the private component with the given key. Use this flag when you have a private component with the same key as a public component.	false
--profile		Use a profile	false
--public		Show actions for the public component with the given key. Use this flag when you have a private component with the same key as a public component.	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--version		Pin a specific component version (defaults to the latest version)	false
--yes		Approve non-interactive confirmation prompts	false

Describe a trigger of the Universal Webhook component:

prism components triggers get webhook-triggers webhook

components triggers list

List Triggers that Components implement

prism components triggers list <componentKey> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--columns <string>] [--csv] [--extended] [--filter <string>] [--[no-]header] [--[no-]truncate] [--output {csv,json,yaml}] [--sort <string>] [--after <string>] [--all] [--first <number>] [--public] [--private] [--version <number>] [--search <string>]

Flag	Shorthand	Description	Required
componentKey		The key of the component to show triggers for (e.g. 'salesforce')	true
--after		Resume listing after this API cursor	false
--agent		Force structured output optimized for AI agents	false
--all		Fetch every page instead of returning one resumable page	false
--columns		only show provided columns (comma-separated)	false
--csv		output is csv format [alias: --output=csv]	false
--extended	-x	show extra columns	false
--filter		filter property by regex, ex: name=^foo (prefix key with - to invert)	false
--first		Maximum number of records to request per API page	false
--[no-]header		show table headers (use --no-header to hide them)	false
--output csv,json,yaml		output in a more machine friendly format	false
--print-requests		Print all GraphQL requests that are issued	false
--private		Show actions for the private component with the given key. Use this flag when you have a private component with the same key as a public component.	false
--profile		Use a profile	false
--public		Show actions for the public component with the given key. Use this flag when you have a private component with the same key as a public component.	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--search		Full-text search across trigger labels and descriptions	false
--sort		property to sort by, comma-separated for multi-key (prepend '-' for descending)	false
--[no-]truncate		truncate output to fit the screen (use --no-truncate for full values)	false
--version		Pin a specific component version (defaults to the latest version)	false
--yes		Approve non-interactive confirmation prompts	false

List triggers of the Universal Webhook component:

prism components triggers list webhook-triggers

Search the triggers of a component by keyword:

prism components triggers list salesforce --search record

components versions

List the published versions of a component

prism components versions <componentKey> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--columns <string>] [--csv] [--extended] [--filter <string>] [--[no-]header] [--[no-]truncate] [--output {csv,json,yaml}] [--sort <string>] [--after <string>] [--all] [--first <number>] [--public] [--private]

Flag	Shorthand	Description	Required
componentKey		The key of the component to list versions for (e.g. 'salesforce')	true
--after		Resume listing after this API cursor	false
--agent		Force structured output optimized for AI agents	false
--all		Fetch every page instead of returning one resumable page	false
--columns		only show provided columns (comma-separated)	false
--csv		output is csv format [alias: --output=csv]	false
--extended	-x	show extra columns	false
--filter		filter property by regex, ex: name=^foo (prefix key with - to invert)	false
--first		Maximum number of records to request per API page	false
--[no-]header		show table headers (use --no-header to hide them)	false
--output csv,json,yaml		output in a more machine friendly format	false
--print-requests		Print all GraphQL requests that are issued	false
--private		Show details for the private component with the given key. Use this flag when you have a private component with the same key as a public component.	false
--profile		Use a profile	false
--public		Show details for the public component with the given key. Use this flag when you have a private component with the same key as a public component.	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--sort		property to sort by, comma-separated for multi-key (prepend '-' for descending)	false
--[no-]truncate		truncate output to fit the screen (use --no-truncate for full values)	false
--yes		Approve non-interactive confirmation prompts	false

List versions of the Slack component:

prism components versions slack

---

Customers CLI Commands

customers create

Create a new Customer

prism customers create [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] --name <string> [--description <string>] [--external-id <string>] [--label <string>...]

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--description		longer description of the customer	false
--external-id		external ID of the customer from your system	false
--label		a label to apply to the customer	false
--name		short name of the new customer	true
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

Apply multiple labels to a customer

prism customers create --name Widgets Inc --externalId abc-123 --label Prod Customers,Beta Testers

customers delete

Delete a Customer

prism customers delete <customer> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes]

Flag	Shorthand	Description	Required
customer		ID of the customer to delete	true
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

customers list

List your Customers

prism customers list [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--columns <string>] [--csv] [--extended] [--filter <string>] [--[no-]header] [--[no-]truncate] [--output {csv,json,yaml}] [--sort <string>] [--after <string>] [--all] [--first <number>]

Flag	Shorthand	Description	Required
--after		Resume listing after this API cursor	false
--agent		Force structured output optimized for AI agents	false
--all		Fetch every page instead of returning one resumable page	false
--columns		only show provided columns (comma-separated)	false
--csv		output is csv format [alias: --output=csv]	false
--extended	-x	show extra columns	false
--filter		filter property by regex, ex: name=^foo (prefix key with - to invert)	false
--first		Maximum number of records to request per API page	false
--[no-]header		show table headers (use --no-header to hide them)	false
--output csv,json,yaml		output in a more machine friendly format	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--sort		property to sort by, comma-separated for multi-key (prepend '-' for descending)	false
--[no-]truncate		truncate output to fit the screen (use --no-truncate for full values)	false
--yes		Approve non-interactive confirmation prompts	false

customers update

Update a Customer

prism customers update <customer> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--name <string>] [--description <string>] [--external-id <string>] [--label <string>...]

Flag	Shorthand	Description	Required
customer		ID of a customer	true
--agent		Force structured output optimized for AI agents	false
--description		description of the customer	false
--external-id		external ID of the customer from your system	false
--label		a label to apply to the customer	false
--name		name of the customer	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

Apply multiple labels to a customer (note: previously set labels will be overwritten)

prism customers update Q3VzdG9tZXI6MmUzZDllOTUtMWIyMy00N2FjLTk3MjUtMzU1OTA2YzgyZWZj --label Prod Customers,Beta Testers

customers users create

Create a User for the specified Customer

prism customers users create [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] --email <string> --role <string> --customer <string> [--name <string>]

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--customer		ID of the customer this user is associated with	true
--email		email address	true
--name		name of the new user	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--role		ID of the role to assign the user	true
--yes		Approve non-interactive confirmation prompts	false

Add a new 'Member' user for the customer:

prism customers users create --email bar@email.com --name Thomas Bar --customer CUSTOMER_ID --role ROLE_ID

customers users delete

Delete a Customer User

prism customers users delete <user> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes]

Flag	Shorthand	Description	Required
user		ID of the user to delete	true
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

customers users list

List Customer Users

prism customers users list <customer> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--columns <string>] [--csv] [--extended] [--filter <string>] [--[no-]header] [--[no-]truncate] [--output {csv,json,yaml}] [--sort <string>] [--after <string>] [--all] [--first <number>]

Flag	Shorthand	Description	Required
customer		ID of the customer	true
--after		Resume listing after this API cursor	false
--agent		Force structured output optimized for AI agents	false
--all		Fetch every page instead of returning one resumable page	false
--columns		only show provided columns (comma-separated)	false
--csv		output is csv format [alias: --output=csv]	false
--extended	-x	show extra columns	false
--filter		filter property by regex, ex: name=^foo (prefix key with - to invert)	false
--first		Maximum number of records to request per API page	false
--[no-]header		show table headers (use --no-header to hide them)	false
--output csv,json,yaml		output in a more machine friendly format	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--sort		property to sort by, comma-separated for multi-key (prepend '-' for descending)	false
--[no-]truncate		truncate output to fit the screen (use --no-truncate for full values)	false
--yes		Approve non-interactive confirmation prompts	false

customers users roles

List Roles you can grant to Customer Users

prism customers users roles [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--columns <string>] [--csv] [--extended] [--filter <string>] [--[no-]header] [--[no-]truncate] [--output {csv,json,yaml}] [--sort <string>]

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--columns		only show provided columns (comma-separated)	false
--csv		output is csv format [alias: --output=csv]	false
--extended	-x	show extra columns	false
--filter		filter property by regex, ex: name=^foo (prefix key with - to invert)	false
--[no-]header		show table headers (use --no-header to hide them)	false
--output csv,json,yaml		output in a more machine friendly format	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--sort		property to sort by, comma-separated for multi-key (prepend '-' for descending)	false
--[no-]truncate		truncate output to fit the screen (use --no-truncate for full values)	false
--yes		Approve non-interactive confirmation prompts	false

customers users update

Update a User

prism customers users update <user> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--name <string>] [--phone <string>] [--dark-mode {true,false}] [--dark-mode-os-sync {true,false}]

Flag	Shorthand	Description	Required
user		ID of a user	true
--agent		Force structured output optimized for AI agents	false
--dark-mode true,false		whether the user should have dark mode enabled	false
--dark-mode-os-sync true,false		whether dark mode should sync with OS settings	false
--name		name of the user	false
--phone		phone number of the user	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

---

Executions CLI Commands

executions count

Count executions that match a search

prism executions count [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--since <string>] [--until <string>] [--instance <string>] [--customer <string>] [--integration <string>] [--flow <string>] [--include-tests] [--status {pending,success,error,queued,canceling,canceled}] [--where <string>...]

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--customer		Only include this customer ID	false
--flow		Only include this flow ID	false
--include-tests		Include test executions, which are hidden by default	false
--instance		Only include this instance ID	false
--integration		Only include this integration ID	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--since		Start of the time window as a relative duration (15m, 2h, 7d) or ISO timestamp (default 24h ago)	false
--status pending,success,error,queued,canceling,canceled		Only count executions with this status	false
--until		End of the time window as a relative duration or ISO timestamp (default now)	false
--where		Filter executions with key=value, key!=value, key~text, key^=prefix, key>=value, key<=value, key=null, or 'key in a,b'. Repeatable.	false
--yes		Approve non-interactive confirmation prompts	false

Failed executions in the last 24 hours:

prism executions count --status error

Executions of one customer in the last 7 days:

prism executions count --customer Q3VzdG9tZXI6... --since 7d

executions fields

List the fields you can filter executions by, including trigger payload keys discovered in your data

prism executions fields [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--columns <string>] [--csv] [--extended] [--filter <string>] [--[no-]header] [--[no-]truncate] [--output {csv,json,yaml}] [--sort <string>] [--since <string>] [--until <string>] [--search <string>] [--instance <string>] [--customer <string>] [--integration <string>]

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--columns		only show provided columns (comma-separated)	false
--csv		output is csv format [alias: --output=csv]	false
--customer		Discover payload keys from this customer ID	false
--extended	-x	show extra columns	false
--filter		filter property by regex, ex: name=^foo (prefix key with - to invert)	false
--[no-]header		show table headers (use --no-header to hide them)	false
--instance		Discover payload keys from this instance ID	false
--integration		Discover payload keys from this integration ID	false
--output csv,json,yaml		output in a more machine friendly format	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--search		Only include fields whose key path contains this text	false
--since		Start of the time window as a relative duration (15m, 2h, 7d) or ISO timestamp (default 14d ago)	false
--sort		property to sort by, comma-separated for multi-key (prepend '-' for descending)	false
--[no-]truncate		truncate output to fit the screen (use --no-truncate for full values)	false
--until		End of the time window as a relative duration or ISO timestamp (default now)	false
--yes		Approve non-interactive confirmation prompts	false

Every filterable field:

prism executions fields

Trigger payload keys that mention 'order':

prism executions fields --search order

Payload keys seen on one instance:

prism executions fields --instance SW5zdGFuY2U6... --search triggerPayload

executions get

Describe one execution: outcome, timing, lineage, trigger payload, and step summary

prism executions get <executionId> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes]

Flag	Shorthand	Description	Required
executionId		The ID of the execution	true
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

Describe an execution:

prism executions get SW5zdGFuY2VFeGVjdXRpb25SZXN1bHQ6...

executions list

Search executions across your instances

prism executions list [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--columns <string>] [--csv] [--extended] [--filter <string>] [--[no-]header] [--[no-]truncate] [--output {csv,json,yaml}] [--sort <string>] [--after <string>] [--all] [--first <number>] [--since <string>] [--until <string>] [--instance <string>] [--customer <string>] [--integration <string>] [--flow <string>] [--include-tests] [--status {pending,success,error,queued,canceling,canceled}] [--result <string>] [--invoke-type <string>] [--error <string>] [--payload <string>...] [--where <string>...] [--order-by {startedAt,endedAt,queuedAt,resumedAt,durationMs,stepCount,status,resultType,invokeType,customerName,instanceName,integrationName,flowName,errorStepName}] [--[no-]desc]

Flag	Shorthand	Description	Required
--after		Resume listing after this API cursor	false
--agent		Force structured output optimized for AI agents	false
--all		Fetch every page instead of returning one resumable page	false
--columns		only show provided columns (comma-separated)	false
--csv		output is csv format [alias: --output=csv]	false
--customer		Only include this customer ID	false
--[no-]desc		Order descending (use --no-desc for ascending)	false
--error		Only include executions whose error contains this text	false
--extended	-x	show extra columns	false
--filter		filter property by regex, ex: name=^foo (prefix key with - to invert)	false
--first		Maximum number of records to request per API page	false
--flow		Only include this flow ID	false
--[no-]header		show table headers (use --no-header to hide them)	false
--include-tests		Include test executions, which are hidden by default	false
--instance		Only include this instance ID	false
--integration		Only include this integration ID	false
--invoke-type		Only include executions started this way (webhook, scheduled, cross_flow, ...)	false
--order-by startedAt,endedAt,queuedAt,resumedAt,durationMs,stepCount,status,resultType,invokeType,customerName,instanceName,integrationName,flowName,errorStepName		Field to order by	false
--output csv,json,yaml		output in a more machine friendly format	false
--payload		Only include executions whose trigger payload matches key=value or key~text (modern API only). Repeatable.	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--result		Only include executions with this result type (completed, error, polled_no_changes, canceled_as_duplicate, canceled_by_user)	false
--since		Start of the time window as a relative duration (15m, 2h, 7d) or ISO timestamp (default 24h ago)	false
--sort		property to sort by, comma-separated for multi-key (prepend '-' for descending)	false
--status pending,success,error,queued,canceling,canceled		Only include executions with this status	false
--[no-]truncate		truncate output to fit the screen (use --no-truncate for full values)	false
--until		End of the time window as a relative duration or ISO timestamp (default now)	false
--where		Filter executions with key=value, key!=value, key~text, key^=prefix, key>=value, key<=value, key=null, or 'key in a,b'. Repeatable.	false
--yes		Approve non-interactive confirmation prompts	false

Failed executions in the last 24 hours:

prism executions list --status error

Executions of one instance in the last week, slowest first:

prism executions list --instance SW5zdGFuY2U6... --since 7d --orderBy durationMs

Executions whose trigger payload carried a given order ID:

prism executions list --payload order.id=12345

Executions whose error mentions a timeout:

prism executions list --where error~timeout

executions logs

Read the logs one execution wrote

prism executions logs <executionId> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--columns <string>] [--csv] [--extended] [--filter <string>] [--[no-]header] [--[no-]truncate] [--output {csv,json,yaml}] [--sort <string>] [--after <string>] [--all] [--first <number>] [--direction {asc,desc}] [--severity <string>] [--message <string>] [--step <string>] [--where <string>...]

Flag	Shorthand	Description	Required
executionId		The ID of the execution	true
--after		Resume listing after this API cursor	false
--agent		Force structured output optimized for AI agents	false
--all		Fetch every page instead of returning one resumable page	false
--columns		only show provided columns (comma-separated)	false
--csv		output is csv format [alias: --output=csv]	false
--direction asc,desc		Order results by time, oldest first (asc) or newest first (desc)	false
--extended	-x	show extra columns	false
--filter		filter property by regex, ex: name=^foo (prefix key with - to invert)	false
--first		Maximum number of records to request per API page	false
--[no-]header		show table headers (use --no-header to hide them)	false
--message		Only include logs whose message contains this text	false
--output csv,json,yaml		output in a more machine friendly format	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--severity		Only include logs at this severity (fatal, error, warn, info, debug, trace, metric)	false
--sort		property to sort by, comma-separated for multi-key (prepend '-' for descending)	false
--step		Only include logs written by this step name (modern API only)	false
--[no-]truncate		truncate output to fit the screen (use --no-truncate for full values)	false
--where		Filter logs with key=value, key!=value, key~text, key^=prefix, key>=value, key<=value, key=null, or 'key in a,b'. Repeatable.	false
--yes		Approve non-interactive confirmation prompts	false

All logs of an execution:

prism executions logs SW5zdGFuY2VFeGVjdXRpb25SZXN1bHQ6...

Only errors, newest first:

prism executions logs SW5zdGFuY2VFeGVjdXRpb25SZXN1bHQ6... --severity error --direction desc

executions step-result get

Gets the Result of a specified Step in an Instance Execution. This command can be used to pull down step results for both integration tests and instance executions.

prism executions step-result get [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] --execution-id <string> --step-name <string> [--output-path <string>]

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--execution-id		ID of an Execution	true
--output-path		Output result to a file. Output will be printed to stdout if this is omitted	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--step-name		Name of an Integration Step	true
--yes		Approve non-interactive confirmation prompts	false

Run a test of a flow to get an execution ID:

prism executions step-result get

Get step results from a specific execution:

prism executions step-result get --executionId SW5zdGFuY2VFeGVjdXRpb25SZXN1bHQ6MWFkZTYwMGQtMjg2Ni00ZTljLWI2N2EtYmUxNzgwOWY4ODI4 --stepName Fetch Invoice Info

executions steps

List the steps an execution ran

prism executions steps <executionId> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--columns <string>] [--csv] [--extended] [--filter <string>] [--[no-]header] [--[no-]truncate] [--output {csv,json,yaml}] [--sort <string>] [--after <string>] [--all] [--first <number>] [--direction {asc,desc}] [--failed] [--where <string>...]

Flag	Shorthand	Description	Required
executionId		The ID of the execution	true
--after		Resume listing after this API cursor	false
--agent		Force structured output optimized for AI agents	false
--all		Fetch every page instead of returning one resumable page	false
--columns		only show provided columns (comma-separated)	false
--csv		output is csv format [alias: --output=csv]	false
--direction asc,desc		Order results by time, oldest first (asc) or newest first (desc)	false
--extended	-x	show extra columns	false
--failed		Only include steps that failed	false
--filter		filter property by regex, ex: name=^foo (prefix key with - to invert)	false
--first		Maximum number of records to request per API page	false
--[no-]header		show table headers (use --no-header to hide them)	false
--output csv,json,yaml		output in a more machine friendly format	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--sort		property to sort by, comma-separated for multi-key (prepend '-' for descending)	false
--[no-]truncate		truncate output to fit the screen (use --no-truncate for full values)	false
--where		Filter steps with key=value, key!=value, key~text, key^=prefix, key>=value, key<=value, key=null, or 'key in a,b'. Repeatable.	false
--yes		Approve non-interactive confirmation prompts	false

Steps of an execution:

prism executions steps SW5zdGFuY2VFeGVjdXRpb25SZXN1bHQ6...

Only the steps that failed:

prism executions steps SW5zdGFuY2VFeGVjdXRpb25SZXN1bHQ6... --failed true

---

Graphql CLI Commands

graphql query

Execute an arbitrary GraphQL query against the Prismatic API

prism graphql query [<query>] [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--file] [--variables <string>] [--output {json,yaml,table}] [--columns <string>] [--data-path <string>] [--raw]

Flag	Shorthand	Description	Required
query		GraphQL query string (omit to read from stdin)	false
--agent		Force structured output optimized for AI agents	false
--columns		Comma-separated field paths for table columns (required for table output)	false
--data-path		Dot-notation path to array data in result (e.g., 'customers.nodes')	false
--file		Treat query argument as file path	false
--output json,yaml,table		Output format	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--raw		Output raw JSON without pretty-printing	false
--read-only		Reject commands that can modify state	false
--variables		JSON string or @file.json containing query variables	false
--yes		Approve non-interactive confirmation prompts	false

Direct query string

prism graphql query query { customers { nodes { id name } } }

From file

prism graphql query query.graphql --file true

Read from stdin (pipe query.graphql into this command)

prism graphql query

With variables

prism graphql query query.graphql --file true --variables {"id":"Q3VzdG9tZXI6..."}

Variables from file

prism graphql query query($id: ID!) { customer(id: $id) { name } } --variables @vars.json

YAML output

prism graphql query query { customers { nodes { id name } } } --output yaml

Table output with nested data

prism graphql query query { customers { nodes { id name } } } --output table --data-path customers.nodes --columns id,name

---

Instances CLI Commands

instances config-vars list

List Config Variables used on an Instance

prism instances config-vars list <instance> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--columns <string>] [--csv] [--extended] [--filter <string>] [--[no-]header] [--[no-]truncate] [--output {csv,json,yaml}] [--sort <string>] [--after <string>] [--all] [--first <number>]

Flag	Shorthand	Description	Required
instance		ID of an instance	true
--after		Resume listing after this API cursor	false
--agent		Force structured output optimized for AI agents	false
--all		Fetch every page instead of returning one resumable page	false
--columns		only show provided columns (comma-separated)	false
--csv		output is csv format [alias: --output=csv]	false
--extended	-x	show extra columns	false
--filter		filter property by regex, ex: name=^foo (prefix key with - to invert)	false
--first		Maximum number of records to request per API page	false
--[no-]header		show table headers (use --no-header to hide them)	false
--output csv,json,yaml		output in a more machine friendly format	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--sort		property to sort by, comma-separated for multi-key (prepend '-' for descending)	false
--[no-]truncate		truncate output to fit the screen (use --no-truncate for full values)	false
--yes		Approve non-interactive confirmation prompts	false

instances create

Create an Instance

prism instances create [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] --name <string> --integration <string> --customer <string> [--description <string>] [--config-vars <string>] [--label <string>...]

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--config-vars		config variables to bind to steps of your instance	false
--customer		ID of customer to deploy to	true
--description		longer description of the instance	false
--integration		ID of the integration or a specific integration version ID this is an instance of	true
--label		a label or set of labels to apply to the instance	false
--name		name of your new instance.	true
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

Get the ID of the integration you want to deploy:

prism instances create

Get the version ID of the latest available published version:

prism instances create

Set up connection credentials (must be escaped):

prism instances create

Create an instance with config variables and labels:

prism instances create --name Acme Inc --description Acme Inc instance for Smith Rocket Co --integration ${VERSION_ID} --customer ${CUSTOMER_ID} --config-vars [{"key":"My Endpoint","value":"https://example.com/api"},{"key":"Do Thing?","value":"true"},{"key":"Acme Basic Auth","values":"${CREDENTIALS}"}] --label Production,Paid

instances delete

Delete an Instance

prism instances delete <instance> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes]

Flag	Shorthand	Description	Required
instance		ID of the instance to delete	true
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

instances deploy

Deploy an Instance

prism instances deploy <instance> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--force]

Flag	Shorthand	Description	Required
instance		ID of an instance	true
--agent		Force structured output optimized for AI agents	false
--force		Force deployment even when there are certain conditions that would normally prevent it	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

instances disable

Disable an Instance

prism instances disable <instance> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes]

Flag	Shorthand	Description	Required
instance		ID of an instance	true
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

instances enable

Enable an Instance

prism instances enable <instance> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes]

Flag	Shorthand	Description	Required
instance		ID of an instance	true
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

instances flow-configs list

List Instance Flow Configs

prism instances flow-configs list <instance> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--columns <string>] [--csv] [--extended] [--filter <string>] [--[no-]header] [--[no-]truncate] [--output {csv,json,yaml}] [--sort <string>] [--after <string>] [--all] [--first <number>]

Flag	Shorthand	Description	Required
instance		ID of an Instance	true
--after		Resume listing after this API cursor	false
--agent		Force structured output optimized for AI agents	false
--all		Fetch every page instead of returning one resumable page	false
--columns		only show provided columns (comma-separated)	false
--csv		output is csv format [alias: --output=csv]	false
--extended	-x	show extra columns	false
--filter		filter property by regex, ex: name=^foo (prefix key with - to invert)	false
--first		Maximum number of records to request per API page	false
--[no-]header		show table headers (use --no-header to hide them)	false
--output csv,json,yaml		output in a more machine friendly format	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--sort		property to sort by, comma-separated for multi-key (prepend '-' for descending)	false
--[no-]truncate		truncate output to fit the screen (use --no-truncate for full values)	false
--yes		Approve non-interactive confirmation prompts	false

instances flow-configs test

Test a Flow Config of an Instance

prism instances flow-configs test <flowConfig> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--extended] [--columns <string>] [--tail] [--payload <string>] [--content-type <string>]

Flag	Shorthand	Description	Required
flowConfig		ID of a Flow Config to test	true
--agent		Force structured output optimized for AI agents	false
--columns		only show provided columns (comma-separated)	false
--content-type		Optional content-type for the test payload	false
--extended	-x	show extra columns	false
--payload		Optional JSON-formatted data payload to submit with the test	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--tail		Tail logs of the flow config test run	false
--yes		Approve non-interactive confirmation prompts	false

instances list

List Instances

prism instances list [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--customer <string>] [--integration <string>] [--columns <string>] [--csv] [--extended] [--filter <string>] [--[no-]header] [--[no-]truncate] [--output {csv,json,yaml}] [--sort <string>] [--after <string>] [--all] [--first <number>]

Flag	Shorthand	Description	Required
--after		Resume listing after this API cursor	false
--agent		Force structured output optimized for AI agents	false
--all		Fetch every page instead of returning one resumable page	false
--columns		only show provided columns (comma-separated)	false
--csv		output is csv format [alias: --output=csv]	false
--customer		ID of a customer	false
--extended	-x	show extra columns	false
--filter		filter property by regex, ex: name=^foo (prefix key with - to invert)	false
--first		Maximum number of records to request per API page	false
--[no-]header		show table headers (use --no-header to hide them)	false
--integration		ID of an integration	false
--output csv,json,yaml		output in a more machine friendly format	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--sort		property to sort by, comma-separated for multi-key (prepend '-' for descending)	false
--[no-]truncate		truncate output to fit the screen (use --no-truncate for full values)	false
--yes		Approve non-interactive confirmation prompts	false

instances update

Update an Instance

prism instances update <instance> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--name <string>] [--description <string>] [--version <string>] [--deploy] [--label <string>...]

Flag	Shorthand	Description	Required
instance		ID of an instance	true
--agent		Force structured output optimized for AI agents	false
--deploy		Deploy the instance after updating	false
--description		Description for the instance	false
--label		a label or set of labels to apply to the instance	false
--name		Name of the instance	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--version		ID of integration version	false
--yes		Approve non-interactive confirmation prompts	false

---

Integrations CLI Commands

integrations available

Mark an Integration version as available or unavailable

prism integrations available <integration> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] --available

Flag	Shorthand	Description	Required
integration		ID of an integration version	true
--agent		Force structured output optimized for AI agents	false
--available		Version is available or unavailable	true
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

integrations convert

Convert a Low-Code Integration's YAML file into a Code Native Integration

prism integrations convert <integration> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--registry-prefix <string>] [--registry-url <string>] [--include-comments]

Flag	Shorthand	Description	Required
integration		ID of the low-code integration to convert	true
--agent		Force structured output optimized for AI agents	false
--include-comments		Whether to include inline comments in the generated code	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--registry-prefix		The registry prefix to use for the converted integration	false
--registry-url		The registry URL to use for the converted integration	false
--yes		Approve non-interactive confirmation prompts	false

integrations create

Create an Integration

prism integrations create [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] --name <string> --description <string> [--customer <string>]

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--customer		ID of customer with which to associate the integration	false
--description		longer description of the integration	true
--name		name of the integration to create	true
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

integrations delete

Delete an Integration

prism integrations delete <integration> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes]

Flag	Shorthand	Description	Required
integration		ID of the integration to delete	true
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

integrations export

Export an integration to YAML definition

prism integrations export <integration> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--latest-components] [--version <number>]

Flag	Shorthand	Description	Required
integration		ID of an integration to export	true
--agent		Force structured output optimized for AI agents	false
--latest-components		Use the latest available version of each Component upon import	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--version		Define the definition version to export.	false
--yes		Approve non-interactive confirmation prompts	false

integrations flows list

List Integration Flows

prism integrations flows list <integration> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--columns <string>] [--csv] [--extended] [--filter <string>] [--[no-]header] [--[no-]truncate] [--output {csv,json,yaml}] [--sort <string>] [--after <string>] [--all] [--first <number>]

Flag	Shorthand	Description	Required
integration		ID of an Integration	true
--after		Resume listing after this API cursor	false
--agent		Force structured output optimized for AI agents	false
--all		Fetch every page instead of returning one resumable page	false
--columns		only show provided columns (comma-separated)	false
--csv		output is csv format [alias: --output=csv]	false
--extended	-x	show extra columns	false
--filter		filter property by regex, ex: name=^foo (prefix key with - to invert)	false
--first		Maximum number of records to request per API page	false
--[no-]header		show table headers (use --no-header to hide them)	false
--output csv,json,yaml		output in a more machine friendly format	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--sort		property to sort by, comma-separated for multi-key (prepend '-' for descending)	false
--[no-]truncate		truncate output to fit the screen (use --no-truncate for full values)	false
--yes		Approve non-interactive confirmation prompts	false

integrations flows listen

Listen for webhook executions on a flow and save the payload to a file

prism integrations flows listen [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] --integration-id <string> [--flow-id <string>] [--flow-name <string>] [--output <string>] [--timeout <number>] [--reset]

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--flow-id		ID of the flow to listen to. If not provided, you will be prompted to select.	false
--flow-name		Name of the flow to listen to.	false
--integration-id		ID of the integration containing the flow to listen to.	true
--output		Output directory for the payload file. Defaults to ./payloads	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--reset		Manually turn off listening mode for a given integration.	false
--timeout		Timeout in seconds to stop listening.	false
--yes		Approve non-interactive confirmation prompts	false

integrations flows test

Run a test execution of a flow Configuration links require an authenticated browser session; CLI credentials are never included.

prism integrations flows test [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--flow-id <string>] [--flow-name <string>] [--flow-url <string>] [--integration-id <string>] [--payload <string>] [--payload-content-type <string>] [--sync] [--tail-results] [--tail-logs] [--cni-auto-end] [--timeout <number>] [--result-file <string>] [--jsonl] [--debug] [--api-key <string>]

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--api-key		Optional API key for flows with secured endpoints.	false
--cni-auto-end		Automatically stop polling activity once an CNI flow execution completes. Some logs & results may not be returned this way. DOES NOT WORK FOR LOW-CODE FLOWS.	false
--debug		Enables debug mode on the test execution.	false
--flow-id		ID of the flow to test. Base64 encoded.	false
--flow-name		Name of the flow to test.	false
--flow-url		URL of the flow to test. Prefer to use flow-id instead, if possible.	false
--integration-id		ID of the integration containing the flow to test. Base64 encoded.	false
--jsonl		Optionally format the step and tail results output into JSON Lines.	false
--payload		Optional file containing a payload to run the flow with.	false
--payload-content-type		Optional Content-Type for the test payload.	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--result-file		Optional file to append tailed execution result data to. Results are saved into JSON Lines.	false
--sync		Forces the flow to run synchronously.	false
--tail-logs		Tail logs from the test execution until user interrupt or timeout.	false
--tail-results		Tail step results from the test execution until user interrupt or timeout.	false
--timeout		Optionally set a timeout (in seconds) to stop tail activity. Compatible with both low-code and CNI flows.	false
--yes		Approve non-interactive confirmation prompts	false

Test an integration flow with a payload file and tail the logs and step results:

prism integrations flows test --payload some_payload_file.xml --payload-content-type application/xml --tail-logs true --tail-results true

integrations fork

Fork an Integration

prism integrations fork <parent> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] --name <string> --description <string>

Flag	Shorthand	Description	Required
parent		ID of the Integration to fork	true
--agent		Force structured output optimized for AI agents	false
--description		longer description of the forked integration	true
--name		name of the forked integration	true
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

integrations import

Import an Integration using a YAML definition file or a Code Native Integration

prism integrations import [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--path <string>] [--integration-id <string>] [--icon-path <string>] [--open] [--replace] [--test-api-key <string>...] [--[no-]wait] [--wait-timeout <number>]

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--icon-path		If supplied, the path to the PNG icon for the integration. Not applicable for Code Native Integrations.	false
--integration-id		The ID of the integration being imported	false
--open		If supplied, open the Designer for the imported integration	false
--path		If supplied, the path to the YAML definition of the integration to import. Not applicable for Code Native Integrations.	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--replace		If supplied, allows replacing an existing integration regardless of code-native status. Requires integrationId.	false
--test-api-key		Provide test API keys for flows in the format flowName="API_KEY". Can be specified multiple times.	false
--[no-]wait		Wait until the imported integration's test instance is ready to run (use --no-wait to return as soon as the definition is imported (Code Native component publication is always awaited))	false
--wait-timeout		Seconds to wait until the imported integration's test instance is ready to run	false
--yes		Approve non-interactive confirmation prompts	false

integrations init

Initialize a new Code Native Integration

prism integrations init <name> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--configuration-type {hosted,headless}] [--[no-]include-manifests] [--clean] [--toolchain {modern,legacy}]

Flag	Shorthand	Description	Required
name		Name of the new integration to create (alphanumeric characters, hyphens, and underscores)	true
--agent		Force structured output optimized for AI agents	false
--clean		Generate clean scaffold without example code	false
--configuration-type hosted,headless		Configuration experience to scaffold	false
--[no-]include-manifests		Include component manifest registry support (use --no-include-manifests to omit)	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--toolchain modern,legacy		Toolchain to scaffold: 'modern' (tsdown + vitest + Biome) or 'legacy' (webpack + jest + eslint)	false
--yes		Approve non-interactive confirmation prompts	false

Initialize a new directory for a Code Native Integration:

prism integrations init acme-integration

Initialize an integration with headless configuration:

prism integrations init acme-integration --configuration-type headless

Install dependencies:

prism integrations init npm

Build the integration:

prism integrations init npm

Import the integration into Prismatic:

prism integrations init

integrations list

List Integrations

prism integrations list [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--columns <string>] [--csv] [--extended] [--filter <string>] [--[no-]header] [--[no-]truncate] [--output {csv,json,yaml}] [--sort <string>] [--after <string>] [--all] [--first <number>] [--show-all-versions] [--customer <string>] [--org-only] [--search <string>]

Flag	Shorthand	Description	Required
--after		Resume listing after this API cursor	false
--agent		Force structured output optimized for AI agents	false
--all		Fetch every page instead of returning one resumable page	false
--columns		only show provided columns (comma-separated)	false
--csv		output is csv format [alias: --output=csv]	false
--customer		If specified this command returns only integrations that are available to the specified customer ID	false
--extended	-x	show extra columns	false
--filter		filter property by regex, ex: name=^foo (prefix key with - to invert)	false
--first		Maximum number of records to request per API page	false
--[no-]header		show table headers (use --no-header to hide them)	false
--org-only		If specified this command returns only org integrations	false
--output csv,json,yaml		output in a more machine friendly format	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--search		If specified, search for integrations by name (case insensitive).	false
--show-all-versions		If specified this command returns all versions of all integrations rather than only the latest version	false
--sort		property to sort by, comma-separated for multi-key (prepend '-' for descending)	false
--[no-]truncate		truncate output to fit the screen (use --no-truncate for full values)	false
--yes		Approve non-interactive confirmation prompts	false

integrations manifests add

Generate component manifests into a Code Native Integration and register them in its component registry

prism integrations manifests add <componentKeys>... [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--public] [--private] [--[no-]register]

Flag	Shorthand	Description	Required
componentKeys			true
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--private		Show the manifest for the private component with the given key. Use this flag when you have a private component with the same key as a public component.	false
--profile		Use a profile	false
--public		Show the manifest for the public component with the given key. Use this flag when you have a private component with the same key as a public component.	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--[no-]register		Register each manifest in src/componentRegistry.ts (use --no-register to skip)	false
--yes		Approve non-interactive confirmation prompts	false

Add the Slack manifest:

prism integrations manifests add slack

Add several manifests at once:

prism integrations manifests add slack,salesforce

Add a private component that shares a key with a public one:

prism integrations manifests add acme --private true

Generate a manifest without editing the component registry:

prism integrations manifests add slack --register false

integrations manifests list

List the component manifests installed in a Code Native Integration and whether each is registered

prism integrations manifests list [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--columns <string>] [--csv] [--extended] [--filter <string>] [--[no-]header] [--[no-]truncate] [--output {csv,json,yaml}] [--sort <string>]

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--columns		only show provided columns (comma-separated)	false
--csv		output is csv format [alias: --output=csv]	false
--extended	-x	show extra columns	false
--filter		filter property by regex, ex: name=^foo (prefix key with - to invert)	false
--[no-]header		show table headers (use --no-header to hide them)	false
--output csv,json,yaml		output in a more machine friendly format	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--sort		property to sort by, comma-separated for multi-key (prepend '-' for descending)	false
--[no-]truncate		truncate output to fit the screen (use --no-truncate for full values)	false
--yes		Approve non-interactive confirmation prompts	false

List the manifests in the current integration:

prism integrations manifests list

integrations marketplace

Make a version of an Integration available in the Marketplace

prism integrations marketplace <integration> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] --available [--[no-]deployable] [--allow-multiple-instances] [--overview <string>]

Flag	Shorthand	Description	Required
integration		ID of an integration version to make marketplace available	true
--agent		Force structured output optimized for AI agents	false
--allow-multiple-instances		Allow a customer to deploy multiple instances of this integration	false
--available		Mark this Integration version available in the marketplace	true
--[no-]deployable		Mark this Integration version as deployable in the marketplace; does not apply if not also marked available	false
--overview		Overview to describe the purpose of the integration	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

integrations open

Open the Designer for the specified Integration

prism integrations open <integrationId> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes]

Flag	Shorthand	Description	Required
integrationId		ID of the integration to open	true
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

integrations publish

Publish a version of an Integration for use in Instances

prism integrations publish <integration> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--comment <string>] [--commit-hash <string>] [--commit-url <string>] [--repo-url <string>] [--pull-request-url <string>] [--[no-]wait] [--wait-timeout <number>]

Flag	Shorthand	Description	Required
integration		ID of an integration to publish	true
--agent		Force structured output optimized for AI agents	false
--comment		comment about changes in this publication	false
--commit-hash		Commit hash corresponding to the integration version being published	false
--commit-url		URL to the commit details corresponding to this integration version	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--pull-request-url		URL to the pull request that modified this integration version	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--repo-url		URL to the repository containing the definition for this integration	false
--[no-]wait		Wait until the published version is available for use (use --no-wait to return as soon as the publish is submitted)	false
--wait-timeout		Seconds to wait until the published version is available for use	false
--yes		Approve non-interactive confirmation prompts	false

integrations set-debug

Set debug mode on or off for an integration's test instance.

prism integrations set-debug <debug> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--integration-id <string>]

Flag	Shorthand	Description	Required
debug		Boolean value to set whether globalDebug should be enabled for the given integration	true
--agent		Force structured output optimized for AI agents	false
--integration-id		ID of the integration containing the flow to test.	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

integrations update

Update an Integration's name or description

prism integrations update <integration> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--name <string>] [--description <string>] [--customer <string>] [--test-config-vars <string>]

Flag	Shorthand	Description	Required
integration		ID of an integration	true
--agent		Force structured output optimized for AI agents	false
--customer		ID of customer with which to associate the integration	false
--description		new description to give the integration	false
--name		new name to give the integration	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--test-config-vars		JSON-formatted config variables to be used for testing	false
--yes		Approve non-interactive confirmation prompts	false

integrations validate

Load and validate a built Code Native Integration locally, without publishing or running flows. Loading executes the project module; use only trusted projects.

prism integrations validate [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes]

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

integrations validate-yaml

Validate a YAML integration definition without importing it

prism integrations validate-yaml <path> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes]

Flag	Shorthand	Description	Required
path		Path to YAML file (use '-' for stdin)	true
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

Validate a YAML file

prism integrations validate-yaml path/to/integration.yml

Validate from stdin (pipe integration.yml into this command)

prism integrations validate-yaml -

integrations versions

List Integration versions

prism integrations versions <integration> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--columns <string>] [--csv] [--extended] [--filter <string>] [--[no-]header] [--[no-]truncate] [--output {csv,json,yaml}] [--sort <string>] [--latest-available]

Flag	Shorthand	Description	Required
integration		ID of an integration	true
--agent		Force structured output optimized for AI agents	false
--columns		only show provided columns (comma-separated)	false
--csv		output is csv format [alias: --output=csv]	false
--extended	-x	show extra columns	false
--filter		filter property by regex, ex: name=^foo (prefix key with - to invert)	false
--[no-]header		show table headers (use --no-header to hide them)	false
--latest-available		Show only the latest available version	false
--output csv,json,yaml		output in a more machine friendly format	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--sort		property to sort by, comma-separated for multi-key (prepend '-' for descending)	false
--[no-]truncate		truncate output to fit the screen (use --no-truncate for full values)	false
--yes		Approve non-interactive confirmation prompts	false

---

Login CLI Commands

login

Log in to your Prismatic account

prism login [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--force] [--url] [--tenant-id <string>]

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--force		re-authenticate, even if you are already logged in	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--tenant-id		Select this tenant without prompting after authentication	false
--url		returns a challenge url without automatically opening a browser	false
--yes		Approve non-interactive confirmation prompts	false

login switch

Switch between organization tenants

prism login switch [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--tenant-id <string>]

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--tenant-id		Tenant ID to select without prompting	false
--yes		Approve non-interactive confirmation prompts	false

---

Logout CLI Commands

logout

Log out of your Prismatic account

prism logout [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--browser]

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--browser		additionally log out of your default browser's session	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

---

Logs CLI Commands

logs list

Search logs across executions

prism logs list [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--columns <string>] [--csv] [--extended] [--filter <string>] [--[no-]header] [--[no-]truncate] [--output {csv,json,yaml}] [--sort <string>] [--after <string>] [--all] [--first <number>] [--since <string>] [--until <string>] [--instance <string>] [--customer <string>] [--integration <string>] [--flow <string>] [--include-tests] [--direction {asc,desc}] [--execution <string>] [--severity <string>] [--message <string>] [--type <string>] [--where <string>...]

Flag	Shorthand	Description	Required
--after		Resume listing after this API cursor	false
--agent		Force structured output optimized for AI agents	false
--all		Fetch every page instead of returning one resumable page	false
--columns		only show provided columns (comma-separated)	false
--csv		output is csv format [alias: --output=csv]	false
--customer		Only include this customer ID	false
--direction asc,desc		Order results by time, oldest first (asc) or newest first (desc)	false
--execution		Only include logs of this execution ID	false
--extended	-x	show extra columns	false
--filter		filter property by regex, ex: name=^foo (prefix key with - to invert)	false
--first		Maximum number of records to request per API page	false
--flow		Only include this flow ID	false
--[no-]header		show table headers (use --no-header to hide them)	false
--include-tests		Include test executions, which are hidden by default	false
--instance		Only include this instance ID	false
--integration		Only include this integration ID	false
--message		Only include logs whose message contains this text	false
--output csv,json,yaml		output in a more machine friendly format	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--severity		Only include logs at this severity (fatal, error, warn, info, debug, trace, metric)	false
--since		Start of the time window as a relative duration (15m, 2h, 7d) or ISO timestamp (default 1h ago)	false
--sort		property to sort by, comma-separated for multi-key (prepend '-' for descending)	false
--[no-]truncate		truncate output to fit the screen (use --no-truncate for full values)	false
--type		Only include this log type (execution, connection, data_source, server_function, management, rate_limit)	false
--until		End of the time window as a relative duration or ISO timestamp (default now)	false
--where		Filter logs with key=value, key!=value, key~text, key^=prefix, key>=value, key<=value, key=null, or 'key in a,b'. Repeatable.	false
--yes		Approve non-interactive confirmation prompts	false

Errors in the last hour:

prism logs list --severity error

Logs of one instance that mention a request ID:

prism logs list --instance SW5zdGFuY2U6... --message req_8f3a --since 6h

Connection logs only:

prism logs list --type connection

logs severities list

List Log Severities for use by Alert Triggers

prism logs severities list [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--columns <string>] [--csv] [--extended] [--filter <string>] [--[no-]header] [--[no-]truncate] [--output {csv,json,yaml}] [--sort <string>]

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--columns		only show provided columns (comma-separated)	false
--csv		output is csv format [alias: --output=csv]	false
--extended	-x	show extra columns	false
--filter		filter property by regex, ex: name=^foo (prefix key with - to invert)	false
--[no-]header		show table headers (use --no-header to hide them)	false
--output csv,json,yaml		output in a more machine friendly format	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--sort		property to sort by, comma-separated for multi-key (prepend '-' for descending)	false
--[no-]truncate		truncate output to fit the screen (use --no-truncate for full values)	false
--yes		Approve non-interactive confirmation prompts	false

---

Me CLI Commands

me

Print your user profile information

prism me [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes]

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

me token

Print your authorization tokens

prism me token [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--type {access,refresh}]

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--type access,refresh		Which token type to print	false
--yes		Approve non-interactive confirmation prompts	false

me token revoke

Revoke all refresh tokens for your user

prism me token revoke [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes]

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

---

On-prem-resources CLI Commands

on-prem-resources delete

Delete an On-Premise Resource

prism on-prem-resources delete <resource> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes]

Flag	Shorthand	Description	Required
resource		ID of the On-Premise Resource to delete	true
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

on-prem-resources list

List On-Premise Resources

prism on-prem-resources list [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--columns <string>] [--csv] [--extended] [--filter <string>] [--[no-]header] [--[no-]truncate] [--output {csv,json,yaml}] [--sort <string>] [--after <string>] [--all] [--first <number>] [--customer <string>]

Flag	Shorthand	Description	Required
--after		Resume listing after this API cursor	false
--agent		Force structured output optimized for AI agents	false
--all		Fetch every page instead of returning one resumable page	false
--columns		only show provided columns (comma-separated)	false
--csv		output is csv format [alias: --output=csv]	false
--customer		If specified this command returns only On-Premise Resources that are available to the specified customer ID	false
--extended	-x	show extra columns	false
--filter		filter property by regex, ex: name=^foo (prefix key with - to invert)	false
--first		Maximum number of records to request per API page	false
--[no-]header		show table headers (use --no-header to hide them)	false
--output csv,json,yaml		output in a more machine friendly format	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--sort		property to sort by, comma-separated for multi-key (prepend '-' for descending)	false
--[no-]truncate		truncate output to fit the screen (use --no-truncate for full values)	false
--yes		Approve non-interactive confirmation prompts	false

on-prem-resources registration-jwt

Create a JWT that may be used to register an On-Premise Resource.

prism on-prem-resources registration-jwt [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--customer-id <string>] [--org-only] [--resource-id <string>] [--rotate]

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--customer-id		The ID of the customer for which to create the JWT. Only valid for Organization users.	false
--org-only		Register a Resource available to Organization users only. Only valid for Organization users.	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--resource-id		An optional ID of an existing On-Premise Resource for which to generate a new JWT.	false
--rotate		Invalidate all JWTs for the On-Premise Resource and get a new JWT.	false
--yes		Approve non-interactive confirmation prompts	false

---

Organization CLI Commands

organization connections list

List all integration-agnostic connections available to the organization

prism organization connections list [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--columns <string>] [--csv] [--extended] [--filter <string>] [--[no-]header] [--[no-]truncate] [--output {csv,json,yaml}] [--sort <string>] [--managed-by {org,customer}]

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--columns		only show provided columns (comma-separated)	false
--csv		output is csv format [alias: --output=csv]	false
--extended	-x	show extra columns	false
--filter		filter property by regex, ex: name=^foo (prefix key with - to invert)	false
--[no-]header		show table headers (use --no-header to hide them)	false
--managed-by org,customer		Filter connections by management type	false
--output csv,json,yaml		output in a more machine friendly format	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--sort		property to sort by, comma-separated for multi-key (prepend '-' for descending)	false
--[no-]truncate		truncate output to fit the screen (use --no-truncate for full values)	false
--yes		Approve non-interactive confirmation prompts	false

organization signing-keys delete

Delete an embedded marketplace signing key

prism organization signing-keys delete <signingKeyId> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes]

Flag	Shorthand	Description	Required
signingKeyId		ID of the signing key to delete	true
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

organization signing-keys generate

Generate an embedded marketplace signing key. The RSA public key is saved in Prismatic, and the private key is returned and immediately removed from Prismatic. Once the private key is returned, it cannot be retrieved again. Prints the private key unless --private-key-file writes it to a file; agent mode requires --private-key-file.

prism organization signing-keys generate [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--private-key-file <string>]

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--private-key-file		new file to write the private key to instead of printing it	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

Write the private key to a file instead of printing it:

prism organization signing-keys generate --private-key-file prismatic-signing-key.pem

organization signing-keys import

Import a RSA public key for use with embedded marketplace. You can use openssl to generate a new RSA key pair and import the public key.

prism organization signing-keys import [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] --public-key-file <string>

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--public-key-file		public key file	true
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

Import the public key:

prism organization signing-keys import --public-key-file my-public-key.pub

organization signing-keys list

List embedded signing keys for embedded marketplace

prism organization signing-keys list [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--columns <string>] [--csv] [--extended] [--filter <string>] [--[no-]header] [--[no-]truncate] [--output {csv,json,yaml}] [--sort <string>]

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--columns		only show provided columns (comma-separated)	false
--csv		output is csv format [alias: --output=csv]	false
--extended	-x	show extra columns	false
--filter		filter property by regex, ex: name=^foo (prefix key with - to invert)	false
--[no-]header		show table headers (use --no-header to hide them)	false
--output csv,json,yaml		output in a more machine friendly format	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--sort		property to sort by, comma-separated for multi-key (prepend '-' for descending)	false
--[no-]truncate		truncate output to fit the screen (use --no-truncate for full values)	false
--yes		Approve non-interactive confirmation prompts	false

organization theme border-radius reset

Remove the variant's custom corner radius

prism organization theme border-radius reset [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] --variant {light,dark,embedded-light,embedded-dark}

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--variant light,dark,embedded-light,embedded-dark		theme variant to change	true
--yes		Approve non-interactive confirmation prompts	false

organization theme border-radius set

Set corner radius

prism organization theme border-radius set <value> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] --variant {light,dark,embedded-light,embedded-dark}

Flag	Shorthand	Description	Required
value		corner radius in pixels, 0 to 100	true
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--variant light,dark,embedded-light,embedded-dark		theme variant to change	true
--yes		Approve non-interactive confirmation prompts	false

organization theme color reset

Remove a custom color to use Prismatic's default

prism organization theme color reset <type> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] --variant {light,dark,embedded-light,embedded-dark}

Flag	Shorthand	Description	Required
type		color type	true
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--variant light,dark,embedded-light,embedded-dark		theme variant to change	true
--yes		Approve non-interactive confirmation prompts	false

organization theme color set

Set a custom theme color

prism organization theme color set <type> <value> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] --variant {light,dark,embedded-light,embedded-dark}

Flag	Shorthand	Description	Required
type		color type	true
value		hex or RGB color	true
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--variant light,dark,embedded-light,embedded-dark		theme variant to change	true
--yes		Approve non-interactive confirmation prompts	false

organization theme elevation disable

Disable theme drop shadows

prism organization theme elevation disable [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] --variant {light,dark,embedded-light,embedded-dark}

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--variant light,dark,embedded-light,embedded-dark		theme variant to change	true
--yes		Approve non-interactive confirmation prompts	false

organization theme elevation enable

Enable theme drop shadows

prism organization theme elevation enable [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] --variant {light,dark,embedded-light,embedded-dark}

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--variant light,dark,embedded-light,embedded-dark		theme variant to change	true
--yes		Approve non-interactive confirmation prompts	false

organization theme elevation reset

Remove the variant's custom elevation setting

prism organization theme elevation reset [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] --variant {light,dark,embedded-light,embedded-dark}

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--variant light,dark,embedded-light,embedded-dark		theme variant to change	true
--yes		Approve non-interactive confirmation prompts	false

organization theme get

Show your organization's theme colors and properties by variant

prism organization theme get [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--variant {light,dark,embedded-light,embedded-dark}]

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--variant light,dark,embedded-light,embedded-dark		only show this variant: light and dark style your team's Prismatic app, embedded-light and embedded-dark style embedded screens	false
--yes		Approve non-interactive confirmation prompts	false

Show the theme your customers see in embedded screens:

prism organization theme get --variant embedded-light

organization update

Update your Organization

prism organization update [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--name <string>]

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--name		name of the organization	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

organization updateAvatarUrl

Update your Organization Avatar URL

prism organization updateAvatarUrl [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] --organization-id <string> [--avatar-url <string>]

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--avatar-url		Url of the organization avatar	false
--organization-id		ID of an organization	true
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

organization users create

Create a User for your Organization

prism organization users create [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--name <string>] --email <string> --role <string>

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--email		email address of the user	true
--name		name of the user	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--role		role the user should assume	true
--yes		Approve non-interactive confirmation prompts	false

Get the ID of the 'Integrator' role:

prism organization users create

Create an organization user and assign the role:

prism organization users create --email foo@email.com --name Susan Foo --role ${ROLE_ID}

organization users delete

Delete an Organization User

prism organization users delete <user> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes]

Flag	Shorthand	Description	Required
user		ID of the user to delete	true
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

organization users list

List Users of your Organization

prism organization users list [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--columns <string>] [--csv] [--extended] [--filter <string>] [--[no-]header] [--[no-]truncate] [--output {csv,json,yaml}] [--sort <string>] [--after <string>] [--all] [--first <number>]

Flag	Shorthand	Description	Required
--after		Resume listing after this API cursor	false
--agent		Force structured output optimized for AI agents	false
--all		Fetch every page instead of returning one resumable page	false
--columns		only show provided columns (comma-separated)	false
--csv		output is csv format [alias: --output=csv]	false
--extended	-x	show extra columns	false
--filter		filter property by regex, ex: name=^foo (prefix key with - to invert)	false
--first		Maximum number of records to request per API page	false
--[no-]header		show table headers (use --no-header to hide them)	false
--output csv,json,yaml		output in a more machine friendly format	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--sort		property to sort by, comma-separated for multi-key (prepend '-' for descending)	false
--[no-]truncate		truncate output to fit the screen (use --no-truncate for full values)	false
--yes		Approve non-interactive confirmation prompts	false

organization users roles

List Roles you can grant to other users in your Organization

prism organization users roles [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--columns <string>] [--csv] [--extended] [--filter <string>] [--[no-]header] [--[no-]truncate] [--output {csv,json,yaml}] [--sort <string>]

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--columns		only show provided columns (comma-separated)	false
--csv		output is csv format [alias: --output=csv]	false
--extended	-x	show extra columns	false
--filter		filter property by regex, ex: name=^foo (prefix key with - to invert)	false
--[no-]header		show table headers (use --no-header to hide them)	false
--output csv,json,yaml		output in a more machine friendly format	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--sort		property to sort by, comma-separated for multi-key (prepend '-' for descending)	false
--[no-]truncate		truncate output to fit the screen (use --no-truncate for full values)	false
--yes		Approve non-interactive confirmation prompts	false

organization users update

Update a User

prism organization users update <user> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--name <string>] [--phone <string>] [--dark-mode <string>] [--dark-mode-os-sync <string>]

Flag	Shorthand	Description	Required
user		ID of a user	true
--agent		Force structured output optimized for AI agents	false
--dark-mode		whether the user should have dark mode enabled	false
--dark-mode-os-sync		whether dark mode should sync with OS settings	false
--name		name of the user	false
--phone		phone number of the user	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

---

Profiles CLI Commands

profiles delete

Delete a profile

prism profiles delete <name> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes]

Flag	Shorthand	Description	Required
name		Profile to delete	true
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

profiles list

List profiles

prism profiles list [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--columns <string>] [--csv] [--extended] [--filter <string>] [--[no-]header] [--[no-]truncate] [--output {csv,json,yaml}] [--sort <string>]

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--columns		only show provided columns (comma-separated)	false
--csv		output is csv format [alias: --output=csv]	false
--extended	-x	show extra columns	false
--filter		filter property by regex, ex: name=^foo (prefix key with - to invert)	false
--[no-]header		show table headers (use --no-header to hide them)	false
--output csv,json,yaml		output in a more machine friendly format	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--sort		property to sort by, comma-separated for multi-key (prepend '-' for descending)	false
--[no-]truncate		truncate output to fit the screen (use --no-truncate for full values)	false
--yes		Approve non-interactive confirmation prompts	false

profiles use

Set the default profile

prism profiles use <name> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes]

Flag	Shorthand	Description	Required
name		Profile to use by default	true
--agent		Force structured output optimized for AI agents	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

---

Translations CLI Commands

translations list

Generate Dynamic Phrases for Embedded Marketplace

prism translations list [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--output-file <string>]

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--output-file		Output the results of the action to a specified file	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

---

Workflows CLI Commands

workflows export

Export an embedded workflow or workflow template YAML definition

prism workflows export <workflow> [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] [--[no-]latest-components]

Flag	Shorthand	Description	Required
workflow		ID of the workflow to export	true
--agent		Force structured output optimized for AI agents	false
--[no-]latest-components		Use the latest available version of each component upon import. Defaults to true.	false
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--yes		Approve non-interactive confirmation prompts	false

workflows import

Import an embedded workflow or workflow template YAML definition

prism workflows import [--agent] [--print-requests] [--profile <string>] [--quiet] [--read-only] [--yes] --path <string> [--workflow <string>] [--customer <string>]

Flag	Shorthand	Description	Required
--agent		Force structured output optimized for AI agents	false
--customer		The ID of the customer to associate with the imported workflow. This will overwrite the existing workflow. If omitted, the workflow will be imported as a template.	false
--path		The path to the YAML definition of the workflow to import	true
--print-requests		Print all GraphQL requests that are issued	false
--profile		Use a profile	false
--quiet		Reduce helpful notes and text	false
--read-only		Reject commands that can modify state	false
--workflow		The ID of the workflow being imported. If omitted, a new workflow will be created.	false
--yes		Approve non-interactive confirmation prompts	false