Skip to content

TriggerWare CLI

The TriggerWare CLI lets you manage your cloud-hosted TriggerWare instances, connectors, API keys, and queries from the terminal. It wraps the TriggerWare Cloud API so you don’t need to make raw HTTP or JSON-RPC calls yourself.

The CLI also ships with a built-in MCP server (triggerware mcp) that exposes the same capabilities as tools for AI agents.


Authenticate with TriggerWare Cloud using the device authorization flow. Opens a browser window where you complete sign-in, then stores your credentials locally.

triggerware login

List all instances associated with your account. Returns each instance’s name, ID, and status.

triggerware list-instances

Get details for a specific instance.

triggerware get-instance -i <instance-id>
FlagDescription
-i, --instanceInstance ID (required)

Create a new TriggerWare instance.

triggerware create-instance -n <name>
FlagDescription
-n, --nameName for the new instance (required)

Delete an instance.

triggerware delete-instance -i <instance-id>
FlagDescription
-i, --instanceInstance ID (required)

Connectors expose external data sources (APIs, databases, SaaS tools) as queryable virtual tables inside TriggerWare.

List all connectors available in the global catalog.

triggerware list-connectors

Get the schema and metadata for a connector.

triggerware get-connector -n <name>
FlagDescription
-n, --nameConnector name (required)

These commands manage which connectors are installed on a specific instance.

List all connectors currently installed on an instance.

triggerware list-installed-connectors -i <instance-id>
FlagDescription
-i, --instanceInstance ID (required)

Get details of a connector installed on an instance.

triggerware get-installed-connector -i <instance-id> -n <name>
FlagDescription
-i, --instanceInstance ID (required)
-n, --nameConnector name (required)

Install a connector on an instance. Configuration values are passed as repeatable key=value pairs.

triggerware install-connector -i <instance-id> -n <name> [-d key=value ...]
FlagDescription
-i, --instanceInstance ID (required)
-n, --nameConnector name (required)
-d, --json-dataConfiguration key=value pair (repeatable)

Example

triggerware install-connector -i inst_abc123 -n salesforce -d api_key=sk-xxx -d domain=mycompany

Uninstall a connector from an instance.

triggerware uninstall-connector -i <instance-id> -n <name>
FlagDescription
-i, --instanceInstance ID (required)
-n, --nameConnector name (required)

Custom connectors are user-created connectors that live on a specific instance. They can be generated with AI from a natural language description.

List all custom connectors on an instance.

triggerware list-custom-connectors -i <instance-id>
FlagDescription
-i, --instanceInstance ID (required)

Get the schema and metadata for a custom connector.

triggerware get-custom-connector -i <instance-id> -n <name>
FlagDescription
-i, --instanceInstance ID (required)
-n, --nameConnector name (required)

Get the Python source code for a custom connector.

triggerware get-custom-connector-code -i <instance-id> -n <name>
FlagDescription
-i, --instanceInstance ID (required)
-n, --nameConnector name (required)

Generate a new custom connector using AI from a natural language description.

triggerware generate-custom-connector -i <instance-id> -p "<description>"
FlagDescription
-i, --instanceInstance ID (required)
-p, --promptNatural language description of the connector (required)

Example

triggerware generate-custom-connector -i inst_abc123 -p "reads from a Stripe webhook and normalizes charge events"

Delete a custom connector. Fails if the connector is currently installed.

triggerware delete-custom-connector -i <instance-id> -n <name>
FlagDescription
-i, --instanceInstance ID (required)
-n, --nameConnector name (required)

List all API keys associated with your account.

triggerware list-api-keys

Create a new API key for an instance. The key is displayed once and cannot be retrieved again.

triggerware create-api-key -n <name> -i <instance-id>
FlagDescription
-n, --nameName for the API key (required)
-i, --instanceInstance ID to associate the key with (required)

Delete an API key. API keys are also automatically deleted when their associated instance is deleted.

triggerware delete-api-key -n <name>
FlagDescription
-n, --nameAPI key name (required)

Execute a query against a remote instance.

triggerware execute-query -i <instance-id> -q "<query>" [-l <language>]
FlagDefaultDescription
-i, --instanceInstance ID (required)
-q, --queryQuery text (required)
-l, --languageenglishQuery language: english, sql, or fol

Examples

triggerware execute-query -i inst_abc123 -q "show me all recent orders"
triggerware execute-query -i inst_abc123 -q "SELECT * FROM events LIMIT 10" -l sql

Start an MCP (Model Context Protocol) server over stdio. This exposes the same functionality as the CLI commands as tools that AI agents can call. Intended for use with AI coding assistants and agent frameworks.

triggerware mcp

The MCP server provides tools for all of the above operations: managing instances, connectors, installed connectors, custom connectors, API keys, and executing queries.