@synergenius/flow-weaver 0.21.10 → 0.21.11

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 (48) hide show
  1. package/README.md +59 -57
  2. package/dist/cli/commands/context.js +2 -2
  3. package/dist/cli/commands/create.js +2 -2
  4. package/dist/cli/commands/docs.js +5 -5
  5. package/dist/cli/commands/export.d.ts +4 -4
  6. package/dist/cli/commands/export.js +4 -4
  7. package/dist/cli/commands/init-personas.js +11 -11
  8. package/dist/cli/commands/init.js +5 -5
  9. package/dist/cli/commands/market.js +5 -5
  10. package/dist/cli/commands/openapi.d.ts +3 -3
  11. package/dist/cli/commands/openapi.js +3 -3
  12. package/dist/cli/commands/run.d.ts +5 -5
  13. package/dist/cli/commands/run.js +5 -5
  14. package/dist/cli/commands/serve.d.ts +5 -5
  15. package/dist/cli/commands/serve.js +5 -5
  16. package/dist/cli/commands/templates.js +2 -2
  17. package/dist/cli/flow-weaver.mjs +58 -58
  18. package/dist/cli/index.js +10 -10
  19. package/dist/cli/templates/workflows/aggregator.js +1 -1
  20. package/dist/cli/templates/workflows/ai-agent.js +1 -1
  21. package/dist/cli/templates/workflows/ai-chat.js +1 -1
  22. package/dist/cli/templates/workflows/ai-rag.js +1 -1
  23. package/dist/cli/templates/workflows/ai-react.js +1 -1
  24. package/dist/cli/templates/workflows/conditional.js +1 -1
  25. package/dist/cli/templates/workflows/error-handler.js +1 -1
  26. package/dist/cli/templates/workflows/foreach.js +1 -1
  27. package/dist/cli/templates/workflows/sequential.js +2 -2
  28. package/dist/cli/templates/workflows/webhook.js +1 -1
  29. package/dist/doc-metadata/extractors/cli-commands.js +24 -24
  30. package/dist/doc-metadata/types.d.ts +1 -1
  31. package/dist/generated-version.d.ts +1 -1
  32. package/dist/generated-version.js +1 -1
  33. package/dist/mcp/server.js +1 -1
  34. package/docs/reference/advanced-annotations.md +4 -4
  35. package/docs/reference/built-in-nodes.md +2 -2
  36. package/docs/reference/cli-reference.md +142 -140
  37. package/docs/reference/compilation.md +12 -12
  38. package/docs/reference/concepts.md +29 -29
  39. package/docs/reference/debugging.md +34 -34
  40. package/docs/reference/deployment.md +27 -27
  41. package/docs/reference/export-interface.md +1 -1
  42. package/docs/reference/iterative-development.md +6 -6
  43. package/docs/reference/marketplace.md +18 -18
  44. package/docs/reference/node-conversion.md +1 -1
  45. package/docs/reference/patterns.md +7 -7
  46. package/docs/reference/scaffold.md +22 -22
  47. package/docs/reference/tutorial.md +29 -29
  48. package/package.json +3 -2
@@ -6,7 +6,9 @@ keywords: [cli, commands, compile, validate, strip, run, watch, dev, serve, expo
6
6
 
7
7
  # CLI Reference
8
8
 
9
- Complete reference for all `flow-weaver` CLI commands.
9
+ Complete reference for all `fw` CLI commands.
10
+
11
+ `fw` is the CLI command. `flow-weaver` also works as an alias.
10
12
 
11
13
  ## Quick Reference
12
14
 
@@ -52,7 +54,7 @@ Complete reference for all `flow-weaver` CLI commands.
52
54
  Compile workflow files to TypeScript. Inserts generated code into marker sections in the source file — user code outside markers is preserved.
53
55
 
54
56
  ```bash
55
- flow-weaver compile <input> [options]
57
+ fw compile <input> [options]
56
58
  ```
57
59
 
58
60
  | Flag | Description | Default |
@@ -77,11 +79,11 @@ flow-weaver compile <input> [options]
77
79
 
78
80
  **Examples:**
79
81
  ```bash
80
- flow-weaver compile my-workflow.ts
81
- flow-weaver compile '**/*.ts' -o .output
82
- flow-weaver compile my-workflow.ts --format cjs
83
- flow-weaver compile workflow.ts --target inngest --serve --framework next
84
- flow-weaver compile workflow.ts --production --clean
82
+ fw compile my-workflow.ts
83
+ fw compile '**/*.ts' -o .output
84
+ fw compile my-workflow.ts --format cjs
85
+ fw compile workflow.ts --target inngest --serve --framework next
86
+ fw compile workflow.ts --production --clean
85
87
  ```
86
88
 
87
89
  > See also: [Compilation](compilation) for details on targets and Inngest integration.
@@ -93,7 +95,7 @@ flow-weaver compile workflow.ts --production --clean
93
95
  Validate workflow files without compiling. Reports errors and warnings with suggestions.
94
96
 
95
97
  ```bash
96
- flow-weaver validate <input> [options]
98
+ fw validate <input> [options]
97
99
  ```
98
100
 
99
101
  | Flag | Description | Default |
@@ -106,9 +108,9 @@ flow-weaver validate <input> [options]
106
108
 
107
109
  **Examples:**
108
110
  ```bash
109
- flow-weaver validate my-workflow.ts
110
- flow-weaver validate '**/*.ts' --verbose
111
- flow-weaver validate workflow.ts --json --strict
111
+ fw validate my-workflow.ts
112
+ fw validate '**/*.ts' --verbose
113
+ fw validate workflow.ts --json --strict
112
114
  ```
113
115
 
114
116
  ---
@@ -118,7 +120,7 @@ flow-weaver validate workflow.ts --json --strict
118
120
  Remove generated code from compiled workflow files. Deletes the runtime section and replaces each workflow body with a `throw new Error('Not implemented')` placeholder. Useful for committing clean source files to version control.
119
121
 
120
122
  ```bash
121
- flow-weaver strip <input> [options]
123
+ fw strip <input> [options]
122
124
  ```
123
125
 
124
126
  | Flag | Description | Default |
@@ -129,9 +131,9 @@ flow-weaver strip <input> [options]
129
131
 
130
132
  **Examples:**
131
133
  ```bash
132
- flow-weaver strip my-workflow.ts
133
- flow-weaver strip '**/*.ts' --dry-run
134
- flow-weaver strip my-workflow.ts -o cleaned/
134
+ fw strip my-workflow.ts
135
+ fw strip '**/*.ts' --dry-run
136
+ fw strip my-workflow.ts -o cleaned/
135
137
  ```
136
138
 
137
139
  ---
@@ -141,7 +143,7 @@ flow-weaver strip my-workflow.ts -o cleaned/
141
143
  Output workflow structure in LLM-friendly formats.
142
144
 
143
145
  ```bash
144
- flow-weaver describe <input> [options]
146
+ fw describe <input> [options]
145
147
  ```
146
148
 
147
149
  | Flag | Description | Default |
@@ -153,10 +155,10 @@ flow-weaver describe <input> [options]
153
155
 
154
156
  **Examples:**
155
157
  ```bash
156
- flow-weaver describe workflow.ts
157
- flow-weaver describe workflow.ts --format mermaid
158
- flow-weaver describe workflow.ts --node validator
159
- flow-weaver describe workflow.ts --format paths
158
+ fw describe workflow.ts
159
+ fw describe workflow.ts --format mermaid
160
+ fw describe workflow.ts --node validator
161
+ fw describe workflow.ts --format paths
160
162
  ```
161
163
 
162
164
  ---
@@ -166,7 +168,7 @@ flow-weaver describe workflow.ts --format paths
166
168
  Execute a workflow file directly. Compiles in memory and runs immediately.
167
169
 
168
170
  ```bash
169
- flow-weaver run <input> [options]
171
+ fw run <input> [options]
170
172
  ```
171
173
 
172
174
  | Flag | Description | Default |
@@ -187,14 +189,14 @@ flow-weaver run <input> [options]
187
189
 
188
190
  **Examples:**
189
191
  ```bash
190
- flow-weaver run workflow.ts --params '{"amount": 500}'
191
- flow-weaver run workflow.ts --params-file input.json --trace
192
- flow-weaver run workflow.ts --mocks '{"fast": true, "events": {"app/approved": {"status": "ok"}}}'
193
- flow-weaver run workflow.ts --timeout 30000 --json
194
- flow-weaver run workflow.ts --debug
195
- flow-weaver run workflow.ts --checkpoint
196
- flow-weaver run workflow.ts --resume
197
- flow-weaver run workflow.ts --debug --breakpoint processData --breakpoint validate
192
+ fw run workflow.ts --params '{"amount": 500}'
193
+ fw run workflow.ts --params-file input.json --trace
194
+ fw run workflow.ts --mocks '{"fast": true, "events": {"app/approved": {"status": "ok"}}}'
195
+ fw run workflow.ts --timeout 30000 --json
196
+ fw run workflow.ts --debug
197
+ fw run workflow.ts --checkpoint
198
+ fw run workflow.ts --resume
199
+ fw run workflow.ts --debug --breakpoint processData --breakpoint validate
198
200
  ```
199
201
 
200
202
  > See also: [Built-in Nodes](built-in-nodes) for mock configuration details, [Debugging](debugging) for debug REPL commands and checkpoint details.
@@ -208,7 +210,7 @@ flow-weaver run workflow.ts --debug --breakpoint processData --breakpoint valida
208
210
  Watch workflow files and recompile on changes.
209
211
 
210
212
  ```bash
211
- flow-weaver watch <input> [options]
213
+ fw watch <input> [options]
212
214
  ```
213
215
 
214
216
  | Flag | Description | Default |
@@ -222,8 +224,8 @@ flow-weaver watch <input> [options]
222
224
 
223
225
  **Examples:**
224
226
  ```bash
225
- flow-weaver watch my-workflow.ts
226
- flow-weaver watch 'src/**/*.ts' -o dist
227
+ fw watch my-workflow.ts
228
+ fw watch 'src/**/*.ts' -o dist
227
229
  ```
228
230
 
229
231
  ---
@@ -233,7 +235,7 @@ flow-weaver watch 'src/**/*.ts' -o dist
233
235
  Watch, compile, and run workflow on changes. Combines `watch` + `run` into a single command for rapid iteration.
234
236
 
235
237
  ```bash
236
- flow-weaver dev <input> [options]
238
+ fw dev <input> [options]
237
239
  ```
238
240
 
239
241
  | Flag | Description | Default |
@@ -252,9 +254,9 @@ flow-weaver dev <input> [options]
252
254
 
253
255
  **Examples:**
254
256
  ```bash
255
- flow-weaver dev workflow.ts --params '{"input": "hello"}'
256
- flow-weaver dev workflow.ts --once --json
257
- flow-weaver dev workflow.ts --target inngest --port 8080
257
+ fw dev workflow.ts --params '{"input": "hello"}'
258
+ fw dev workflow.ts --once --json
259
+ fw dev workflow.ts --target inngest --port 8080
258
260
  ```
259
261
 
260
262
  ---
@@ -264,7 +266,7 @@ flow-weaver dev workflow.ts --target inngest --port 8080
264
266
  Start an HTTP server exposing workflows as REST endpoints. Supports hot reload, CORS, and Swagger UI.
265
267
 
266
268
  ```bash
267
- flow-weaver serve [directory] [options]
269
+ fw serve [directory] [options]
268
270
  ```
269
271
 
270
272
  | Flag | Description | Default |
@@ -279,9 +281,9 @@ flow-weaver serve [directory] [options]
279
281
 
280
282
  **Examples:**
281
283
  ```bash
282
- flow-weaver serve ./workflows
283
- flow-weaver serve ./workflows --port 8080 --swagger
284
- flow-weaver serve --production --precompile --no-watch
284
+ fw serve ./workflows
285
+ fw serve ./workflows --port 8080 --swagger
286
+ fw serve --production --precompile --no-watch
285
287
  ```
286
288
 
287
289
  > See also: [Deployment](deployment) for production serving and export.
@@ -293,7 +295,7 @@ flow-weaver serve --production --precompile --no-watch
293
295
  Connect to the editor and stream integration events as JSON lines.
294
296
 
295
297
  ```bash
296
- flow-weaver listen [options]
298
+ fw listen [options]
297
299
  ```
298
300
 
299
301
  | Flag | Description | Default |
@@ -309,7 +311,7 @@ flow-weaver listen [options]
309
311
  Generate SVG diagram of a workflow.
310
312
 
311
313
  ```bash
312
- flow-weaver diagram <input> [options]
314
+ fw diagram <input> [options]
313
315
  ```
314
316
 
315
317
  | Flag | Description | Default |
@@ -323,9 +325,9 @@ flow-weaver diagram <input> [options]
323
325
 
324
326
  **Examples:**
325
327
  ```bash
326
- flow-weaver diagram workflow.ts
327
- flow-weaver diagram workflow.ts --theme light -o diagram.svg
328
- flow-weaver diagram workflow.ts --no-port-labels --width 1200
328
+ fw diagram workflow.ts
329
+ fw diagram workflow.ts --theme light -o diagram.svg
330
+ fw diagram workflow.ts --no-port-labels --width 1200
329
331
  ```
330
332
 
331
333
  ---
@@ -335,7 +337,7 @@ flow-weaver diagram workflow.ts --no-port-labels --width 1200
335
337
  Output the JSDoc annotation grammar as HTML railroad diagrams or EBNF text.
336
338
 
337
339
  ```bash
338
- flow-weaver grammar [options]
340
+ fw grammar [options]
339
341
  ```
340
342
 
341
343
  | Flag | Description | Default |
@@ -345,9 +347,9 @@ flow-weaver grammar [options]
345
347
 
346
348
  **Examples:**
347
349
  ```bash
348
- flow-weaver grammar
349
- flow-weaver grammar --format ebnf
350
- flow-weaver grammar -o grammar.html
350
+ fw grammar
351
+ fw grammar --format ebnf
352
+ fw grammar -o grammar.html
351
353
  ```
352
354
 
353
355
  ---
@@ -359,7 +361,7 @@ flow-weaver grammar -o grammar.html
359
361
  Compare two workflow files semantically. Reports node type changes, instance changes, connection changes, and breaking changes.
360
362
 
361
363
  ```bash
362
- flow-weaver diff <file1> <file2> [options]
364
+ fw diff <file1> <file2> [options]
363
365
  ```
364
366
 
365
367
  | Flag | Description | Default |
@@ -370,19 +372,19 @@ flow-weaver diff <file1> <file2> [options]
370
372
 
371
373
  **Examples:**
372
374
  ```bash
373
- flow-weaver diff workflow-v1.ts workflow-v2.ts
374
- flow-weaver diff workflow-v1.ts workflow-v2.ts --format json
375
- flow-weaver diff old.ts new.ts --exit-zero # for CI pipelines
375
+ fw diff workflow-v1.ts workflow-v2.ts
376
+ fw diff workflow-v1.ts workflow-v2.ts --format json
377
+ fw diff old.ts new.ts --exit-zero # for CI pipelines
376
378
  ```
377
379
 
378
380
  ---
379
381
 
380
382
  ### doctor
381
383
 
382
- Check project environment and configuration for flow-weaver compatibility.
384
+ Check project environment and configuration for Flow Weaver compatibility.
383
385
 
384
386
  ```bash
385
- flow-weaver doctor [options]
387
+ fw doctor [options]
386
388
  ```
387
389
 
388
390
  | Flag | Description | Default |
@@ -395,10 +397,10 @@ flow-weaver doctor [options]
395
397
 
396
398
  ### init
397
399
 
398
- Create a new flow-weaver project with recommended structure.
400
+ Create a new Flow Weaver project with recommended structure.
399
401
 
400
402
  ```bash
401
- flow-weaver init [directory] [options]
403
+ fw init [directory] [options]
402
404
  ```
403
405
 
404
406
  | Flag | Description | Default |
@@ -416,9 +418,9 @@ flow-weaver init [directory] [options]
416
418
 
417
419
  **Examples:**
418
420
  ```bash
419
- flow-weaver init my-project
420
- flow-weaver init --template ai-agent -y
421
- flow-weaver init my-project --format cjs --no-git
421
+ fw init my-project
422
+ fw init --template ai-agent -y
423
+ fw init my-project --format cjs --no-git
422
424
  ```
423
425
 
424
426
  ---
@@ -428,7 +430,7 @@ flow-weaver init my-project --format cjs --no-git
428
430
  Create a workflow from a template. Appends to existing files.
429
431
 
430
432
  ```bash
431
- flow-weaver create workflow <template> <file> [options]
433
+ fw create workflow <template> <file> [options]
432
434
  ```
433
435
 
434
436
  | Flag | Description | Default |
@@ -446,9 +448,9 @@ flow-weaver create workflow <template> <file> [options]
446
448
 
447
449
  **Examples:**
448
450
  ```bash
449
- flow-weaver create workflow sequential my-workflow.ts
450
- flow-weaver create workflow ai-agent agent.ts --provider openai --model gpt-4o
451
- flow-weaver create workflow foreach pipeline.ts --nodes "fetch,parse,store" --async
451
+ fw create workflow sequential my-workflow.ts
452
+ fw create workflow ai-agent agent.ts --provider openai --model gpt-4o
453
+ fw create workflow foreach pipeline.ts --nodes "fetch,parse,store" --async
452
454
  ```
453
455
 
454
456
  ---
@@ -458,7 +460,7 @@ flow-weaver create workflow foreach pipeline.ts --nodes "fetch,parse,store" --as
458
460
  Create a node type from a template. Appends to existing files.
459
461
 
460
462
  ```bash
461
- flow-weaver create node <name> <file> [options]
463
+ fw create node <name> <file> [options]
462
464
  ```
463
465
 
464
466
  | Flag | Description | Default |
@@ -471,9 +473,9 @@ flow-weaver create node <name> <file> [options]
471
473
 
472
474
  **Examples:**
473
475
  ```bash
474
- flow-weaver create node myProcessor my-workflow.ts
475
- flow-weaver create node apiClient my-workflow.ts --template http
476
- flow-weaver create node checker my-workflow.ts --template validator
476
+ fw create node myProcessor my-workflow.ts
477
+ fw create node apiClient my-workflow.ts --template http
478
+ fw create node checker my-workflow.ts --template validator
477
479
  ```
478
480
 
479
481
  ---
@@ -485,7 +487,7 @@ Modify workflow structure programmatically. Parses the file, applies the operati
485
487
  #### modify addNode
486
488
 
487
489
  ```bash
488
- flow-weaver modify addNode --file <path> --nodeId <id> --nodeType <type>
490
+ fw modify addNode --file <path> --nodeId <id> --nodeType <type>
489
491
  ```
490
492
 
491
493
  Adds a new node instance to the workflow. Auto-positions to the right of the rightmost existing node. Warns if the node type isn't defined in the file.
@@ -493,7 +495,7 @@ Adds a new node instance to the workflow. Auto-positions to the right of the rig
493
495
  #### modify removeNode
494
496
 
495
497
  ```bash
496
- flow-weaver modify removeNode --file <path> --nodeId <id>
498
+ fw modify removeNode --file <path> --nodeId <id>
497
499
  ```
498
500
 
499
501
  Removes a node instance and all connections attached to it.
@@ -501,7 +503,7 @@ Removes a node instance and all connections attached to it.
501
503
  #### modify addConnection
502
504
 
503
505
  ```bash
504
- flow-weaver modify addConnection --file <path> --from <node.port> --to <node.port>
506
+ fw modify addConnection --file <path> --from <node.port> --to <node.port>
505
507
  ```
506
508
 
507
509
  Adds a connection between two ports. Both nodes must exist. Port names are validated against the node type definition when available.
@@ -509,7 +511,7 @@ Adds a connection between two ports. Both nodes must exist. Port names are valid
509
511
  #### modify removeConnection
510
512
 
511
513
  ```bash
512
- flow-weaver modify removeConnection --file <path> --from <node.port> --to <node.port>
514
+ fw modify removeConnection --file <path> --from <node.port> --to <node.port>
513
515
  ```
514
516
 
515
517
  Removes an existing connection.
@@ -517,7 +519,7 @@ Removes an existing connection.
517
519
  #### modify renameNode
518
520
 
519
521
  ```bash
520
- flow-weaver modify renameNode --file <path> --oldId <id> --newId <id>
522
+ fw modify renameNode --file <path> --oldId <id> --newId <id>
521
523
  ```
522
524
 
523
525
  Renames a node instance and updates all connections that reference it.
@@ -525,7 +527,7 @@ Renames a node instance and updates all connections that reference it.
525
527
  #### modify setPosition
526
528
 
527
529
  ```bash
528
- flow-weaver modify setPosition --file <path> --nodeId <id> --x <number> --y <number>
530
+ fw modify setPosition --file <path> --nodeId <id> --x <number> --y <number>
529
531
  ```
530
532
 
531
533
  Sets the canvas position of a node instance.
@@ -533,7 +535,7 @@ Sets the canvas position of a node instance.
533
535
  #### modify setLabel
534
536
 
535
537
  ```bash
536
- flow-weaver modify setLabel --file <path> --nodeId <id> --label <text>
538
+ fw modify setLabel --file <path> --nodeId <id> --label <text>
537
539
  ```
538
540
 
539
541
  Sets the display label for a node instance.
@@ -541,13 +543,13 @@ Sets the display label for a node instance.
541
543
 
542
544
  **Examples:**
543
545
  ```bash
544
- flow-weaver modify addNode --file workflow.ts --nodeId validator --nodeType validateInput
545
- flow-weaver modify addConnection --file workflow.ts --from Start.data --to validator.input
546
- flow-weaver modify removeNode --file workflow.ts --nodeId oldStep
547
- flow-weaver modify removeConnection --file workflow.ts --from a.output --to b.input
548
- flow-weaver modify renameNode --file workflow.ts --oldId step1 --newId validateStep
549
- flow-weaver modify setPosition --file workflow.ts --nodeId step1 --x 200 --y 100
550
- flow-weaver modify setLabel --file workflow.ts --nodeId step1 --label "Validate Input"
546
+ fw modify addNode --file workflow.ts --nodeId validator --nodeType validateInput
547
+ fw modify addConnection --file workflow.ts --from Start.data --to validator.input
548
+ fw modify removeNode --file workflow.ts --nodeId oldStep
549
+ fw modify removeConnection --file workflow.ts --from a.output --to b.input
550
+ fw modify renameNode --file workflow.ts --oldId step1 --newId validateStep
551
+ fw modify setPosition --file workflow.ts --nodeId step1 --x 200 --y 100
552
+ fw modify setLabel --file workflow.ts --nodeId step1 --label "Validate Input"
551
553
  ```
552
554
 
553
555
  ---
@@ -557,8 +559,8 @@ flow-weaver modify setLabel --file workflow.ts --nodeId step1 --label "Validate
557
559
  Replace a stub node (`declare function`) with a real function skeleton containing the correct signature, JSDoc annotations, and return type.
558
560
 
559
561
  ```bash
560
- flow-weaver implement <input> <node> [options]
561
- flow-weaver implement <input> --nodeId <id> [options]
562
+ fw implement <input> <node> [options]
563
+ fw implement <input> --nodeId <id> [options]
562
564
  ```
563
565
 
564
566
  The node can be specified as a positional argument or with the `--nodeId` flag.
@@ -571,9 +573,9 @@ The node can be specified as a positional argument or with the `--nodeId` flag.
571
573
 
572
574
  **Examples:**
573
575
  ```bash
574
- flow-weaver implement workflow.ts validateInput
575
- flow-weaver implement workflow.ts --nodeId validateInput
576
- flow-weaver implement workflow.ts myNode --preview
576
+ fw implement workflow.ts validateInput
577
+ fw implement workflow.ts --nodeId validateInput
578
+ fw implement workflow.ts myNode --preview
577
579
  ```
578
580
 
579
581
  ---
@@ -583,7 +585,7 @@ flow-weaver implement workflow.ts myNode --preview
583
585
  Report implementation progress for stub workflows. Shows which nodes are implemented vs still declared as stubs.
584
586
 
585
587
  ```bash
586
- flow-weaver status <input> [options]
588
+ fw status <input> [options]
587
589
  ```
588
590
 
589
591
  | Flag | Description | Default |
@@ -598,7 +600,7 @@ flow-weaver status <input> [options]
598
600
  List available workflow and node templates.
599
601
 
600
602
  ```bash
601
- flow-weaver templates [options]
603
+ fw templates [options]
602
604
  ```
603
605
 
604
606
  | Flag | Description | Default |
@@ -616,7 +618,7 @@ flow-weaver templates [options]
616
618
  List patterns in a file or directory.
617
619
 
618
620
  ```bash
619
- flow-weaver pattern list <path> [options]
621
+ fw pattern list <path> [options]
620
622
  ```
621
623
 
622
624
  | Flag | Description | Default |
@@ -630,7 +632,7 @@ flow-weaver pattern list <path> [options]
630
632
  Apply a reusable pattern to a workflow file.
631
633
 
632
634
  ```bash
633
- flow-weaver pattern apply <pattern-file> <target-file> [options]
635
+ fw pattern apply <pattern-file> <target-file> [options]
634
636
  ```
635
637
 
636
638
  | Flag | Description | Default |
@@ -646,7 +648,7 @@ flow-weaver pattern apply <pattern-file> <target-file> [options]
646
648
  Extract a pattern from selected workflow nodes.
647
649
 
648
650
  ```bash
649
- flow-weaver pattern extract <source-file> [options]
651
+ fw pattern extract <source-file> [options]
650
652
  ```
651
653
 
652
654
  | Flag | Description | Default |
@@ -658,8 +660,8 @@ flow-weaver pattern extract <source-file> [options]
658
660
 
659
661
  **Examples:**
660
662
  ```bash
661
- flow-weaver pattern extract workflow.ts --nodes a,b -o extracted.ts
662
- flow-weaver pattern extract workflow.ts --nodes validator,transformer -o validate-transform.ts --name validateTransform
663
+ fw pattern extract workflow.ts --nodes a,b -o extracted.ts
664
+ fw pattern extract workflow.ts --nodes validator,transformer -o validate-transform.ts --name validateTransform
663
665
  ```
664
666
 
665
667
  > See also: [Patterns](patterns) for the full pattern system guide.
@@ -673,7 +675,7 @@ flow-weaver pattern extract workflow.ts --nodes validator,transformer -o validat
673
675
  Export workflow as a serverless function for cloud platforms.
674
676
 
675
677
  ```bash
676
- flow-weaver export <input> [options]
678
+ fw export <input> [options]
677
679
  ```
678
680
 
679
681
  | Flag | Description | Default |
@@ -690,13 +692,13 @@ flow-weaver export <input> [options]
690
692
 
691
693
  **Examples:**
692
694
  ```bash
693
- flow-weaver export workflow.ts --target vercel --output api/
694
- flow-weaver export workflows.ts --target lambda --output dist/ --multi --docs
695
- flow-weaver export workflow.ts --target inngest --output dist/ --durable-steps
696
- flow-weaver export workflow.ts --target cloudflare --output worker/
695
+ fw export workflow.ts --target vercel --output api/
696
+ fw export workflows.ts --target lambda --output dist/ --multi --docs
697
+ fw export workflow.ts --target inngest --output dist/ --durable-steps
698
+ fw export workflow.ts --target cloudflare --output worker/
697
699
  ```
698
700
 
699
- > Available targets depend on installed `flow-weaver-pack-*` packages. See [Deployment](deployment) for installation instructions and target-specific details.
701
+ > Available targets depend on installed `flow-weaver-pack-*` packages (the package names stay as-is). See [Deployment](deployment) for installation instructions and target-specific details.
700
702
 
701
703
  ---
702
704
 
@@ -705,7 +707,7 @@ flow-weaver export workflow.ts --target cloudflare --output worker/
705
707
  Generate OpenAPI specification from workflows in a directory.
706
708
 
707
709
  ```bash
708
- flow-weaver openapi <directory> [options]
710
+ fw openapi <directory> [options]
709
711
  ```
710
712
 
711
713
  | Flag | Description | Default |
@@ -719,8 +721,8 @@ flow-weaver openapi <directory> [options]
719
721
 
720
722
  **Examples:**
721
723
  ```bash
722
- flow-weaver openapi ./workflows --output api-spec.json
723
- flow-weaver openapi ./workflows --format yaml --server https://api.example.com
724
+ fw openapi ./workflows --output api-spec.json
725
+ fw openapi ./workflows --format yaml --server https://api.example.com
724
726
  ```
725
727
 
726
728
  ---
@@ -732,7 +734,7 @@ flow-weaver openapi ./workflows --format yaml --server https://api.example.com
732
734
  Migrate workflow files to current syntax via parse-regenerate round-trip. Adds defaults for missing fields and transforms edge cases.
733
735
 
734
736
  ```bash
735
- flow-weaver migrate <glob> [options]
737
+ fw migrate <glob> [options]
736
738
  ```
737
739
 
738
740
  | Flag | Description | Default |
@@ -744,9 +746,9 @@ Ignores `**/node_modules/**` and `**/*.generated.ts`.
744
746
 
745
747
  **Examples:**
746
748
  ```bash
747
- flow-weaver migrate '**/*.ts'
748
- flow-weaver migrate 'src/**/*.ts' --dry-run
749
- flow-weaver migrate '**/*.ts' --diff
749
+ fw migrate '**/*.ts'
750
+ fw migrate 'src/**/*.ts' --dry-run
751
+ fw migrate '**/*.ts' --diff
750
752
  ```
751
753
 
752
754
  ---
@@ -758,7 +760,7 @@ flow-weaver migrate '**/*.ts' --diff
758
760
  Scaffold a new marketplace package.
759
761
 
760
762
  ```bash
761
- flow-weaver market init <name> [options]
763
+ fw market init <name> [options]
762
764
  ```
763
765
 
764
766
  | Flag | Description | Default |
@@ -774,7 +776,7 @@ flow-weaver market init <name> [options]
774
776
  Validate and generate `flowweaver.manifest.json`.
775
777
 
776
778
  ```bash
777
- flow-weaver market pack [directory] [options]
779
+ fw market pack [directory] [options]
778
780
  ```
779
781
 
780
782
  | Flag | Description | Default |
@@ -789,7 +791,7 @@ flow-weaver market pack [directory] [options]
789
791
  Pack and publish to npm.
790
792
 
791
793
  ```bash
792
- flow-weaver market publish [directory] [options]
794
+ fw market publish [directory] [options]
793
795
  ```
794
796
 
795
797
  | Flag | Description | Default |
@@ -804,7 +806,7 @@ flow-weaver market publish [directory] [options]
804
806
  Install a marketplace package.
805
807
 
806
808
  ```bash
807
- flow-weaver market install <package> [options]
809
+ fw market install <package> [options]
808
810
  ```
809
811
 
810
812
  | Flag | Description | Default |
@@ -818,7 +820,7 @@ flow-weaver market install <package> [options]
818
820
  Search npm for marketplace packages.
819
821
 
820
822
  ```bash
821
- flow-weaver market search [query] [options]
823
+ fw market search [query] [options]
822
824
  ```
823
825
 
824
826
  | Flag | Description | Default |
@@ -834,7 +836,7 @@ flow-weaver market search [query] [options]
834
836
  List installed marketplace packages.
835
837
 
836
838
  ```bash
837
- flow-weaver market list [options]
839
+ fw market list [options]
838
840
  ```
839
841
 
840
842
  | Flag | Description | Default |
@@ -852,7 +854,7 @@ flow-weaver market list [options]
852
854
  Scaffold a new external plugin with component area and optional system module.
853
855
 
854
856
  ```bash
855
- flow-weaver plugin init <name> [options]
857
+ fw plugin init <name> [options]
856
858
  ```
857
859
 
858
860
  | Flag | Description | Default |
@@ -864,8 +866,8 @@ flow-weaver plugin init <name> [options]
864
866
 
865
867
  **Examples:**
866
868
  ```bash
867
- flow-weaver plugin init my-plugin
868
- flow-weaver plugin init my-plugin --area sidebar --no-system
869
+ fw plugin init my-plugin
870
+ fw plugin init my-plugin --area sidebar --no-system
869
871
  ```
870
872
 
871
873
  ---
@@ -877,7 +879,7 @@ flow-weaver plugin init my-plugin --area sidebar --no-system
877
879
  List available documentation topics.
878
880
 
879
881
  ```bash
880
- flow-weaver docs [list] [options]
882
+ fw docs [list] [options]
881
883
  ```
882
884
 
883
885
  | Flag | Description | Default |
@@ -892,7 +894,7 @@ flow-weaver docs [list] [options]
892
894
  Read a documentation topic.
893
895
 
894
896
  ```bash
895
- flow-weaver docs read <topic> [options]
897
+ fw docs read <topic> [options]
896
898
  ```
897
899
 
898
900
  | Flag | Description | Default |
@@ -907,7 +909,7 @@ flow-weaver docs read <topic> [options]
907
909
  Search across all documentation.
908
910
 
909
911
  ```bash
910
- flow-weaver docs search <query> [options]
912
+ fw docs search <query> [options]
911
913
  ```
912
914
 
913
915
  | Flag | Description | Default |
@@ -916,10 +918,10 @@ flow-weaver docs search <query> [options]
916
918
 
917
919
  **Examples:**
918
920
  ```bash
919
- flow-weaver docs
920
- flow-weaver docs read error-codes
921
- flow-weaver docs read scaffold --compact
922
- flow-weaver docs search "missing workflow"
921
+ fw docs
922
+ fw docs read error-codes
923
+ fw docs read scaffold --compact
924
+ fw docs search "missing workflow"
923
925
  ```
924
926
 
925
927
  ---
@@ -929,7 +931,7 @@ flow-weaver docs search "missing workflow"
929
931
  Generate a self-contained LLM context bundle from documentation and annotation grammar. Two profiles control the output format: `standalone` produces a complete reference for pasting into any LLM, `assistant` produces a leaner version that assumes MCP tools are available.
930
932
 
931
933
  ```bash
932
- flow-weaver context [preset] [options]
934
+ fw context [preset] [options]
933
935
  ```
934
936
 
935
937
  | Flag | Description | Default |
@@ -945,12 +947,12 @@ Built-in presets: `core` (concepts, grammar, tutorial), `authoring` (concepts, g
945
947
 
946
948
  **Examples:**
947
949
  ```bash
948
- flow-weaver context core | pbcopy
949
- flow-weaver context full -o .flow-weaver-context.md
950
- flow-weaver context authoring --profile assistant
951
- flow-weaver context --topics concepts,jsdoc-grammar,error-codes
952
- flow-weaver context core --add error-codes
953
- flow-weaver context --list
950
+ fw context core | pbcopy
951
+ fw context full -o .flow-weaver-context.md
952
+ fw context authoring --profile assistant
953
+ fw context --topics concepts,jsdoc-grammar,error-codes
954
+ fw context core --add error-codes
955
+ fw context --list
954
956
  ```
955
957
 
956
958
  ---
@@ -962,7 +964,7 @@ flow-weaver context --list
962
964
  Select and center a node in the editor.
963
965
 
964
966
  ```bash
965
- flow-weaver ui focus-node <nodeId> [options]
967
+ fw ui focus-node <nodeId> [options]
966
968
  ```
967
969
 
968
970
  ### ui add-node
@@ -970,7 +972,7 @@ flow-weaver ui focus-node <nodeId> [options]
970
972
  Add a node type at viewport center.
971
973
 
972
974
  ```bash
973
- flow-weaver ui add-node <nodeTypeName> [options]
975
+ fw ui add-node <nodeTypeName> [options]
974
976
  ```
975
977
 
976
978
  ### ui open-workflow
@@ -978,7 +980,7 @@ flow-weaver ui add-node <nodeTypeName> [options]
978
980
  Open a workflow file in the editor.
979
981
 
980
982
  ```bash
981
- flow-weaver ui open-workflow <filePath> [options]
983
+ fw ui open-workflow <filePath> [options]
982
984
  ```
983
985
 
984
986
  ### ui get-state
@@ -986,7 +988,7 @@ flow-weaver ui open-workflow <filePath> [options]
986
988
  Return current workflow state from the editor.
987
989
 
988
990
  ```bash
989
- flow-weaver ui get-state [options]
991
+ fw ui get-state [options]
990
992
  ```
991
993
 
992
994
  ### ui batch
@@ -994,7 +996,7 @@ flow-weaver ui get-state [options]
994
996
  Execute a batch of commands with auto-snapshot rollback.
995
997
 
996
998
  ```bash
997
- flow-weaver ui batch <json> [options]
999
+ fw ui batch <json> [options]
998
1000
  ```
999
1001
 
1000
1002
  All UI commands accept:
@@ -1012,7 +1014,7 @@ All UI commands accept:
1012
1014
  Start MCP server for Claude Code integration.
1013
1015
 
1014
1016
  ```bash
1015
- flow-weaver mcp-server [options]
1017
+ fw mcp-server [options]
1016
1018
  ```
1017
1019
 
1018
1020
  | Flag | Description | Default |
@@ -1027,7 +1029,7 @@ flow-weaver mcp-server [options]
1027
1029
  Generate changelog from git history, categorized by file path.
1028
1030
 
1029
1031
  ```bash
1030
- flow-weaver changelog [options]
1032
+ fw changelog [options]
1031
1033
  ```
1032
1034
 
1033
1035
  | Flag | Description | Default |
@@ -1038,9 +1040,9 @@ flow-weaver changelog [options]
1038
1040
 
1039
1041
  **Examples:**
1040
1042
  ```bash
1041
- flow-weaver changelog --last-tag
1042
- flow-weaver changelog --range v0.1.0..HEAD
1043
- flow-weaver changelog --since 2024-01-01
1043
+ fw changelog --last-tag
1044
+ fw changelog --range v0.1.0..HEAD
1045
+ fw changelog --since 2024-01-01
1044
1046
  ```
1045
1047
 
1046
1048
  ---