DOCS

CLI reference

Command-line interface for HOWLOPS — installation, commands, and configuration.

The HOWLOPS CLI is in early access. The core commands listed here are stable. Additional commands are under development.

Installation

# macOS (Homebrew)
brew install xinex/tap/xinex

# Linux (curl)
curl -fsSL https://dl.example.com/cli/install.sh | sh

# Windows (Scoop)
scoop bucket add xinex https://github.com/xinex/scoop-bucket
scoop install xinex

Verify the installation:

xinex version
# xinex v0.1.0 (linux/amd64, commit abc1234)

Authentication

xinex auth login
# Opens browser for OAuth login, or prompts for API token

Alternatively, set an environment variable:

export HOWLOPS_TOKEN=xinex_abc123...

The CLI reads HOWLOPS_TOKEN automatically if present.

Global flags

Flag	Default	Description
`--workspace`	Active workspace	Override the target workspace by slug
`--token`	`$HOWLOPS_TOKEN`	Override the API token
`--output`, `-o`	`table`	Output format: `table`, `json`, `yaml`
`--quiet`, `-q`	false	Suppress non-essential output
`--no-color`	false	Disable ANSI colors

Commands

`xinex monitors`

xinex monitors list [--status up|down|paused]
xinex monitors get <id>
xinex monitors create --name "My API" --url https://api.example.com/health --interval 60
xinex monitors update <id> [--name ...] [--url ...] [--interval ...]
xinex monitors pause <id>
xinex monitors resume <id>
xinex monitors delete <id>

`xinex heartbeats`

xinex heartbeats list
xinex heartbeats get <id>
xinex heartbeats create --name "Nightly backup" --interval 86400 --grace 3600
xinex heartbeats ping <slug>
xinex heartbeats delete <id>

`xinex incidents`

xinex incidents list [--open] [--monitor <id>]
xinex incidents get <id>
xinex incidents ack <id>
xinex incidents resolve <id>

`xinex status-pages`

xinex status-pages list
xinex status-pages get <id>
xinex status-pages create --name "ACME Status" --slug acme-status
xinex status-pages update <id> [--name ...] [--custom-domain ...]
xinex status-pages delete <id>

`xinex auth`

xinex auth login
xinex auth logout
xinex auth status
xinex auth token list
xinex auth token create --name ci-pipeline --expires 90d
xinex auth token revoke <id>

Configuration file

By default the CLI stores its configuration at ~/.config/xinex/config.yaml:

default_workspace: my-workspace
token: xinex_abc123...
output: table

Override with --config <path> or $HOWLOPS_CONFIG_PATH.

Exit codes

Code	Meaning
0	Success
1	General error
2	Authentication error
3	Resource not found
4	Validation error
5	Rate limited