Skip to content

chore(docs): update readme #22

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
kevinsheth merged 1 commit into from
Feb 20, 2026
Merged

chore(docs): update readme #22

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
30 changes: 4 additions & 26 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# rollbaz

Fast CLI for Rollbar triage without opening Rollbar.
Agent-friendly CLI for Rollbar

## Install

Expand Down Expand Up @@ -42,7 +42,7 @@ rollbaz project list
rollbaz project use my-service
```

Tokens are stored in your user config directory with strict file permissions (`0600`).
Tokens are stored in your user config directory.

## Core Commands

Expand All @@ -56,7 +56,7 @@ rollbaz reopen 274 --yes
rollbaz mute 274 --for 2h --yes
```

Use `--format json` on list and show commands for LLM-friendly machine output.
Use `--format json` on list and show commands for LLM-friendly output.

List filters (for `rollbaz`, `active`, and `recent`):

Expand All @@ -76,17 +76,13 @@ List filters (for `rollbaz`, `active`, and `recent`):
rollbaz project add my-service --token '<READ_TOKEN>'
rollbaz project use my-service

# Daily triage
rollbaz active --limit 5
rollbaz recent --limit 5

# filtered triage
rollbaz active --env production --status active --since 2026-02-19T00:00:00Z --min-occurrences 5

# Deep dive on one issue
rollbaz show 274

# LLM-readable output
rollbaz show 274 --format json
rollbaz active --format json --limit 20
rollbaz recent --format json --limit 20
Expand All @@ -102,29 +98,11 @@ Token precedence:

If you are unsure which token to use, see: https://docs.rollbar.com/docs/access-tokens

## Quality Gates
## Checks

```bash
go test ./...
go test -race ./...
go test ./internal/... -coverprofile=coverage.out && go run ./scripts/coveragecheck -min 85 -file coverage.out
go run golang.org/x/vuln/cmd/govulncheck@v1.1.4 ./...
```

## Releasing

Releases are automated with Release Please + GoReleaser.

1. Merge feature PRs into `main`.
2. When you are ready to release, run the `release-please` workflow manually.
3. It opens/updates a Release PR.
4. Merge the Release PR.
5. A `push` to `main` triggers the release-please finalize job, which tags and marks the release PR as tagged.
6. In that same finalize run, GoReleaser publishes cross-platform binaries to GitHub Releases and updates Homebrew tap.

If you need to force a specific version, run the `release-please` workflow manually and set `release_as`.

```bash
# optional: force a release version from GitHub Actions workflow_dispatch
# release_as: 1.2.3
```