gtme run
Execute a pipeline
What you'll learn
You're about to type gtme run and want its forms and its flags.
- every form of
gtme runand what each does - each flag and what it changes
- where the docs use it
Execute a pipeline; --resume continues a run that stopped partway; --resend-unconfirmed, with --resume, sends the deliveries the run held because they may have reached the target before it stopped, and --settle-unconfirmed marks them found at the target without sending (=KEY,… for some); --dry-run holds deliver steps back and receipts their resolved variables instead of sending; --simulate executes everything offline from fixtures (no network, no spend, nothing persists); --concurrency sets how many records a step works on at once (default 4, or $GTME_CONCURRENCY), which is also how many deliveries can be in flight if the run dies.
Forms
gtme run pipeline.yaml [--resume RUN_ID [--resend-unconfirmed[=KEYS]] [--settle-unconfirmed[=KEYS]]] [--dry-run] [--simulate] [--concurrency N]
Flags
| Flag | Takes | What it does |
|---|---|---|
--resume | RUN_ID | --resume continues a run that stopped partway. |
--resend-unconfirmed | nothing | --resend-unconfirmed, with --resume, sends the deliveries the run held because they may have reached the target before it stopped, and --settle-unconfirmed marks them found at the target without sending (=KEY,… for some) |
--settle-unconfirmed | nothing | --resend-unconfirmed, with --resume, sends the deliveries the run held because they may have reached the target before it stopped, and --settle-unconfirmed marks them found at the target without sending (=KEY,… for some) |
--dry-run | nothing | --dry-run holds deliver steps back and receipts their resolved variables instead of sending. |
--simulate | nothing | --simulate executes everything offline from fixtures (no network, no spend, nothing persists) |
--concurrency | N | --concurrency sets how many records a step works on at once (default 4, or $GTME_CONCURRENCY), which is also how many deliveries can be in flight if the run dies. |
It exits with one of the exit codes every verb shares.
Example
From See it run:
gtme run hello.yaml
Used in
- The gate ladder: The flags that pick a rung, --simulate and --dry-run, and --resume after a blocked preflight
- Launch: Every flag of the launch command, including --resume and --dry-run
- Guard: The --simulate flag this guide uses and --dry-run, the next rung and the first that spends
- Recover: Every flag of gtme run, including --resume
- Run on cron and events: Every flag of the command the crontab line runs
- Package and share a campaign: The command that verifies a bundle's hashes and runs it