@work-shape/catalyst-cli 0.8.0-rc.21 → 0.8.0-rc.23

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@work-shape/catalyst-cli",
3
- "version": "0.8.0-rc.21",
3
+ "version": "0.8.0-rc.23",
4
4
  "license": "MIT",
5
5
  "repository": {
6
6
  "type": "git",
@@ -40,9 +40,9 @@
40
40
  "@types/node": "^24.13.1",
41
41
  "tsup": "^8.5.1",
42
42
  "typescript": "^6.0.3",
43
- "@work-shape/catalyst-api-client": "0.8.0-rc.21",
44
- "@work-shape/catalyst-asset-schemas": "0.8.0-rc.21",
45
- "@work-shape/catalyst-api-contract": "0.8.0-rc.21"
43
+ "@work-shape/catalyst-api-client": "0.8.0-rc.23",
44
+ "@work-shape/catalyst-api-contract": "0.8.0-rc.23",
45
+ "@work-shape/catalyst-asset-schemas": "0.8.0-rc.23"
46
46
  },
47
47
  "scripts": {
48
48
  "build": "tsup",
@@ -102,6 +102,42 @@ These commands print readable YAML; add `--json` for JSON. Paginated lists read
102
102
 
103
103
  `app actions` without a name lists published Apps' actions; with a name it reads the draft if you may write it, otherwise the published revision. `keys list` reads only your own key metadata, never secrets. `instance workspaces` lists Shared Workspaces for agent availability through `instance.workspaces.list`, requiring `config_assets:write` and `agent.write`; it does not list your memberships. Keep `hasMore`, hidden counts and `truncated` in mind when reading hits, dependencies and actions.
104
104
 
105
+ ## Use a Workflow, Data Store or Knowledge Base
106
+
107
+ ```sh
108
+ catalyst workflow start month-end --from input.json # {"input":{"month":"2026-10"}}
109
+ catalyst data-store rows reporting --table bookings --limit 20
110
+ catalyst data-store query reporting --sql "select id from bookings where id = 1"
111
+ catalyst data-store insert reporting --from rows.json # {"table":"bookings","rows":[{"id":1}]}
112
+ catalyst knowledge-base query accounts --sql "select name from accounts"
113
+ ```
114
+
115
+ These need the key's use level. A refusal names the right the key lacks; treat it as final and tell the person, who ticks it in Settings > API keys. Start a Workflow, read rows or insert rows only when asked: `workflow start` runs the published Workflow for real, and `data-store insert` adds rows that stay. `--from <file|->` reads the JSON request body shown above; `knowledge-base query` also takes `{"query": "<named query>", "parameters": {...}}`. `data-store rows` prints one page: pass the `next` it printed as `--after` for the following one.
116
+
117
+ ## Read the instance
118
+
119
+ ```sh
120
+ catalyst usage show
121
+ catalyst audit events --limit 50
122
+ catalyst jobs list --status failed,dead
123
+ catalyst operation runs --since 2026-10-28T00:00:00Z
124
+ catalyst modules list
125
+ catalyst infrastructure show
126
+ ```
127
+
128
+ These read usage, audit events, background jobs, Operation Runs, Modules and infrastructure, and need the key's instance level. The key `catalyst setup` creates does not have it. A refusal names the right the key lacks (`usage.view`, `audit.view` or `system.view`); treat it as final and tell the person, who ticks it for a key of their choice in Settings > API keys. Read them only when asked. Audit events and Operation Runs hold no payload: report them as they are and do not try to recover content from them. `audit events`, `jobs list` and `operation runs` print one page; `--cursor` takes the `nextCursor` it printed.
129
+
130
+ ## Change the account and workspaces
131
+
132
+ ```sh
133
+ catalyst me
134
+ catalyst workspace list
135
+ catalyst workspace members <workspace-id>
136
+ catalyst workspace members add <workspace-id> --email <address>
137
+ ```
138
+
139
+ `me update`, `keys revoke` and the `workspace` commands change the person's own account and their workspaces, and need the key's account and workspaces level (`account.manage`, `collaboration_workspace.manage`). The key `catalyst setup` creates does not have it. Change them only when asked, and show the change first. Never delete a workspace, remove a member or revoke a key without the person's go-ahead for that one change. A refusal names the right the key lacks or says what the person's role in the workspace does not allow; treat it as final and tell the person.
140
+
105
141
  ## Follow a held call
106
142
 
107
143
  A change that exits 3 prints its Operation Run id. Follow it with `catalyst operation show <run-id>` and list your requests with `catalyst requests`. Add `--json` for the full record or list. A held run still exits 3; a failed, denied or expired run exits 1. Withdraw your own request with `catalyst requests --withdraw <id>` only when the person asks; the key needs an asset write or delete scope. Do not send the held change again.