@brokkai/bug-bot 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,194 @@
+# Brokk Bug Bot
+
+Find new bugs in a repository and file useful GitHub issues. `bbb` follows the
+same Go CLI, no-config discovery, managed workspace, and shared
+[ACP runner](https://github.com/BrokkAi/acp-go) pattern as
+[issue-bot](https://github.com/BrokkAi/issue-bot) (`bib`) and
+[release-bot](https://github.com/BrokkAi/release-bot) (`brb`).
+
+**The LLM decides whether a finding duplicates an existing issue.** It compares
+root causes, triggering inputs, behavior, and discussion across open and closed
+issues. There are no title similarity thresholds or bug fingerprint rules.
+
+## Install and run
+
+Install with npm (Node.js 18+; no Go toolchain required):
+
+```sh
+npm install -g @brokkai/bug-bot
+bbb /path/to/your-repo
+```
+
+For a single invocation, use `npx --yes @brokkai/bug-bot`. Keep npm optional
+dependencies enabled: they supply the native Linux/macOS x64 or arm64 binary.
+
+Or install a native binary with its SHA-256 checksum verified:
+
+```sh
+curl -fsSL https://raw.githubusercontent.com/BrokkAi/bug-bot/master/install.sh | sh
+```
+
+The installer puts `bbb` in `~/.local/bin`; add that directory to `PATH`.
+Set `INSTALL_DIR` to change the destination. To pin a version, download the
+script and run `sh install.sh v0.1.0`.
+
+With Go 1.27.1 or newer:
+
+```sh
+go install github.com/BrokkAi/bug-bot/cmd/bbb@latest
+```
+
+Go installs `bbb` in `GOBIN`, or `$(go env GOPATH)/bin` by default.
+From a source checkout:
+
+```sh
+make build
+./bin/bbb /path/to/your-repo
+./bin/bbb once /path/to/your-repo --dry-run
+./bin/bbb once /path/to/your-repo --focus "parser and input validation"
+./bin/bbb /path/to/your-repo --max-issues 2 --label bug
+./bin/bbb /path/to/your-repo --model YOUR_MODEL_ID --effort low
+./bin/bbb status /path/to/your-repo
+./bin/bbb retry /path/to/your-repo --once
+```
+
+Source builds require Go 1.27.1. To install the local source as `bbb`, run
+`go install ./cmd/bbb` and put your Go bin directory on `PATH`.
+Running `bbb` from inside any target repository discovers its remote and default
+branch. A Git URL also works. Flags can precede or follow the repository argument.
+
+Runtime requirements: Git, authenticated `gh` with repository/issue read and
+issue creation access, and an authenticated ACP agent. By default it uses an
+installed `codex-acp`, falling back to `npx --yes @agentclientprotocol/codex-acp`.
+Explicit `--agent` commands are used as supplied; repeat `--agent-arg` for arguments.
+
+Starting `bbb` authorizes unattended local investigation, test execution, and
+creation of issues for the selected repository. `--dry-run` performs discovery
+and review, prints the proposed issue bodies, and saves them without filing.
+
+## How it works
+
+1. Fetch the target branch into a managed clone and make an isolated detached
+   worktree for the scan. The original checkout and uncommitted work are preserved.
+2. Download all open and closed issues and their comments with pagination. Give
+   the investigator the complete snapshot and recent scan summaries so it can
+   avoid known bugs and explore new areas on subsequent scans.
+3. Have the agent inspect source and run relevant checks. Each candidate must
+   include a root cause, source paths, concrete reproduction, expected/actual
+   behavior, and observed evidence or a precise code proof. Zero findings is valid.
+4. Start separate LLM review sessions to verify the evidence and compare each
+   candidate against the issue history. Large histories are supplied in batches;
+   every issue and comment is included, and each response must identify all issue
+   numbers it reviewed. A duplicate verdict links the existing report in local
+   state. Uncertain and invalid findings are saved without filing.
+5. Refresh issues before publication. New or edited reports go back to the LLM
+   for comparison. Recheck the source commit and tracked files. An optional
+   operator verifier can provide an additional gate.
+6. Create issues sequentially, including reproduction, evidence, and the review
+   explanation. Each newly created issue is available to the next candidate's
+   LLM review, including candidates from the same scan.
+
+Closed issues count as known reports, including fixed, duplicate, or rejected
+bugs. The reviewer is instructed to treat a regression of an existing report as
+belonging to that report. The bot does not reopen or comment on it.
+
+The default is at most **three issues per scan**, a **two-hour attempt budget**,
+and another scan **30 minutes after completion**, even if the commit is unchanged.
+Recent summaries guide exploration; this is not a claim of exhaustive coverage.
+`once` runs or resumes one scan and exits. Failed scans retain their candidates,
+workspace, and diagnostics; retries wait at least 15 minutes and run on the next
+poll, with three attempts before requiring `retry`. Agent setup errors stop the
+daemon without consuming an attempt. An advanced branch invalidates pending
+findings so the next eligible attempt scans the new commit.
+
+## Duplicate handling and interrupted requests
+
+Semantic duplicate detection is an LLM judgment, so it is not a guarantee.
+Incomplete history, malformed review responses, and uncertain comparisons stop
+publication. Same-title reports still reach the LLM: identical wording can hide
+different bugs, and different wording can describe the same bug.
+
+Every planned issue gets a random request ID, saved **before** sending its create
+request and embedded as a hidden comment in the issue body. This ID identifies
+one publication attempt; it is not derived from bug content or used to classify
+duplicates. After a crash or lost response, `bbb` looks for that ID and records
+the existing issue. If its outcome is unknown and the ID is not visible, it
+refuses to send another create request. Run `once` to try reconciliation again.
+If it never appears, inspect GitHub and the saved state before repairing the
+pending entry; `retry` intentionally cannot blindly resend an ambiguous request.
+
+A per-repository local lock coordinates instances across branches and config
+paths using the same state home. Different machines/accounts and simultaneous
+human reports cannot be locked atomically with GitHub issue creation. Run one
+active `bbb` per repository to avoid that race.
+
+## Optional configuration
+
+`bbb --config bug-bot.json` loads a strict JSON object. No file is loaded or
+generated implicitly. Paths are resolved relative to the configuration file.
+See [bug-bot.example.json](bug-bot.example.json).
+
+```json
+{
+  "remote": "https://github.com/OWNER/REPO.git",
+  "branch": "main",
+  "directory": "var/checkout",
+  "state_directory": "var/state",
+  "poll": "30m",
+  "timeout": "2h",
+  "retry_delay": "15m",
+  "attempts": 3,
+  "max_issues": 3,
+  "focus": "",
+  "labels": [],
+  "dry_run": false,
+  "agent": {"command": ["codex-acp"]}
+}
+```
+
+Labels are optional and added only to new issues; they never filter the history.
+Use labels that already exist in the target repository. `github.host` supports
+Enterprise, and `github.repo` (`OWNER/REPO`) identifies a local mirror's GitHub
+repository. `agent` also supports `environment`, `auth_method`, `mode`, `model`,
+and `effort`, with selection handled by the shared ACP runner.
+
+`verify` accepts an argument array, such as `["/opt/checks/verify-bug"]`, executed
+in the scan worktree with `BUG_COMMIT` and JSON `BUG_FINDING` in its environment.
+Keep operator verifiers outside the writable worktree. A nonzero exit blocks filing.
+
+## State and execution
+
+State defaults to `$XDG_STATE_HOME/bug-bot` or `~/.local/state/bug-bot`, keyed by
+remote and branch. JSON state is replaced atomically with fsync; private session
+transcripts live under the state directory. `status` prints saved JSON without
+starting an agent. `--json` selects structured progress logs.
+
+Scan worktrees and reproduction files are retained for inspection. Manage their
+retention along with transcripts externally. Agent instructions prohibit fixes,
+commits, pushes, and direct GitHub writes; tracked source changes or a changed
+HEAD invalidate the scan. Evidence is independently reviewed by the LLM, not
+proof that tests are correct. As in the sibling bots, ACP permission requests
+are automatically approved and agent commands run with the account's OS rights.
+This is not a sandbox; use an appropriate account/container for the repository.
+
+## Development and packaging
+
+```sh
+make check build
+./bin/bbb --help
+python3 -m unittest discover -s scripts -p '*_test.py'
+node --test --test-isolation=none npm/bbb.test.cjs
+```
+
+Tests use local Git fixtures and simulated ACP/GitHub outcomes; they do not run
+a paid model or create real issues. They cover semantic closed duplicates,
+same-title distinct bugs, concurrent reports, partial histories, source changes,
+dry runs, retries, ambiguous POSTs, receipt coverage, configuration, and locks.
+
+The inherited release workflow packages Linux/macOS amd64/arm64 archives with
+checksums. The npm launcher and packaging workflow target `@brokkai/bug-bot`
+and install `bbb`. See [RELEASING.md](RELEASING.md) for publication and verification.
+
+API references: [GitHub issues](https://docs.github.com/en/rest/issues/issues),
+[issue comments](https://docs.github.com/en/rest/issues/comments).
+Licensed under [Apache-2.0](LICENSE).

package/bin/bbb.cjs

@@ -0,0 +1,49 @@
+#!/usr/bin/env node
+"use strict";
+
+const { spawn } = require("node:child_process");
+
+function packageName(platform = process.platform, arch = process.arch) {
+  if (!["linux", "darwin"].includes(platform) || !["x64", "arm64"].includes(arch)) {
+    throw new Error(`Brokk Bug Bot does not support ${platform}/${arch}.`);
+  }
+  return `@brokkai/bug-bot-${platform}-${arch}`;
+}
+
+function main() {
+  const name = packageName();
+  let binary;
+  try {
+    binary = require.resolve(`${name}/bin/bbb`);
+  } catch {
+    throw new Error(`Missing ${name}. Reinstall @brokkai/bug-bot with optional dependencies enabled.`);
+  }
+  const child = spawn(binary, process.argv.slice(2), { stdio: "inherit" });
+  const handlers = new Map();
+  for (const signal of ["SIGINT", "SIGTERM", "SIGHUP"]) {
+    const handler = () => child.kill(signal);
+    handlers.set(signal, handler);
+    process.on(signal, handler);
+  }
+  const cleanup = () => {
+    for (const [signal, handler] of handlers) process.off(signal, handler);
+  };
+  child.on("error", (error) => {
+    cleanup();
+    console.error(`bbb: ${error.message}`);
+    process.exitCode = 1;
+  });
+  child.on("exit", (code, signal) => {
+    cleanup();
+    if (signal) process.kill(process.pid, signal);
+    else process.exitCode = code ?? 1;
+  });
+}
+
+module.exports = { packageName };
+if (require.main === module) {
+  try { main(); } catch (error) {
+    console.error(`bbb: ${error.message}`);
+    process.exitCode = 1;
+  }
+}

package/package.json

@@ -0,0 +1,33 @@
+{
+  "version": "0.1.0",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/BrokkAi/bug-bot.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "name": "@brokkai/bug-bot",
+  "description": "Brokk Bug Bot: autonomous bug discovery and duplicate-aware GitHub issue reporting",
+  "bin": {
+    "bbb": "bin/bbb.cjs"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "os": [
+    "linux",
+    "darwin"
+  ],
+  "cpu": [
+    "x64",
+    "arm64"
+  ],
+  "optionalDependencies": {
+    "@brokkai/bug-bot-linux-x64": "0.1.0",
+    "@brokkai/bug-bot-linux-arm64": "0.1.0",
+    "@brokkai/bug-bot-darwin-x64": "0.1.0",
+    "@brokkai/bug-bot-darwin-arm64": "0.1.0"
+  }
+}