Skip to content

Add AI agent quick-start section to help output #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kwent merged 1 commit into from
Jun 4, 2026
+16 −1
Merged

Add AI agent quick-start section to help output #33

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion internal/cmd/root.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,22 @@ Authenticate via environment variable:

Or use a config file at ~/.rootly-cli/config.yaml:
api_key: your-api-key
api_host: api.rootly.com`,
api_host: api.rootly.com

Start here (for AI agents):
All commands follow the pattern: rootly <resource> <verb> [flags]
Use --format=json for machine-readable output (auto-enabled when piped).

rootly incidents list --format=json List incidents as JSON
rootly incidents get INC-123 Get a single incident by ID
rootly alerts list --format=json List alerts as JSON
rootly services list --format=json List services as JSON
rootly teams list --format=json List teams as JSON
rootly oncall who --format=json Who is on-call right now
rootly pulse create "msg" --source=ci Send a deployment pulse

Discovery: run "rootly <resource> --help" to see available verbs and flags.
Resources: incidents, alerts, services, teams, oncall, pulse`,
Example: ` # List incidents
rootly incidents list

Expand Down
Loading