TriggerWare CLI
The TriggerWare CLI is primarily a convenience wrapper around the TriggerWare Docker container, and
includes a subset of the JSON-RPC API. It handles container lifecycle (start, stop) and exposes
commonly used server operations — like activating connectors and running queries — as shell commands,
so you don’t need to manage docker run flags or send raw JSON-RPC yourself.
The CLI does not cover every method the server exposes. For the full API surface, see the JSON-RPC API reference.
Start the TriggerWare Docker container.
triggerware start [-p <port>]| Flag | Default | Description |
|---|---|---|
-p, --port | 5221 | Port the server listens on |
Example
triggerware start -p 5225Stop the running TriggerWare container.
triggerware stopactivate-connector
Section titled “activate-connector”Activate a connector by name, passing any required configuration as key=value pairs. Configuration keys vary by connector — run triggerware describe-connector <name> to see what a specific connector expects.
triggerware activate-connector <name> [key=value ...]Example
triggerware activate-connector x_posts_by_user api_key=abcdefgdeactivate-connector
Section titled “deactivate-connector”Deactivate a running connector by name.
triggerware deactivate-connector <name>generate-connector
Section titled “generate-connector”Generate a new connector from a natural language description. If no name is provided, one is generated automatically.
triggerware generate-connector [-n <name>] "<description>"| Flag | Default | Description |
|---|---|---|
-n, --name | AI-generated | Name for the connector |
Examples
triggerware generate-connector "reads from a Stripe webhook and normalizes charge events"triggerware generate-connector -n stripe_charges "reads from a Stripe webhook and normalizes charge events"list-connectors
Section titled “list-connectors”List all available connectors.
triggerware list-connectorsdescribe-connector
Section titled “describe-connector”Print the schema, configuration keys, and metadata for a connector.
triggerware describe-connector <name>execute-query
Section titled “execute-query”Execute a query against the running TriggerWare instance and print results to stdout.
triggerware execute-query [-l <language>] "<query>"| Flag | Default | Description |
|---|---|---|
-l, --language | sql | Query language (sql, prql, etc.) |
Examples
triggerware execute-query "SELECT * FROM events LIMIT 10"triggerware execute-query -l prql "from events | take 10"