https://github.com/upptime/cli

⬆️🛠️ Upcoming CLI to power the new version of Upptime
https://github.com/upptime/cli

cli command-line-tool nodejs oclif typescript

Last synced: about 1 year ago
JSON representation

⬆️🛠️ Upcoming CLI to power the new version of Upptime

• Host: GitHub
• URL: https://github.com/upptime/cli
• Owner: upptime
• License: mit
• Created: 2021-08-04T07:16:20.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2022-09-12T14:08:05.000Z (almost 4 years ago)
• Last Synced: 2025-04-01T00:34:15.467Z (about 1 year ago)
• Topics: cli, command-line-tool, nodejs, oclif, typescript
• Language: TypeScript
• Homepage:
• Size: 404 KB
• Stars: 15
• Watchers: 7
• Forks: 9
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
Upptime CLI

===

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

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)

[![Version](https://img.shields.io/npm/v/upp.svg)](https://npmjs.org/package/upp)

[![CircleCI](https://circleci.com/gh/upptime/cli/tree/master.svg?style=shield)](https://circleci.com/gh/upptime/cli/tree/master)

[![Downloads/week](https://img.shields.io/npm/dw/upp.svg)](https://npmjs.org/package/upp)

[![License](https://img.shields.io/npm/l/upp.svg)](https://github.com/upptime/cli/blob/master/package.json)

* [Usage](#usage)

* [Commands](#commands)

# Usage

```sh-session

$ 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-config)

* [`upp docs`](#upp-docs)

* [`upp help [COMMAND]`](#upp-help-command)

* [`upp init`](#upp-init)

* [`upp run [ITERATIONS]`](#upp-run-iterations)

* [`upp status`](#upp-status)

* [`upp incidents`](#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](https://github.com/upptime/cli/blob/v0.0.0/src/commands/config.ts)_

## `upp docs`

redirects to Upptime docs

```

USAGE

  $ upp docs

```

_See code: [src/commands/docs.ts](https://github.com/upptime/cli/blob/v0.0.0/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](https://github.com/oclif/plugin-help/blob/v3.2.3/src/commands/help.ts)_

## `upp init`

initializes upptime

```

USAGE

  $ upp init

```

_See code: [src/commands/init.ts](https://github.com/upptime/cli/blob/v0.0.0/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](https://github.com/upptime/cli/blob/v0.0.0/src/commands/run.ts)_

## `upp status`

updates about status of websites

```

USAGE

  $ upp status

```

_See code: [src/commands/status.ts](https://github.com/upptime/cli/blob/v0.0.0/src/commands/status.ts)_

## `upp incidents`

reports all the incidents/downtimes

```

USAGE

  $ upp incidents

```

_See code: [src/commands/status.ts](https://github.com/upptime/cli/blob/v0.0.0/src/commands/status.ts)_