From ba7621a2096a816e4aaaff86997664dc92a1bff4 Mon Sep 17 00:00:00 2001 From: Quentin Rousseau Date: Mon, 9 Mar 2026 18:39:52 -0700 Subject: [PATCH 1/2] docs: add pulse commands and migration note to README Add documentation for pulse create and pulse run commands with flags table. Add note about this being the successor to rootlyhq/cli. --- README.md | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7e39780..ef728c1 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,9 @@ Rootly CLI

-A command-line interface for managing Rootly incidents, alerts, services, teams, and on-call schedules from the terminal. +A command-line interface for managing Rootly incidents, alerts, services, teams, on-call schedules, and pulses from the terminal. + +> **Note**: This is the successor to [`rootlyhq/cli`](https://github.com/rootlyhq/cli) (now archived). All pulse functionality from the original CLI is included here. ![Go Version](https://img.shields.io/github/go-mod/go-version/rootlyhq/rootly-cli) ![License](https://img.shields.io/github/license/rootlyhq/rootly-cli) @@ -11,6 +13,7 @@ A command-line interface for managing Rootly incidents, alerts, services, teams, ## Features - Full CRUD for incidents, alerts, services, and teams +- Pulse tracking (`rootly pulse create`, `rootly pulse run`) - On-call schedule queries (list schedules, view shifts, who's on-call) - Alert action shortcuts (`rootly alerts ack`, `rootly alerts resolve`) - Multiple output formats: table, JSON, YAML, markdown @@ -112,8 +115,32 @@ rootly oncall who --service-id=svc-456 # Filter by service rootly oncall shifts # View upcoming shifts (7 days) rootly oncall shifts --days=14 # Next 14 days rootly oncall shifts --escalation-policy-id=ep-789 + +# Pulses +rootly pulse create "Deploy v1.2.3" # Send a pulse +rootly pulse create "Deploy v1.2.3" -l "version=1.2.3,team=backend" +rootly pulse create "Deploy v1.2.3" -s api-gateway -e production +rootly pulse create "Deploy v1.2.3" --source=ci -r "commit=abc123,pr=456" + +# Pulse Run (wrap a command and send pulse with timing + exit code) +rootly pulse run -- make deploy +rootly pulse run --summary="Deploy to prod" -- make deploy +rootly pulse run -s api-gateway -l "env=prod" -- make deploy ``` +### Pulse Flags + +| Flag | Short | Env Var | Description | +|------|-------|---------|-------------| +| `--labels` | `-l` | `ROOTLY_LABELS` | Key=value pairs, comma-separated | +| `--services` | `-s` | `ROOTLY_SERVICES` | Service slugs/IDs, comma-separated | +| `--environments` | `-e` | `ROOTLY_ENVIRONMENTS` | Environment slugs/IDs, comma-separated | +| `--source` | | `ROOTLY_SOURCE` | Source identifier (default: `cli`) | +| `--refs` | `-r` | `ROOTLY_REFS` | Reference key=value pairs, comma-separated | +| `--summary` | | `ROOTLY_SUMMARY` | Summary (alternative to positional arg) | + +`pulse run` also accepts `--summary` (defaults to the command string) and automatically adds an `exit_status` label with the command's exit code. + ### Output Formats ```bash From 2bd36401df66a6627607603c251ab86b73248ca3 Mon Sep 17 00:00:00 2001 From: Quentin Rousseau Date: Mon, 9 Mar 2026 18:40:40 -0700 Subject: [PATCH 2/2] docs: add global flags, command reference table, and fix pagination flags --- README.md | 31 ++++++++++++++++++++++++++++--- 1 file changed, 28 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ef728c1..68fc952 100644 --- a/README.md +++ b/README.md @@ -162,17 +162,42 @@ rootly incidents list --format=markdown ```bash # Pagination -rootly incidents list --limit=50 --page=2 +rootly incidents list --page-size=50 --page=2 # Filtering rootly incidents list --status=started --severity=critical rootly alerts list --source=datadog rootly services list --name=api -# Sorting -rootly incidents list --sort=created_at --order=desc +# Sorting (prefix with - for descending) +rootly incidents list --sort=created_at +rootly incidents list --sort=-created_at ``` +### Global Flags + +| Flag | Short | Env Var | Description | +|------|-------|---------|-------------| +| `--api-key` | `-k` | `ROOTLY_API_KEY` | Rootly API key | +| `--api-host` | | `ROOTLY_API_HOST` | API host (default: `api.rootly.com`) | +| `--format` | | | Output format: `table`, `json`, `yaml`, `markdown` | +| `--debug` | `-d` | `ROOTLY_DEBUG` | Enable debug output | +| `--quiet` | `-q` | `ROOTLY_QUIET` | Suppress non-essential output | +| `--no-color` | | | Disable colored output | + +### Command Reference + +| Command | Subcommands | Aliases | +|---------|-------------|---------| +| `rootly incidents` | `list`, `get`, `create`, `update`, `delete` | `incident`, `inc` | +| `rootly alerts` | `list`, `get`, `create`, `update`, `ack`, `resolve` | `alert`, `alr` | +| `rootly services` | `list`, `get`, `create`, `update`, `delete` | `service`, `svc` | +| `rootly teams` | `list`, `get`, `create`, `update`, `delete` | `team` | +| `rootly oncall` | `schedules`, `shifts`, `who` | `on-call` | +| `rootly pulse` | `create`, `run` | `pulses` | +| `rootly completion` | `bash`, `zsh`, `fish`, `powershell` | | +| `rootly version` | | | + ### Shell Completions ```bash