buggazi 2.5.1 → 2.6.0

package/README.md

@@ -1,15 +1,17 @@
 # bgz
 
 [![npm version](https://img.shields.io/npm/v/buggazi.svg)](https://www.npmjs.com/package/buggazi)
-[![MCP](https://img.shields.io/badge/MCP-24_tools-blue)](https://buggazi.com/docs/quickstart/remote-mcp.html)
+[![MCP](https://img.shields.io/badge/MCP-24_tools-blue)](https://buggazi.ai/docs/quickstart/remote-mcp.html)
 
-Project management for coding agents. Bug tracking, feature planning, sprint management - as easy as git.
+**Project management for coding agents. As easy as git.**
+
+Your agent writes code all day — then forgets every bug the moment its context window resets. So *you* become the middleman, copy-pasting between your agent and Jira. Buggazi is the tracker your agent runs itself: one install, and it files, links, and resolves its own bugs — with screenshots, sprints, and a shareable snapshot.
 
 **Works with:** Claude Code · Cursor · Cline · Windsurf · Aider · Codex · any MCP client
 
-[![bgz demo — install to shipped bug in 60 seconds](https://prodmedia.tyga.host/public/tyga.cloud/landing/buggazi.com/bgz-demo-1200.gif)](https://prodmedia.tyga.host/public/tyga.cloud/landing/buggazi.com/buggazi-gtm-1.mp4)
+[![bgz demo — install to shipped bug in 60 seconds](https://prodmedia.tyga.host/public/tyga.cloud/landing/buggazi.com/bgz-demo-1200.gif)](https://buggazi.ai/#demo)
 
-*Install to shipped bug in 60 seconds — [watch the full demo](https://prodmedia.tyga.host/public/tyga.cloud/landing/buggazi.com/buggazi-gtm-1.mp4).*
+*Install to shipped bug in 60 seconds — [watch the full demo](https://buggazi.ai/#demo).*
 
 ## Install
 
@@ -41,19 +43,71 @@ bgz fix BUG-2026-0608-001 -c a3f2c1d -f "Added null check"
 bgz --help
 ```
 
-## Cross-Tenant Contracts
+## Works alongside GitHub & GitLab
+
+Your repo holds the code. A merged PR shows *what* changed and that it was approved — but not *why*. `bgz` is the layer that keeps the intent: every bug and feature carries the reasoning, diagnosis, evidence and links your agent had in-context, tied to the exact commit that fixed it. So when your agent's context resets, the next one picks up cold.
+
+```bash
+# File with intent — not just a title
+bgz bug "Checkout 500s on submit" -s P1 \
+  -d "Only when cart total is null after a coupon is removed" \
+  --screenshot ./crash.png
+
+# Resolve with the reasoning and the commit — not just a green check
+bgz fix BUG-2026-0608-001 -c $(git rev-parse HEAD) \
+  -f "Guard null totals before tax calc" \
+  -r "Coupon removal left total undefined; tax step assumed a number"
+```
+
+Reasoning, diagnosis, affected files, commit SHA, screenshots and cross-links — all structured and queryable, none of it lost in a squash-merge.
+
+## Sprints — plan the work, not just the bugs
+
+Group features into sprints and track live progress from the terminal — no board to drag, your agent runs it.
+
+```bash
+bgz sprint create "Launch hardening"
+bgz feature "Null-safe cart totals" -p P1 --sprint SPRINT-ID
+bgz sprint add SPRINT-ID FEAT-102 FEAT-103
+bgz sprint                      # active sprint + live progress
+```
+
+Full kanban board and a shareable snapshot come with every project — see `bgz snapshot`.
 
-File bugs and features directly into a partner project over a contract — agent to agent.
+## Coming from Jira, Linear, or Shortcut?
+
+One command brings your issues over — no CSV export, no manual re-entry.
+
+```bash
+bgz migrate jira --from https://myco.atlassian.net --email me@co.com --token TOKEN --project PROJ
+bgz migrate linear --token LINEAR_API_KEY --team ENG
+bgz migrate shortcut --token SHORTCUT_TOKEN --project "My Project"
+```
+
+Every importer has a `--dry-run` that previews exactly what it'll bring over before writing a thing. Step-by-step guides, the full field mapping, and a 30-second demo you can run *without* an account: **[`migrate/`](./migrate)**.
+
+## Contracts — your agents collaborate, you stop being the postman
+
+Ever had two agents on interrelated projects "talk" through you? One writes a Markdown note, you paste it into the other's terminal, it writes a reply, you paste it back. You're not building — you're the courier.
+
+A contract cuts you out of that loop. Agent A files a bug or feature **straight into Agent B's project** — with a screenshot repro — and B picks it up in its own tracker. No notes, no copy-paste, no you in the middle.
 
 ```bash
-# File a bug to a partner, with a visual repro attached
+# B: see incoming collaboration proposals and accept
+bgz contracts inbound
+bgz contract CTR-ID accept
+
+# A: file a bug into the partner's project, with a visual repro
 bgz contract CTR-ID file-bug "Checkout 500s on submit" -s P1 --screenshot ./crash.png
 
-# Bump severity after filing — no delete + re-file
+# A: or file a feature request across the boundary
+bgz contract CTR-ID file-feature "Expose an /orders webhook"
+
+# A: bump severity later — no delete + re-file
 bgz contract CTR-ID update-bug BUG-ID -s P0
 ```
 
-Screenshots upload via a presigned S3 URL and are served from the CDN. External contract filings require human approval on the receiving side (EU AI Act compliant).
+Screenshots upload via a presigned S3 URL and serve from the CDN. Filings into a project you don't own need **one** human approval on the receiving side — EU AI Act compliant — then the agents talk directly.
 
 ## MCP Server
 
@@ -72,7 +126,7 @@ bgz settings webhooks set --url https://your-stack.example/hooks --events "bug:r
 bgz notifications          # or pull: what changed recently
 ```
 
-Payloads are HMAC-SHA256 signed (`X-Buggazi-Signature`).
+Payloads are HMAC-SHA256 signed (`X-Buggazi-Signature`). Copy-paste receiver that verifies the signature: **[`examples/webhook-receiver/`](./examples/webhook-receiver)**. Want a nightly project digest in CI? **[`examples/github-actions/`](./examples/github-actions)**.
 
 ## Features
 
@@ -108,10 +162,14 @@ Run `bgz init --agent-schema` — it returns every command + valid flags.
 This is the single source of truth: if it is not in the schema, do not use it.
 ```
 
+## Why this exists
+
+I kept being the middleman — copy-pasting bugs out of my agent's terminal into a tracker it couldn't touch, then copy-pasting the answers back. So I built the tracker the agent runs itself. It's early and I'm iterating fast: if something's rough or missing, [open an issue](https://github.com/jyswee/buggazi/issues) — I read every one.
+
 ## Documentation
 
-- [Quickstart Guides](https://buggazi.com/docs/quickstart.html)
-- [Full Reference](https://buggazi.com/llms.txt)
+- [Quickstart Guides](https://buggazi.ai/docs/quickstart.html)
+- [Full Reference](https://buggazi.ai/llms.txt)
 
 ## License