DOCS

CLI reference

hwl, the HowlOps command-line tool for ad-hoc monitor and incident operations.

hwl is a small CLI for ad-hoc operations against the HowlOps API (pausing/resuming monitors and acknowledging, resolving, or snoozing incidents). It is intentionally minimal; richer workflows use the REST API directly.

Installation

hwl is a single static binary with no dependencies. Prebuilt binaries are served directly from the HowlOps API for Linux, macOS, and Windows (amd64 + arm64).

Linux / macOS:

bash

# pick your platform: linux-amd64, linux-arm64, darwin-amd64, darwin-arm64
curl -fL https://api.howlops.com/api/v1/public/downloads/hwl/hwl-darwin-arm64 -o hwl
chmod +x hwl
sudo mv hwl /usr/local/bin/

Windows (PowerShell):

powershell

Invoke-WebRequest https://api.howlops.com/api/v1/public/downloads/hwl/hwl-windows-amd64.exe -OutFile hwl.exe

List all available builds (JSON index with sizes and SHA-256 checksums):

bash

curl -s https://api.howlops.com/api/v1/public/downloads/hwl

Verify the download against the published checksum:

bash

curl -s https://api.howlops.com/api/v1/public/downloads/hwl/sha256sums.txt
shasum -a 256 hwl   # compare with the line for your platform

Verify the installation:

bash

hwl version
# hwl 0.1.0

Supported platforms: Linux (amd64, arm64), macOS (amd64, Apple Silicon arm64), Windows (amd64). The binary is rebuilt and republished with every platform release, so re-download after major updates.

Authentication

hwl authenticates with a workspace API token, created under Settings > API Tokens. Provide it via the HOWLOPS_API_TOKEN environment variable:

bash

export HOWLOPS_API_TOKEN=howlops_abc123...

By default the CLI talks to https://app.howlops.com. Override the base URL with HOWLOPS_API_URL if needed:

bash

export HOWLOPS_API_URL=https://app.howlops.com

Commands

`hwl monitor`

hwl monitor pause   <monitor-id>    # pause monitoring
hwl monitor resume  <monitor-id>    # resume monitoring

`hwl incident`

hwl incident ack     <incident-id> [--comment "..."]   # acknowledge → POST /api/v1/incidents/{id}/acknowledge
hwl incident resolve <incident-id>                     # resolve     → POST /api/v1/incidents/{id}/resolve
hwl incident snooze  <incident-id> --minutes 15        # silence N min → POST /api/v1/incidents/{id}/silence

`hwl version`

hwl version    # print the CLI version

`hwl help`

hwl help       # print usage

Environment variables

Variable	Default	Description
`HOWLOPS_API_TOKEN`	None	Workspace API token (required).
`HOWLOPS_API_URL`	`https://app.howlops.com`	API base URL override.

Exit codes

Code	Meaning
0	Success
1	General / HTTP error, or missing `HOWLOPS_API_TOKEN`
2	Usage error (missing or unknown subcommand)