@puffinstudio/fizzyx 1.0.2 → 1.1.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.
package/README.md CHANGED
@@ -1,8 +1,8 @@
1
1
  # fizzyx
2
2
 
3
- <img src="./docs/images/fizzyx-logo.png" alt="fizzyx logo" width="120" />
3
+ > CLI tool for Fizzy board workflow, OSS/S3-compatible storage, and OpenAPI client generation.
4
4
 
5
- CLI tool for Fizzy board workflow, OSS/S3-compatible storage, and OpenAPI client generation.
5
+ > <img src="./docs/images/fizzyx-logo.webp" alt="fizzyx logo" width="120" />
6
6
 
7
7
  ## Install
8
8
 
@@ -31,7 +31,30 @@ fizzyx flow repair
31
31
 
32
32
  Use `fizzyx skill ...` for bundled skills and project pins. Use flow commands for repair and health checks.
33
33
 
34
- ![Flow command lifecycle](./docs/images/flow-workflow.png)
34
+ ![Flow command lifecycle](./docs/images/flow-workflow.webp)
35
+
36
+ ## Dev Commands (AI Agent Git Workflow)
37
+
38
+ Use these for guard-railed branching and promotion checks (documented in
39
+ `docs/ai-agent-git-workflow.md`):
40
+
41
+ ```sh
42
+ fizzyx dev status --agent
43
+ fizzyx dev start <slug> --kind <feature|fix|hotfix|ops|chore|docs> [--card <id>]
44
+ fizzyx dev sync
45
+ fizzyx dev checkpoint [--message <message>]
46
+ fizzyx dev ready [--agent] [--full]
47
+ fizzyx dev promote <source> --to <environment|main> --dry-run
48
+ fizzyx dev cleanup [--confirm-delete]
49
+ fizzyx dev doctor
50
+ ```
51
+
52
+ Production promotions stay guarded:
53
+
54
+ ```sh
55
+ fizzyx dev promote <source> --to main --dry-run # preview + blocking checks
56
+ fizzyx dev promote <source> --to main --apply --confirm-production
57
+ ```
35
58
 
36
59
  ## Skill Commands
37
60
 
@@ -49,7 +72,7 @@ fizzyx skill migrate --apply
49
72
 
50
73
  Built-in skills are bundled. `skill update [name]` refreshes the local copy from the current fizzyx release.
51
74
 
52
- ![Skill command workflow](./docs/images/skill-workflow.png)
75
+ ![Skill command workflow](./docs/images/skill-workflow.webp)
53
76
 
54
77
  ## Planner Dashboard
55
78
 
@@ -58,12 +81,15 @@ Start a local planner dashboard backed directly by the Fizzy API:
58
81
  ```sh
59
82
  fizzyx planner start
60
83
  fizzyx planner snapshot
84
+ fizzyx planner chat-config --host peer.example.com --port 443 --path /peerjs
61
85
  ```
62
86
 
63
- ![Planner dashboard workflow](./docs/images/planner-workflow.png)
87
+ ![Planner dashboard workflow](./docs/images/planner-workflow.webp)
64
88
 
65
89
  `planner snapshot` prints the same JSON used by the web dashboard. Project workflow uses `BACKLOG → READY → IN PROGRESS → REVIEW → DONE`, with `DONE` coming from closed cards and `BLOCKED` from Not Now/postponed cards.
66
90
 
91
+ `planner chat-config` stores the Team Chat signaling server globally in `~/.config/fizzyx/config.yaml`. Use `--insecure` for local HTTP/ws PeerServer instances.
92
+
67
93
  Planner conventions use tags for filtering:
68
94
 
69
95
  ```text
@@ -108,7 +134,7 @@ fizzyx oss setup --env dev
108
134
  - Credentials are stored in OS keychain via `Bun.secrets`, never in config files or shell history
109
135
  - Without `--env`, keys are stored as `default` — all environments fall back to it
110
136
 
111
- ![OSS command workflow](./docs/images/oss-workflow.png)
137
+ ![OSS command workflow](./docs/images/oss-workflow.webp)
112
138
 
113
139
  ### Sync
114
140
 
@@ -252,7 +278,7 @@ const result = await someAction();
252
278
  fizzyx openapi list
253
279
  ```
254
280
 
255
- ![OpenAPI generation workflow](./docs/images/openapi-workflow.png)
281
+ ![OpenAPI generation workflow](./docs/images/openapi-workflow.webp)
256
282
 
257
283
  ### Initialize OpenAPI config
258
284