Greatwait home pagelight logo
  1. Reference
  2. Command-line reference

This is @greatwait/cli 0.1.0-alpha.4, the version npm install --global @greatwait/cli installs today, and these are the commands the invited alpha uses. greatwait --help lists these and also billing commands, which are not part of the alpha.

​
Commands

​
greatwait attempts list

greatwait attempts list <schedule> <occurrence> [--api-url <origin>] [--limit <count>] [--cursor <cursor>] [--all]

​
greatwait attempts read

greatwait attempts read <schedule> <occurrence> <attempt> [--api-url <origin>]

​
greatwait context

greatwait context [list | use <origin>] [--api-url <origin>]

​
greatwait credentials list

greatwait credentials list [--api-url <origin>] [--limit <count>] [--cursor <cursor>] [--all]

​
greatwait credentials revoke

greatwait credentials revoke <credential> [--api-url <origin>] [--yes]

​
greatwait credentials rotate

greatwait credentials rotate <credential> [--api-url <origin>] [--yes]

​
greatwait destinations create

greatwait destinations create [--api-url <origin>] [--url <https url>]

​
greatwait destinations disable

greatwait destinations disable <destination> [--api-url <origin>] [--yes]

​
greatwait destinations enable

greatwait destinations enable <destination> [--api-url <origin>]

​
greatwait destinations list

greatwait destinations list [--api-url <origin>] [--limit <count>] [--cursor <cursor>] [--all]

​
greatwait destinations read

greatwait destinations read <destination> [--api-url <origin>]

​
greatwait destinations rotate-key

greatwait destinations rotate-key <destination> [--api-url <origin>] [--if-match <etag>] [--yes]

​
greatwait destinations update

greatwait destinations update <destination> [--api-url <origin>] [--url <https url>] [--if-match <etag>] [--yes]

​
greatwait doctor

greatwait doctor [--api-url <origin>]

​
greatwait exports cancel

greatwait exports cancel <export> [--api-url <origin>] [--yes]

​
greatwait exports create

greatwait exports create [--api-url <origin>]

​
greatwait exports part

greatwait exports part <export> [--api-url <origin>] [--limit <count>]

​
greatwait exports read

greatwait exports read <export> [--api-url <origin>]

​
greatwait forecast

greatwait forecast [--api-url <origin>] [--from <instant>] [--to <instant>] [--bucket <seconds>] [--breakdown <dimension>]

​
greatwait journey

greatwait journey [--api-url <origin>]

​
greatwait login

greatwait login [--api-url <origin>] [--api-key] [--no-browser] [--scope <scopes>]

​
greatwait logout

greatwait logout [--api-url <origin>]

​
greatwait occurrences list

greatwait occurrences list <schedule> [--api-url <origin>] [--limit <count>] [--cursor <cursor>] [--all] [--newest]

​
greatwait occurrences read

greatwait occurrences read <schedule> <occurrence> [--api-url <origin>]

​
greatwait occurrences redeliver

greatwait occurrences redeliver <schedule> <occurrence> [--api-url <origin>] [--idempotency-key <key>] [--yes]

​
greatwait occurrences wait

greatwait occurrences wait <schedule> <occurrence> [--api-url <origin>] [--timeout <duration>]

​
greatwait schedules archive

greatwait schedules archive <schedule> [--api-url <origin>] [--if-match <etag>]

​
greatwait schedules cancel

greatwait schedules cancel <schedule> [--api-url <origin>] [--if-match <etag>] [--yes]

​
greatwait schedules create

greatwait schedules create [--api-url <origin>] [--endpoint <destination>] [--in <duration>] [--at <instant>] [--every <duration>] [--cron <expression>] [--time-zone <zone>] [--partition-key <key>] [--latency-class <class>] [--data <json>] [--idempotency-key <key>]

​
greatwait schedules list

greatwait schedules list [--api-url <origin>] [--endpoint <destination>] [--limit <count>] [--cursor <cursor>] [--all]

​
greatwait schedules pause

greatwait schedules pause <schedule> [--api-url <origin>] [--if-match <etag>]

​
greatwait schedules read

greatwait schedules read <schedule> [--api-url <origin>]

​
greatwait schedules replace

greatwait schedules replace <schedule> [--api-url <origin>] [--endpoint <destination>] [--in <duration>] [--at <instant>] [--every <duration>] [--cron <expression>] [--time-zone <zone>] [--partition-key <key>] [--latency-class <class>] [--data <json>] [--if-match <etag>] [--yes]

​
greatwait schedules resume

greatwait schedules resume <schedule> [--api-url <origin>] [--if-match <etag>]

​
greatwait sinks configure

greatwait sinks configure <sink> [--api-url <origin>] [--program <json>]

​
greatwait sinks create

greatwait sinks create [--api-url <origin>] [--endpoint <destination>] [--program <json>]

​
greatwait sinks delete

greatwait sinks delete <sink> [--api-url <origin>] [--yes]

​
greatwait sinks deliveries

greatwait sinks deliveries <sink> [--api-url <origin>] [--limit <count>] [--cursor <cursor>] [--all]

​
greatwait sinks delivery

greatwait sinks delivery <sink> <delivery> [--api-url <origin>]

​
greatwait sinks list

greatwait sinks list [--api-url <origin>] [--limit <count>] [--cursor <cursor>] [--all]

​
greatwait sinks read

greatwait sinks read <sink> [--api-url <origin>]

​
greatwait timing

greatwait timing [--api-url <origin>]

​
greatwait usage

greatwait usage [--api-url <origin>] [--from <instant>] [--to <instant>]

​
greatwait whoami

greatwait whoami [--api-url <origin>]

​
Flags every command accepts

FlagWhat it does
--jsonMachine-readable output, versioned.
--helpThe usage text above.

​
Exit codes

CodeMeaning
0it worked
1a defect in the command itself
2the command line was wrong
3no usable credential — greatwait login
4the credential may not do this
5the request was refused on its merits
6the service could not answer now; the identical request may work later
7a deadline passed
130interrupted

Where the service refused a request, its problem code is preserved in --json and in the message, so a script that already branches on one against the HTTP API does not need a second vocabulary.