@brokkai/bug-bot 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +59 -1
  2. package/package.json +5 -5
package/README.md CHANGED
@@ -44,11 +44,13 @@ From a source checkout:
44
44
  ```sh
45
45
  make build
46
46
  ./bin/bbb /path/to/your-repo
47
+ ./bin/bbb /path/to/your-repo --plain
47
48
  ./bin/bbb once /path/to/your-repo --dry-run
48
49
  ./bin/bbb once /path/to/your-repo --focus "parser and input validation"
49
50
  ./bin/bbb /path/to/your-repo --max-issues 2 --label bug
50
51
  ./bin/bbb /path/to/your-repo --model YOUR_MODEL_ID --effort low
51
52
  ./bin/bbb status /path/to/your-repo
53
+ ./bin/bbb version
52
54
  ./bin/bbb retry /path/to/your-repo --once
53
55
  ```
54
56
 
@@ -57,6 +59,8 @@ Source builds require Go 1.27.1. To install the local source as `bbb`, run
57
59
  Running `bbb` from inside any target repository discovers its remote and default
58
60
  branch. A Git URL also works. Flags can precede or follow the repository argument.
59
61
 
62
+ `bbb version` prints the embedded release tag. Local builds report `dev`; binaries installed with `go install ...@version` report the module version.
63
+
60
64
  Runtime requirements: Git, authenticated `gh` with repository/issue read and
61
65
  issue creation access, and an authenticated ACP agent. By default it uses an
62
66
  installed `codex-acp`, falling back to `npx --yes @agentclientprotocol/codex-acp`.
@@ -66,6 +70,47 @@ Starting `bbb` authorizes unattended local investigation, test execution, and
66
70
  creation of issues for the selected repository. `--dry-run` performs discovery
67
71
  and review, prints the proposed issue bodies, and saves them without filing.
68
72
 
73
+ ## Terminal dashboard
74
+
75
+ Interactive runs show a live dashboard by default. It fits the current terminal
76
+ or tmux pane, adjusts when the pane is resized, and keeps the repository and
77
+ current task visible. Each pane still runs one repository.
78
+
79
+ ```sh
80
+ bbb /path/to/repo # live dashboard in an interactive terminal
81
+ bbb /path/to/repo --plain # scrolling console output and agent transcript
82
+ bbb /path/to/repo --json # structured logs for tools and log collectors
83
+ ```
84
+
85
+ The overview shows the repository, branch and commit, scan stage, active tool,
86
+ uptime, attempt budget, and next check or retry countdown. Larger panes also
87
+ show the selected model, reasoning effort, and investigation focus.
88
+
89
+ **Saved** counts cover findings in the configured repository/branch state,
90
+ including the current scan: found, filed, duplicate, pending, dry run, and skipped
91
+ (invalid, uncertain, or stale). **Run** counters start at zero each time the
92
+ process starts: completed scans, attempts, agent starts, tools, and error log
93
+ events. A discovered finding is counted as filed only after publication is
94
+ confirmed. Findings restored after restarting are included in saved totals.
95
+
96
+ - `1`, `2`, `3` or `Tab`: switch between overview, findings, and activity.
97
+ - `↑` / `↓` or `k` / `j`: browse findings or scroll activity.
98
+ - `Enter`: inspect the selected finding, issue URL, reproduction, and review.
99
+ - `Esc`: return from finding details. `Page Up` / `Page Down` scroll details.
100
+ - `g` / `G`: jump to the start/end; `G` resumes following live activity.
101
+ - `q` or `Ctrl+C`: stop the bot and its active agent, then restore the terminal.
102
+
103
+ The finding browser shows the latest 200 findings, while totals include all saved
104
+ findings. The activity view keeps recent output; full agent transcripts remain
105
+ under the state directory. On exit, a short summary and new finding URLs stay in
106
+ the terminal. `once` exits after its scan, and dry runs also print proposed finding
107
+ details on exit.
108
+
109
+ Piped input, redirected stderr, and `TERM=dumb` use scrolling output automatically.
110
+ `--plain` and `--json` disable the dashboard and are mutually exclusive.
111
+ `NO_COLOR` disables dashboard colors. `status`, `version`, and help keep their
112
+ existing output and never open the dashboard.
113
+
69
114
  ## How it works
70
115
 
71
116
  1. Fetch the target branch into a managed clone and make an isolated detached
@@ -183,7 +228,7 @@ node --test --test-isolation=none npm/bbb.test.cjs
183
228
  Tests use local Git fixtures and simulated ACP/GitHub outcomes; they do not run
184
229
  a paid model or create real issues. They cover semantic closed duplicates,
185
230
  same-title distinct bugs, concurrent reports, partial histories, source changes,
186
- dry runs, retries, ambiguous POSTs, receipt coverage, configuration, and locks.
231
+ dry runs, retries, ambiguous POSTs, receipt coverage, configuration, locks, progress snapshots, dashboard resizing, and terminal cleanup.
187
232
 
188
233
  The inherited release workflow packages Linux/macOS amd64/arm64 archives with
189
234
  checksums. The npm launcher and packaging workflow target `@brokkai/bug-bot`
@@ -192,3 +237,16 @@ and install `bbb`. See [RELEASING.md](RELEASING.md) for publication and verifica
192
237
  API references: [GitHub issues](https://docs.github.com/en/rest/issues/issues),
193
238
  [issue comments](https://docs.github.com/en/rest/issues/comments).
194
239
  Licensed under [Apache-2.0](LICENSE).
240
+
241
+ ## Automatic releases
242
+
243
+ Push a new `v*` version tag to run the complete **Publish packages** pipeline:
244
+ Linux/macOS checks, native GitHub assets, then all five npm packages from the
245
+ same tag and commit. No manual package dispatch is needed. The package job runs
246
+ only after native publication succeeds and validates package contents and local
247
+ installs before uploading. It does not wait for npm's public index to update.
248
+
249
+ For recovery, rerun failed jobs or manually dispatch `publish-packages.yml` from
250
+ the exact existing tag with `publish=true`. The default manual `publish=false`
251
+ validates without uploading. Existing published bytes must match on retry.
252
+ See [RELEASING.md](RELEASING.md) for details.
package/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "0.1.0",
2
+ "version": "0.2.0",
3
3
  "license": "Apache-2.0",
4
4
  "repository": {
5
5
  "type": "git",
@@ -25,9 +25,9 @@
25
25
  "arm64"
26
26
  ],
27
27
  "optionalDependencies": {
28
- "@brokkai/bug-bot-linux-x64": "0.1.0",
29
- "@brokkai/bug-bot-linux-arm64": "0.1.0",
30
- "@brokkai/bug-bot-darwin-x64": "0.1.0",
31
- "@brokkai/bug-bot-darwin-arm64": "0.1.0"
28
+ "@brokkai/bug-bot-linux-x64": "0.2.0",
29
+ "@brokkai/bug-bot-linux-arm64": "0.2.0",
30
+ "@brokkai/bug-bot-darwin-x64": "0.2.0",
31
+ "@brokkai/bug-bot-darwin-arm64": "0.2.0"
32
32
  }
33
33
  }