CLI Installation

The Watchplane CLI (wp) gives you full control over your monitors, incidents, and heartbeats from the terminal.

Requirements

npm install -g @watchplane/cli

Verify the installation:

wp --version

Generate an API token in the dashboard (Settings → API Tokens) and configure the CLI:

wp config set --token wp_your_token_here

Alternatively, use the environment variable:

export WATCHPLANE_TOKEN=wp_your_token_here

Most commands operate on a project. Set a default so you don’t need to pass --project-id every time:

# List projects to find your project ID
wp projects list

# Set the default project
wp config set --project-id proj_abc123

Settings are stored at ~/.config/watchplane/config.json:

{
  "token": "wp_...",
  "projectId": "proj_abc123",
  "baseUrl": "https://api.watchplane.com",
  "outputFormat": "table"
}

You can edit this file directly or use wp config set.

If you’re running a self-hosted Watchplane instance:

wp config set --base-url https://watchplane.your-company.com