Skip to content

CLI tool for Trigger.dev - list, search, and run tasks from your terminal

Notifications You must be signed in to change notification settings

JWPapi/trigger-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 

Repository files navigation

trigger-cli

An unofficial command-line tool for Trigger.dev - list, search, and run tasks from your terminal.

Note: This is a community project and is not affiliated with or endorsed by Trigger.dev.

Installation

# Clone the repo
git clone https://github.com/JWPapi/trigger-cli.git ~/trigger-cli

# Add alias to your shell profile (.bashrc, .zshrc, etc.)
alias trigger='python3 ~/trigger-cli/trigger.py'

Requirements

  • Python 3.6+
  • requests library (pip install requests)
  • Optional: python-dotenv for .env file support (pip install python-dotenv)

Setup

Set your Trigger.dev credentials:

export TRIGGER_SECRET_KEY="tr_dev_..."  # or tr_prod_...
export TRIGGER_PROJECT_ID="your-project-id"  # optional, for dashboard URLs

Or create a .env / .env.local file in your project directory.

Usage

trigger                            List tasks (numbered)
trigger list                       Same as above
trigger list <search>              Search tasks by name
trigger list --local               Scan ./tasks folder for all task definitions
trigger schedules                  List scheduled tasks (numbered)
trigger runs                       List recent runs with run IDs
trigger runs --active              List only in-progress runs
trigger run <task_id>              Run a task (asks for confirmation)
trigger run <task_id> -y           Run without confirmation
trigger run <task_id> -p <json>    Run with JSON payload
trigger run <task_id> --open       Open run URL after trigger
trigger cancel <run_id>            Cancel an in-progress run
trigger cancel <number>            Cancel run by number from last 'trigger runs'
trigger <number>                   Run task by number from last list
trigger -h, --help                 Show this help

Examples

# List tasks from recent runs
$ trigger
Tasks:
  1. process-campaigns ✓
  2. send-notifications ⏳

# Search tasks
$ trigger list email
Tasks matching 'email':
  1. send-email-batch ✓

# List all tasks from source code
$ trigger list --local
Tasks (local):
  1. cleanup-cron
  2. process-campaigns
  3. send-email-batch
  ...

# Run a task by number
$ trigger 1
Trigger 'process-campaigns'? [y/N] y
✓ Triggered process-campaigns
   https://cloud.trigger.dev/projects/v3/.../runs/...

# Run with payload
$ trigger run my-task -p '{"userId": "123"}'

# List runs with IDs
$ trigger runs --active
In-progress runs:
  1. process-campaigns ⏳ (abc12345)
  2. send-notifications ⏳ (def67890)

# Cancel a run by number
$ trigger cancel 1
Cancel run 'run_abc12345'? [y/N] y
✔️ Cancelled run_abc12345

# Cancel by run ID directly
$ trigger cancel run_abc12345 -y
✔️ Cancelled run_abc12345

License

MIT

About

CLI tool for Trigger.dev - list, search, and run tasks from your terminal

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages