Upptime CLI

Uptime monitor and status page powered by GitHub Actions, Issues, and Pages

• Usage
• Commands

Usage

$npm install -g upp
$upp COMMAND
running command...
$upp (-v|--version|version)
upp/0.0.0 darwin-x64 node-v14.17.6
$upp --help [COMMAND]
USAGE
$ upp COMMAND
...

Commands

• upp config
• upp docs
• upp help [COMMAND]
• upp init
• upp run [ITERATIONS]
• upp status
• upp incidents

upp config

configures uclirc.yml

USAGE
$ upp config

OPTIONS
-f, --force
-h, --help show CLI help
-n, --name=name name to print

See code:src/commands/config.ts

upp docs

redirects to Upptime docs

USAGE
$ upp docs

See code:src/commands/docs.ts

upp help [COMMAND]

display help for upp

USAGE
$ upp help [COMMAND]

ARGUMENTS
COMMAND command to show help for

OPTIONS
--all see all commands in CLI

See code:@oclif/plugin-help

upp init

initializes upptime

USAGE
$ upp init

See code:src/commands/init.ts

upp run [ITERATIONS]

Run workflows

USAGE
$ upp run [ITERATIONS]

OPTIONS
-g, --graphs
-h, --help show CLI help
-i, --iterations=iterations number of iterations
-p, --staticSite
-s, --summary
-u, --uptime

• upp run:runs all workflows according to user/default schedule
• upp run -i 5:runs all workflows 5 times in order
• upp run -r:runs only response time workflow according to user/default schedule
• upp run -ri:runs only response time workflow 5 times

See code:src/commands/run.ts

upp status

updates about status of websites

USAGE
$ upp status

See code:src/commands/status.ts

upp incidents

reports all the incidents/downtimes

USAGE
$ upp incidents

See code:src/commands/status.ts