buggazi 2.3.1 → 2.3.3

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.
package/README.md CHANGED
@@ -1,13 +1,17 @@
1
1
  # bgz
2
2
 
3
+ [![npm version](https://img.shields.io/npm/v/buggazi.svg)](https://www.npmjs.com/package/buggazi)
4
+
3
5
  Project management for coding agents. Bug tracking, feature planning, sprint management - as easy as git.
4
6
 
5
7
  ## Install
6
8
 
7
9
  ```bash
8
- npm install -g bgz
10
+ npm install -g buggazi
9
11
  ```
10
12
 
13
+ The npm package is `buggazi`; the command is `bgz`.
14
+
11
15
  ## Quick Start
12
16
 
13
17
  ```bash
@@ -30,12 +34,26 @@ bgz fix BUG-2026-0608-001 -c a3f2c1d -f "Added null check"
30
34
  bgz --help
31
35
  ```
32
36
 
37
+ ## Cross-Tenant Contracts
38
+
39
+ File bugs and features directly into a partner project over a contract — agent to agent.
40
+
41
+ ```bash
42
+ # File a bug to a partner, with a visual repro attached
43
+ bgz contract CTR-ID file-bug "Checkout 500s on submit" -s P1 --screenshot ./crash.png
44
+
45
+ # Bump severity after filing — no delete + re-file
46
+ bgz contract CTR-ID update-bug BUG-ID -s P0
47
+ ```
48
+
49
+ 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).
50
+
33
51
  ## Features
34
52
 
35
- - **Bugs** - file, track, resolve with evidence
53
+ - **Bugs** - file, track, resolve with evidence and screenshots
36
54
  - **Features** - plan, prioritize, link to bugs, dependency trees
37
55
  - **Sprints** - create, track progress, kanban board
38
- - **Contracts** - cross-tenant bug/feature filing between projects
56
+ - **Contracts** - cross-tenant bug/feature filing between projects, with screenshot attachments
39
57
  - **Snapshots** - terminal project views, shareable HTML links
40
58
  - **Audit trail** - EU AI Act compliant, immutable event log
41
59
 
@@ -43,21 +61,23 @@ bgz --help
43
61
 
44
62
  ```bash
45
63
  bgz login --local --key YOUR_KEY # saves to .bgz/config.json (project-local)
46
- bgz login --key YOUR_KEY # saves to ~/.bgz/config.json (global)
47
- bgz config # show which config is active
64
+ bgz config # show active config
48
65
  ```
49
66
 
50
- Local config overrides global. Add `.bgz/` to your `.gitignore`.
67
+ Config is per-project and auto-loaded from `.bgz/config.json`. Add `.bgz/` to your `.gitignore`.
51
68
 
52
69
  ## Agent Integration
53
70
 
54
- Add to your CLAUDE.md, .cursorrules, .clinerules, or .windsurfrules:
71
+ Add to your CLAUDE.md, .cursorrules, .clinerules, .windsurfrules, or AGENTS.md:
55
72
 
56
73
  ```
57
74
  ## Buggazi
58
- Use the bgz CLI for bug tracking and feature planning.
59
- Key is in .bgz/config.json (auto-loaded).
60
- Run bgz --help for full reference.
75
+ This project uses Buggazi for bug tracking and feature planning.
76
+ Use the `bgz` CLI. Config is in .bgz/config.json (auto-loaded).
77
+ If not configured: bgz login --local --key YOUR_KEY
78
+
79
+ Run `bgz init --agent-schema` — it returns every command + valid flags.
80
+ This is the single source of truth: if it is not in the schema, do not use it.
61
81
  ```
62
82
 
63
83
  ## Documentation