loading
Loading content
loading
Utilities
Execute a Trickest workflow from the command line.
overview
trickest-execute is the Trickest CLI's run command, packaged as a node. It starts a workflow on the platform by reference, passes inputs as key=value pairs, and controls how the run is provisioned. You can select the fleet, set how many machines to use or request the maximum, choose static IPs, and watch the execution stream until it finishes. It is the bridge between a saved workflow and an automated trigger.
Because it speaks to the platform API, it slots cleanly into automation. A CI mode stops in-progress executions when the CLI is interrupted, create-missing provisions the space and project if they do not exist, and a config file or token file keeps credentials and run settings out of the command line. When the run completes it can download named outputs or everything at once.
Reach for it to chain workflows, to run one on a schedule, or to drive a Trickest run from an external pipeline. Pair it with trickest-output when you want results from past runs without launching a new one.
use cases
Reference a saved workflow by URL or by space, project, and name, pass inputs as key=value pairs, and run it from CI or a scheduler without opening the editor.
Set the machine count or request the maximum, pick a fleet, and use static IPs so the execution provisions exactly the resources the job needs.
Run a workflow as a step inside a larger pipeline and download its outputs so a downstream node consumes the results.
Enable CI mode so in-progress executions stop cleanly when the CLI is interrupted, keeping automated runs from leaving orphaned executions behind.
reference
| Name | Type | Flag | Description |
|---|---|---|---|
| url | STRING | --url | URL referencing a workflow, project, or space. |
| workflow | STRING | --workflow | Workflow name to execute. |
| input | STRING | --input | Input to pass as key=value, repeatable. |
| fleet | STRING | --fleet | Fleet to run the workflow on (default Managed fleet). |
| machines | STRING | --machines | Number of machines to use for the execution (default 1). |
| output | STRING | --output | Output to download when the execution finishes, repeatable. |
| watch | BOOLEAN | --watch | Watch the execution as it runs. |
| ci | BOOLEAN | --ci | Run in CI mode so interrupted CLI stops in-progress executions. |
Showing key inputs. trickest-execute exposes 21 inputs in total.
| Name | Type | Flag | Description |
|---|---|---|---|
| ci | BOOLEAN | --ci | Run in CI mode (in-progreess executions will be stopped when the CLI is forcefully stopped - if not set, you will be asked for confirmation) |
| max | BOOLEAN | --max | Use maximum number of machines for workflow execution |
| url | STRING | --url | URL for referencing a workflow, project, or space |
| fleet | STRING | --fleet | The name of the fleet to use to execute the workflow (default "Managed fleet") |
| input | STRING | --input | Input to pass to the workflow in the format key=value (can be used multiple times) |
| space | STRING | --space | Space name |
| token | STRING | --token | Trickest authentication token |
| watch | BOOLEAN | --watch | Watch the execution running |
| config | FILE | --config | YAML file for run configuration |
| output | STRING | --output | Output to download when the execution is finished (can be used multiple times) |
| project | STRING | --project | Project name |
| machines | STRING | --machines | The number of machines to use for the workflow execution (default 1) |
| set-name | STRING | --set-name | Set workflow name if it's imported from the library |
| workflow | STRING | --workflow | Workflow name |
| output-all | BOOLEAN | --output-all | Download all outputs when the execution is finished |
| token-file | FILE | --token-file | Trickest authentication token file |
| api-endpoint | STRING | --api-endpoint | The base Trickest platform API endpoint. (default "https://api.trickest.io") |
| create-missing | BOOLEAN | --create-missing | Create space and project if they don't exist |
| use-static-ips | BOOLEAN | --use-static-ips | Use static IP addresses for the execution |
| node-dependency | FILE | --node-dependency | This flag doesn't affect the execution logic of the CLI in any way and is intended for controlling node execution order on the Trickest platform only. |
| include-primitive-nodes | BOOLEAN | --include-primitive-nodes | Include primitive nodes in the workflow tree |
example
# trickest-execute: run a workflow with domain input and watch progresstrickest execute --space demo --project recon --workflow subdomain-enum --input domain=example.com --machines 2 --watch --ciexample.comwww.example.comapi.example.commail.example.comstaging.example.comdev.example.comvpn.example.comcdn.example.comguidance
Use trickest-execute when you need to start a workflow programmatically, from CI, a schedule, or another workflow, rather than from the editor. Pair it with trickest-output when you want to pull results from past runs without launching a new one.
Downloads results from existing runs. Use it when you only need outputs, not a new execution.
The full CLI this node wraps. Use it directly for listing, importing, and managing workflows beyond execution.
faq
related
Import, export, and link workflow data with Airtable.
Decode Android APK files into smali sources and resources.
Check a file's values against conditions and exit with a matching code.
Extract all hosted zones from AWS Route53.
Output file lines by batch size, given START_LINE and END_LINE.
Extract a batch range from a file's lines or a folder's files, with parallel processing.
A workflow reference feeds trickest-execute, which runs the workflow on the platform and writes its outputs as a downloadable folder.
Facts on this page come from the live Trickest tool library.