@w6w/cli 0.1.0 → 0.1.1

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 +27 -1
  2. package/dist/mod.js +1 -1
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -7,7 +7,7 @@ auth, output formatting and exit codes. No business logic, no client-side pollin
7
7
  retries. Everything it can do, the HTTP API can do — the CLI just makes it typeable.
8
8
 
9
9
  - **License:** MIT (see [LICENSE](./LICENSE)).
10
- - **Version:** `0.1.0`.
10
+ - **Version:** `0.1.1`.
11
11
 
12
12
  ## Install
13
13
 
@@ -40,6 +40,32 @@ w6w workflows list
40
40
  `--help` and `--version` deliberately need neither. They resolve with no token configured and no
41
41
  server reachable, which is exactly when people need them most.
42
42
 
43
+ ## Usage
44
+
45
+ ```bash
46
+ w6w me # who am I, and which component versions am I talking to?
47
+
48
+ # Discover what you can run — a `conn_…`, `wf_…`, `fn_…` or `ep_…` id.
49
+ w6w connections list
50
+ w6w workflows list
51
+
52
+ # Run a connection action: a `conn_…` id needs --action.
53
+ w6w run conn_01H… --action send_email --payload '{"to":"a@b.com"}'
54
+
55
+ # A function or an endpoint runs the same way, with no --action.
56
+ w6w run fn_normalize_address --payload '{"address":"1 Infinite Loop"}'
57
+
58
+ # `w6w run wf_…` dispatches a workflow like anything else and always queues it.
59
+ # `w6w workflows run` is the typed path, and the only one that can wait:
60
+ w6w workflows run wf_01H… --wait
61
+
62
+ # Documents and vars are plain CRUD; the key/name is positional, the rest are flags.
63
+ w6w documents create welcome --content "# Hi"
64
+ w6w vars create greeting --type string --value hello
65
+ ```
66
+
67
+ Add `--json` to any command for raw JSON instead of a table — the shape to script against.
68
+
43
69
  ## Help
44
70
 
45
71
  Help resolves at three levels, and `-h` is an alias for `--help` at all of them:
package/dist/mod.js CHANGED
@@ -51,7 +51,7 @@ export { COMMAND_PATHS, EXIT_CODES, GLOBAL_FLAGS, HELP_TREE } from "./src/help.g
51
51
  * The explicit `: string` annotation is required, not decorative: JSR publishes
52
52
  * this file as TypeScript source and rejects inferred public types.
53
53
  */
54
- export const VERSION = "0.1.0";
54
+ export const VERSION = "0.1.1";
55
55
  /** `w6w help <command>` is accepted as an alias for `w6w <command> --help`. */
56
56
  const HELP_COMMAND = "help";
57
57
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@w6w/cli",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "The w6w command-line client. Thin transport over the w6w HTTP API, with help generated from the shared wrapper contract.",
5
5
  "license": "MIT",
6
6
  "repository": {