advanced-scheduler
v2.3.0
Published
CLI to interact with the Advanced Scheduler Heroku Add-on
Downloads
87
Maintainers
Readme
Advanced Scheduler CLI
Heroku CLI plugin to interact with the Advanced Scheduler Heroku Add-on. The Advanced Scheduler Command Line Interface (CLI) extends the Service API and makes it easy for you to create and manage your triggers directly from the terminal.
Advanced Scheduler is the next standard in task scheduling on Heroku applications. Get more flexibility, out-of-the-box monitoring, greater reliability and unparalleled ease of use on top of the well-known Heroku Scheduler experience. Learn more here.
Installation
$ heroku plugins:install advanced-scheduler
Usage
$ npm install -g advanced-scheduler
$ heroku COMMAND
running command...
$ heroku (-v|--version|version)
advanced-scheduler/2.3.0 darwin-arm64 node-v16.20.2
$ heroku --help [COMMAND]
USAGE
$ heroku COMMAND
...
Commands
heroku triggers...
heroku triggers:activate <uuid>...
heroku triggers:create...
heroku triggers:deactivate <uuid>...
heroku triggers:delete <uuid>...
heroku triggers:update <uuid>...
heroku triggers...
List the Advanced Scheduler triggers for an app
USAGE
$ heroku triggers...
OPTIONS
-a, --app=app (required) app to run command against
-h, --help show CLI help
-j, --json output triggers in json format
EXAMPLE
$ heroku triggers -a example
See code: src/commands/triggers.ts
heroku triggers:activate <uuid>...
Activate an Advanced Scheduler trigger for an app
USAGE
$ heroku triggers:activate <uuid>...
ARGUMENTS
UUID uuid of the Advanced Scheduler trigger
OPTIONS
-a, --app=app (required) app to run command against
-f, --force
-h, --help show CLI help
See code: src/commands/triggers/activate.ts
heroku triggers:create...
Create a new Advanced Scheduler trigger for an app
USAGE
$ heroku triggers:create...
OPTIONS
-a, --app=app
(required) app to run command against
-h, --help
show CLI help
--dyno=Free|Eco|Hobby|Basic|Standard-1X|Standartd-2X|Performance-M|Performance-L|Performance-L-RAM|Performance-XL|Perf
ormance-2XL|Private-S|Private-M|Private-L|Private-L-RAM|Private-XL|Private-2XL|Shield-S|Shield-M|Shield-L|Shield-L-RAM
|Shield-XL|Shield-2XL
(required) dyno for task execution
--frequencyType=recurring|one-off
(required) frequency of trigger execution
--name=name
(required) name of trigger
--schedule=schedule
(required) schedule of trigger execution
--state=active|inactive
[default: active] state of trigger
--timeout=timeout
[default: 1800] timeout of task execution
--timezone=timezone
[default: UTC] timezone of trigger
--value=value
(required) command of trigger
EXAMPLES
$ heroku triggers:create -a example --name "Trigger created via CLI" --frequencyType recurring --schedule "* * * * *"
--value "npm run something" --dyno Free
$ heroku triggers:create -a example --name "Trigger created via CLI" --frequencyType one-off --schedule "2025-12-25
00:00:00" --value "npm run something" --dyno Free
See code: src/commands/triggers/create.ts
heroku triggers:deactivate <uuid>...
Deactivate an Advanced Scheduler trigger for an app
USAGE
$ heroku triggers:deactivate <uuid>...
ARGUMENTS
UUID uuid of the Advanced Scheduler trigger
OPTIONS
-a, --app=app (required) app to run command against
-f, --force
-h, --help show CLI help
See code: src/commands/triggers/deactivate.ts
heroku triggers:delete <uuid>...
Permanently delete an Advanced Scheduler trigger for an app
USAGE
$ heroku triggers:delete <uuid>...
ARGUMENTS
UUID uuid of the Advanced Scheduler trigger
OPTIONS
-a, --app=app (required) app to run command against
-h, --help show CLI help
EXAMPLE
$ heroku triggers:delete 01234567-89ab-cdef-0123-456789abcdef -a example
See code: src/commands/triggers/delete.ts
heroku triggers:update <uuid>...
Update an Advanced Scheduler trigger for an app
USAGE
$ heroku triggers:update <uuid>...
ARGUMENTS
UUID uuid of the Advanced Scheduler trigger
OPTIONS
-a, --app=app
(required) app to run command against
-h, --help
show CLI help
--dyno=Free|Eco|Hobby|Basic|Standard-1X|Standartd-2X|Performance-M|Performance-L|Performance-L-RAM|Performance-XL|Perf
ormance-2XL|Private-S|Private-M|Private-L|Private-L-RAM|Private-XL|Private-2XL|Shield-S|Shield-M|Shield-L|Shield-L-RAM
|Shield-XL|Shield-2XL
dyno for task execution
--frequencyType=recurring|one-off
frequency of trigger execution
--name=name
name of trigger
--schedule=schedule
schedule of trigger execution
--state=active|inactive
state of trigger
--timeout=timeout
timeout of task execution
--timezone=timezone
timezone of trigger
--value=value
command of trigger
EXAMPLES
$ heroku triggers:update 01234567-89ab-cdef-0123-456789abcdef -a example --name "Trigger updated via CLI"
--frequencyType recurring --schedule "* * * * *" --value "npm run something-else" --dyno Free
$ heroku triggers:update 01234567-89ab-cdef-0123-456789abcdef -a example --name "Trigger updated via CLI"
--frequencyType one-off --schedule "2025-12-25 00:00:00" --value "npm run something-else" --dyno Free
See code: src/commands/triggers/update.ts