@puffinstudio/fizzyx 0.4.5 → 0.4.7

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 (3) hide show
  1. package/README.md +66 -0
  2. package/dist/main.js +60 -57
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -8,6 +8,72 @@ CLI tool for Fizzy board workflow and OSS/S3-compatible storage management.
8
8
  bun add -g @puffinstudio/fizzyx
9
9
  ```
10
10
 
11
+ ## Flow Commands
12
+
13
+ Manage a Fizzy board from a repository-local `.fizzy.yaml`.
14
+
15
+ ### Setup
16
+
17
+ ```sh
18
+ fizzyx setup <board-id>
19
+ fizzyx auth login <token>
20
+ fizzyx auth status
21
+ fizzyx flow doctor
22
+ ```
23
+
24
+ `flow doctor` shows account, board, workflow columns, and whether the CLI is ready to operate on the board.
25
+
26
+ ### Create A Card
27
+
28
+ Use `--draft` to create a unique project-local draft file. This automatically creates `.fizzyx/` when needed and avoids collisions between multiple agents.
29
+
30
+ ```sh
31
+ draft=$(fizzyx flow template --draft)
32
+ $EDITOR "$draft"
33
+ fizzyx flow add Ellen "Implement feature" --desc "$draft"
34
+ rm "$draft"
35
+ ```
36
+
37
+ You can also pipe or provide your own file:
38
+
39
+ ```sh
40
+ fizzyx flow template
41
+ fizzyx flow add <user> "<title>" --desc <file|->
42
+ ```
43
+
44
+ ### Work A Card
45
+
46
+ ```sh
47
+ fizzyx flow mine --fresh
48
+ fizzyx flow next --fresh
49
+ fizzyx flow show <card>
50
+ fizzyx flow start <card>
51
+ fizzyx flow complete-steps <card>
52
+ fizzyx flow done <card> "commit <sha>: <subject>"
53
+ ```
54
+
55
+ `flow done` requires all steps to be complete and closes the card into Done.
56
+
57
+ ### Other Flow Commands
58
+
59
+ ```sh
60
+ fizzyx flow sync
61
+ fizzyx flow status [--fresh]
62
+ fizzyx flow assign <card> <user|me> [user...]
63
+ fizzyx flow block <card> "<reason>"
64
+ fizzyx flow repair-markdown <card>
65
+ fizzyx flow std <card>
66
+ fizzyx flow std-all
67
+ fizzyx flow workflow
68
+ fizzyx flow skill
69
+ fizzyx flow skill init [--force]
70
+ ```
71
+
72
+ - `flow assign <card> me` assigns the card to the authenticated Fizzy user.
73
+ - `flow assign` skips users who are already assigned.
74
+ - `flow block` moves the card to Not Now.
75
+ - `flow workflow`, `flow skill`, and `flow template` prefer project-local overrides under `.agents/skills/fizzyx/`.
76
+
11
77
  ## OSS Commands
12
78
 
13
79
  Manage S3-compatible object storage (Alibaba Cloud OSS, AWS S3, MinIO, etc.).