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.
Authentication
Section titled “Authentication”Authenticate with TriggerWare Cloud using the device authorization flow. Opens a browser window where you complete sign-in, then stores your credentials locally.
triggerware loginInstances
Section titled “Instances”list-instances
Section titled “list-instances”List all instances associated with your account. Returns each instance’s name, ID, and status.
triggerware list-instancesget-instance
Section titled “get-instance”Get details for a specific instance.
triggerware get-instance -i <instance-id>| Flag | Description |
|---|---|
-i, --instance | Instance ID (required) |
create-instance
Section titled “create-instance”Create a new TriggerWare instance.
triggerware create-instance -n <name>| Flag | Description |
|---|---|
-n, --name | Name for the new instance (required) |
delete-instance
Section titled “delete-instance”Delete an instance.
triggerware delete-instance -i <instance-id>| Flag | Description |
|---|---|
-i, --instance | Instance ID (required) |
Connectors
Section titled “Connectors”Connectors expose external data sources (APIs, databases, SaaS tools) as queryable virtual tables inside TriggerWare.
list-connectors
Section titled “list-connectors”List all connectors available in the global catalog.
triggerware list-connectorsget-connector
Section titled “get-connector”Get the schema and metadata for a connector.
triggerware get-connector -n <name>| Flag | Description |
|---|---|
-n, --name | Connector name (required) |
Installed Connectors
Section titled “Installed Connectors”These commands manage which connectors are installed on a specific instance.
list-installed-connectors
Section titled “list-installed-connectors”List all connectors currently installed on an instance.
triggerware list-installed-connectors -i <instance-id>| Flag | Description |
|---|---|
-i, --instance | Instance ID (required) |
get-installed-connector
Section titled “get-installed-connector”Get details of a connector installed on an instance.
triggerware get-installed-connector -i <instance-id> -n <name>| Flag | Description |
|---|---|
-i, --instance | Instance ID (required) |
-n, --name | Connector name (required) |
install-connector
Section titled “install-connector”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 ...]| Flag | Description |
|---|---|
-i, --instance | Instance ID (required) |
-n, --name | Connector name (required) |
-d, --json-data | Configuration key=value pair (repeatable) |
Example
triggerware install-connector -i inst_abc123 -n salesforce -d api_key=sk-xxx -d domain=mycompanyuninstall-connector
Section titled “uninstall-connector”Uninstall a connector from an instance.
triggerware uninstall-connector -i <instance-id> -n <name>| Flag | Description |
|---|---|
-i, --instance | Instance ID (required) |
-n, --name | Connector name (required) |
Custom Connectors
Section titled “Custom Connectors”Custom connectors are user-created connectors that live on a specific instance. They can be generated with AI from a natural language description.
list-custom-connectors
Section titled “list-custom-connectors”List all custom connectors on an instance.
triggerware list-custom-connectors -i <instance-id>| Flag | Description |
|---|---|
-i, --instance | Instance ID (required) |
get-custom-connector
Section titled “get-custom-connector”Get the schema and metadata for a custom connector.
triggerware get-custom-connector -i <instance-id> -n <name>| Flag | Description |
|---|---|
-i, --instance | Instance ID (required) |
-n, --name | Connector name (required) |
get-custom-connector-code
Section titled “get-custom-connector-code”Get the Python source code for a custom connector.
triggerware get-custom-connector-code -i <instance-id> -n <name>| Flag | Description |
|---|---|
-i, --instance | Instance ID (required) |
-n, --name | Connector name (required) |
generate-custom-connector
Section titled “generate-custom-connector”Generate a new custom connector using AI from a natural language description.
triggerware generate-custom-connector -i <instance-id> -p "<description>"| Flag | Description |
|---|---|
-i, --instance | Instance ID (required) |
-p, --prompt | Natural 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-custom-connector
Section titled “delete-custom-connector”Delete a custom connector. Fails if the connector is currently installed.
triggerware delete-custom-connector -i <instance-id> -n <name>| Flag | Description |
|---|---|
-i, --instance | Instance ID (required) |
-n, --name | Connector name (required) |
API Keys
Section titled “API Keys”list-api-keys
Section titled “list-api-keys”List all API keys associated with your account.
triggerware list-api-keyscreate-api-key
Section titled “create-api-key”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>| Flag | Description |
|---|---|
-n, --name | Name for the API key (required) |
-i, --instance | Instance ID to associate the key with (required) |
delete-api-key
Section titled “delete-api-key”Delete an API key. API keys are also automatically deleted when their associated instance is deleted.
triggerware delete-api-key -n <name>| Flag | Description |
|---|---|
-n, --name | API key name (required) |
execute-query
Section titled “execute-query”Execute a query against a remote instance.
triggerware execute-query -i <instance-id> -q "<query>" [-l <language>]| Flag | Default | Description |
|---|---|---|
-i, --instance | Instance ID (required) | |
-q, --query | Query text (required) | |
-l, --language | english | Query 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 sqlMCP Server
Section titled “MCP Server”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 mcpThe MCP server provides tools for all of the above operations: managing instances, connectors, installed connectors, custom connectors, API keys, and executing queries.