sim 1.0.18 → 2.0.0-dev.19.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.
package/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright 2026 Sim Studio, Inc.
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
package/README.md CHANGED
@@ -1,92 +1,344 @@
1
- # Sim
1
+ # Sim CLI
2
2
 
3
- Simple Node.js HTTP-server
3
+ Talk to the [Sim](https://sim.ai) API from your terminal.
4
4
 
5
- ## Styles
5
+ ```bash
6
+ npm install -g sim
7
+ sim login
8
+ sim workflows list
9
+ ```
10
+
11
+ Full documentation: **https://docs.sim.ai/cli**
12
+
13
+ ## Profiles
14
+
15
+ Profiles work like the AWS CLI: one identity and one set of defaults per named
16
+ profile, selected with `-P`, `--profile`, or `SIM_PROFILE`. This is what lets you keep
17
+ production and a local dev stack side by side without re-authenticating.
18
+
19
+ Non-secret settings live in `~/.sim/config`:
20
+
21
+ ```ini
22
+ [default]
23
+ endpoint = https://www.sim.ai
24
+ workspace = ws_abc123
25
+ output = table
26
+
27
+ [profile dev]
28
+ endpoint = http://localhost:3000
29
+ workspace = ws_local
30
+ ```
31
+
32
+ Keys live in `~/.sim/credentials`, written `0600`:
33
+
34
+ ```ini
35
+ [default]
36
+ api_key = sim_…
37
+
38
+ [dev]
39
+ api_key = sim_…
40
+ ```
41
+
42
+ The section-naming asymmetry — `[profile dev]` in config, `[dev]` in credentials
43
+ — is the AWS convention, kept so existing habits and tooling carry over.
44
+
45
+ ```bash
46
+ sim configure --set-endpoint http://localhost:3000 --profile dev
47
+ sim configure --set-workspace ws_local --profile dev
48
+ sim profiles # list them; * marks the active one
49
+ sim whoami # resolved values, where each came from, and whether they work
50
+ ```
51
+
52
+ ## Where settings come from
53
+
54
+ Each setting resolves independently, first match wins:
55
+
56
+ | Rank | Source |
57
+ | --- | --- |
58
+ | 1 | Command-line flag (`--endpoint`, `--workspace`, `--output`) |
59
+ | 2 | Environment (`SIM_ENDPOINT`, `SIM_API_KEY`, `SIM_WORKSPACE`, `SIM_OUTPUT`) |
60
+ | 3 | `~/.sim/config` / `~/.sim/credentials` for the selected profile |
61
+ | 4 | Built-in default (`https://www.sim.ai`, `table`) |
62
+
63
+ Formats are listed under [Output formats](#output-formats).
64
+
65
+ `sim whoami` prints the winning source per setting, which is usually the fastest
66
+ way to explain a surprising result. It then reads the configured workspace to
67
+ prove the settings actually work; `--no-verify` skips that and stays offline.
68
+
69
+ Its exit status is the answer, so CI can branch on it:
70
+
71
+ | Code | Meaning |
72
+ | --- | --- |
73
+ | `0` | The key works and reached the configured workspace |
74
+ | `1` | The credentials are wrong — no key stored, or the API refused it |
75
+ | `2` | The check could not be made — nothing to check against, or the endpoint did not answer |
76
+
77
+ For CI, skip `sim login` entirely and set `SIM_API_KEY` and `SIM_WORKSPACE` —
78
+ nothing needs to touch the filesystem. `SIM_CONFIG_DIR` relocates both files if
79
+ you need to keep them somewhere other than `~/.sim`.
80
+
81
+ ## Logging in
82
+
83
+ `sim login` uses the same browser handoff shape as `gh auth login`: the terminal
84
+ prints a pairing code and a URL, you approve in a browser, and the key comes back
85
+ over the CLI's own connection. Nothing redeemable crosses the browser leg, and
86
+ there is no loopback listener — so it works over SSH and inside containers.
87
+
88
+ ```
89
+ $ sim login --profile dev --endpoint http://localhost:3000
90
+
91
+ Pairing code: K7M2-P9XT
92
+ Confirm this code matches what the browser shows before approving.
93
+
94
+ http://localhost:3000/cli/auth?request=…&scope=platform
95
+ Waiting for approval…
96
+
97
+ ✓ Logged in. Key stored in /Users/you/.sim/credentials
98
+ Personal key, defaulting to ws_local. Override per command with --workspace.
99
+ ```
100
+
101
+ The approval page is where you pick the workspace — the terminal has no key yet,
102
+ so it cannot list them for you. `sim login` issues a personal key, and whichever
103
+ workspace you pick becomes only the profile's default `workspace`; it does not
104
+ limit the key to that workspace. Use `--workspace` to target another workspace
105
+ the key can access.
106
+
107
+ `sim login --workspace <id>` preselects a workspace in the picker, and an
108
+ existing profile's workspace preselects itself on re-login.
109
+
110
+ `sim logout` removes the stored key. It does not revoke it — do that in
111
+ Settings → API keys.
112
+
113
+ ## Commands
114
+
115
+ The commands below are the common ones. The complete reference — every group,
116
+ subcommand, argument, and flag, generated from this package — is at
117
+ [docs.sim.ai/cli/commands](https://docs.sim.ai/cli/commands).
118
+
119
+ Plural resource names are canonical, but every plural top-level resource group
120
+ also accepts its singular form: for example, `sim table list`,
121
+ `sim file get`, and `sim workflow get` are equivalent to their plural
122
+ spellings.
6
123
 
7
- ### Block
124
+ `knowledge` also accepts the shorter `kb` alias.
8
125
 
9
- ```styl
126
+ ```bash
127
+ sim workflows ls [path] [--search <text>] [--limit <n>]
128
+ sim workflows list [--folder <path>] [--deployed-only] [--limit <n>]
129
+ sim workflows get <id>
130
+ sim workflows update <id> [--name <name>] [--description <text>] [--folder <path>]
131
+ sim workflows mv <id> <folder>
132
+ sim workflows deploy|undeploy|rollback <id>
133
+ sim workflows run <id> [--input <json|@file>] [--select-output <path>…] [--async]
134
+ sim workflows runs list --workflow <workflowId> [--status <status>]
135
+ sim workflows runs get <runId> --workflow <workflowId> [--include-output]
136
+ sim workflows runs cancel <runId> --workflow <workflowId>
137
+ sim workflows runs resume <runId> --workflow <workflowId> --context <contextId> [--input <json|@file>]
10
138
 
11
- clear-box: all;
12
- clear-box: bounds;
13
- clear-box: position;
139
+ sim logs list [--level error] [--workflow <id>…] [--trigger <name>…] [--start-date <date>]
140
+ sim logs get <runId>
14
141
 
142
+ sim audit-logs list --organization <organizationId> [--all-workspaces]
143
+ sim audit-logs get <id> --organization <organizationId>
144
+
145
+ sim workspaces get
146
+ sim workspaces members
147
+
148
+ sim tables ls [path] [--search <text>] [--limit <n>]
149
+ sim tables list [--folder <path>]
150
+ sim tables get <tableId>
151
+ sim tables update <tableId> [--name <name>] [--description <text>] [--folder <path>]
152
+ sim tables mv <tableId> <folder>
153
+ sim tables columns create|update|delete|run <tableId>
154
+ sim tables rows list <tableId> [--limit <n>]
155
+ sim tables rows create <tableId> --data <json|@file>
156
+ sim tables rows create <tableId> --rows <json|@file>
157
+ sim tables rows query <tableId> [--filter <json>] [--sort <json>] [--limit <n>]
158
+ sim tables rows query <tableId> --filter '{"all":[{"field":"status","op":"eq","value":"active"}]}'
159
+ sim tables upsert <tableId> --data <json>
160
+ sim tables rows batch-delete <tableId> (--row <id>… | --filter <json>) --yes
161
+
162
+ sim files ls [path] [--search <text>] [--limit <n>]
163
+ sim files list [--folder <path>]
164
+ sim files describe <fileId>
165
+ sim files get <fileId> [-o <path>] # stdout by default
166
+ sim files create --name <name> [--folder <path>] [--content <value>] [--encoding utf-8|base64]
167
+ sim files upload <path> [--name <name>] [--folder <path>]
168
+ sim files share get <fileId>
169
+ sim files share set <fileId> --is-active <true|false> [--auth-type public|password|email|sso]
170
+ sim files mv --file-ids <id>… [--to <path>]
171
+ sim files batch-delete --file-ids <id>… --yes
172
+ sim files delete <fileId> --yes
173
+
174
+ sim knowledge ls [path] [--search <text>] [--limit <n>]
175
+ sim knowledge list [--folder <path>]
176
+ sim knowledge get <id>
177
+ sim knowledge update <id> [--name <name>] [--description <text>] [--folder <path>]
178
+ sim knowledge mv <id> <folder>
179
+ sim knowledge search --query <text> --kb <id>… [--search-mode vector|hybrid]
180
+
181
+ sim knowledge documents list <knowledgeBaseId> [--search <text>]
182
+ sim knowledge documents get <knowledgeBaseId> <documentId>
183
+ sim knowledge documents upload <knowledgeBaseId> <path> [--tag <value>...]
184
+ sim knowledge documents update <knowledgeBaseId> <documentId> [--filename <name>] [--enabled]
185
+ sim knowledge documents batch-update <knowledgeBaseId> --operation enable|disable
186
+ sim knowledge documents delete <knowledgeBaseId> <documentId> --yes
187
+
188
+ sim billing status [--all-workspaces]
189
+ sim billing logs [--period 7d] [--source sim-chat] [--limit <n>] [--all-workspaces]
15
190
  ```
16
191
 
17
- ### Util
192
+ The `sim-chat` billing source combines Copilot and workspace chat usage.
193
+ Organization audit logs require a personal API key. Commands with
194
+ `--all-workspaces` otherwise default to the workspace in the active profile.
195
+
196
+ `workflows runs get` is the lightweight status and polling resource.
197
+ `--workflow` names the parent resource, while the run ID remains positional.
198
+ For a paused run, its status includes the context ID needed by `resume`.
199
+ `logs get` is the full diagnostic resource. It keeps the default human output
200
+ concise; add `--trace` for the expanded recursive trace with span inputs,
201
+ outputs, errors, timing, and cost. JSON and YAML retain the complete structured
202
+ response.
18
203
 
19
- ```styl
204
+ `sim logs get` keeps the default human output concise. Use JSON or YAML to
205
+ inspect its complete `executionData` and recursive `traceSpans` tree:
20
206
 
21
- selection: none;
22
- selection: text;
23
- selection: auto;
207
+ ```bash
208
+ sim logs get <runId> --trace
209
+ sim logs get <runId> --output json | jq '.traceSpans'
210
+ sim logs list --include-trace-spans --output json
211
+ ```
24
212
 
25
- antialias: true;
26
- antialias: none;
213
+ Workflow output selectors use `blockName.field` syntax, such as
214
+ `--select-output agent_1.content`; fields that are not produced are omitted.
27
215
 
28
- bluring: 5px;
216
+ `ls` is a directory view: it combines the resources at its optional path with
217
+ that folder's direct child folders. It never includes deeper descendants. Its
218
+ `ref` column is the resource ID or canonical folder path to pass to the next
219
+ command. Use `list` when you want resources only, or `folders ls` when you want
220
+ folders only.
29
221
 
30
- selection-background: #333;
31
- selection-color: #ccc;
222
+ Each folder-backed resource has the same path commands:
223
+
224
+ ```bash
225
+ sim tables ls Reports
226
+ sim tables folders ls --parent Reports
227
+ sim tables mkdir Reports/Quarterly
228
+ sim tables folders create Reports/Quarterly
229
+ sim tables folders mv Reports/Quarterly Archive/Quarterly
230
+ sim tables folders delete Archive/Quarterly --yes
231
+ sim tables folders delete Archive --recursive --yes
232
+ ```
32
233
 
33
- clr: #999;
234
+ `mkdir` is the concise form of `folders create`. Replace `tables` with `files`,
235
+ `workflows`, or `knowledge`. The leading `/` is optional on API inputs; the API
236
+ returns the canonical leading-slash form. Omit the `ls` path to list root.
34
237
 
35
- +placeholder()
36
- color: #ccc;
37
- font-size: 16px;
238
+ ### List inputs
38
239
 
240
+ Primitive lists take space-separated values. Prefix a path with `@` to read
241
+ one value per line, or use `@-` to read the list from stdin.
242
+
243
+ ```bash
244
+ sim files mv --file-ids file_1 file_2 --to Archive
245
+ sim files mv --file-ids @file-ids.txt --to Archive
246
+ printf 'file_1\nfile_2\n' | sim files mv --file-ids @- --to Archive
39
247
  ```
40
248
 
41
- ### Layout
42
-
43
- ```styl
44
- lay: grid;
45
- lay: line;
46
-
47
- pin: center;
48
- pin: left;
49
- pin: right;
50
- pin: full;
51
- pin: mid;
52
-
53
- grav: top;
54
- grav: center;
55
- grav: bottom;
56
- grav: full;
57
- grav: text;
58
-
59
- side: pull;
60
- side: center;
61
- side: left;
62
- side: right;
63
- side: wide;
64
- side: mid;
65
-
66
- lane: single;
67
- lane: grid;
68
- lane: grid-reverse;
69
-
70
- way: right;
71
- way: left;
72
- way: down;
73
- way: up;
74
-
75
- order: 1;
76
- order: 4;
77
-
78
- rate: 1;
79
- rate: 3;
80
-
81
- reduce: 1;
82
- reduce: 2;
83
-
84
- size: 20%;
85
- size: auto;
86
-
87
- press: top;
88
- press: bottom;
89
- press: middle;
90
- press: pull;
91
- press: text;
249
+ Arrays of objects remain JSON inputs because they cannot be represented as a
250
+ flat list without losing structure.
251
+
252
+ ### Filtering table rows
253
+
254
+ `--filter` takes the same predicate tree the API uses — `all` (AND) or `any`
255
+ (OR) groups of `{field, op, value}` conditions, nestable. It's JSON because the
256
+ grammar is a tree; there's no honest flag encoding for it.
257
+
258
+ ```bash
259
+ sim tables rows query tbl_123 \
260
+ --filter '{"all":[{"field":"status","op":"eq","value":"open"},
261
+ {"field":"score","op":"gt","value":10}]}' \
262
+ --sort '[{"field":"score","direction":"desc"}]' --limit 50
92
263
  ```
264
+
265
+ `--sort` is JSON for the same reason: it is an ordered list of keys, each with a
266
+ `field` and a `direction` of `asc` or `desc`.
267
+
268
+ Row columns are discovered at runtime from the returned data, unioned across the
269
+ page so a sparse row doesn't hide a column.
270
+
271
+ Deletions require an explicit selector *and* `--yes`; there is no "delete
272
+ everything" default.
273
+
274
+ ### Output formats
275
+
276
+ Output format can be selected per command with `--output`, saved as a profile
277
+ default with `sim configure --set-output <format>`, or set ambiently with
278
+ `SIM_OUTPUT` for CI:
279
+
280
+ | Format | For |
281
+ | --- | --- |
282
+ | `table` | reading (default) |
283
+ | `json` | piping into `jq` |
284
+ | `yaml` | piping into anything that reads YAML |
285
+ | `text` | shell loops — tab-separated, no header, no colour |
286
+
287
+ `json` and `yaml` emit the API's **raw** values, not the table's formatting — a
288
+ duration stays `1500`, not `"1.5s"` — so switching format never changes the data.
289
+ `text` uses the rendered cells, since it is meant for shell plumbing rather than
290
+ parsing.
291
+
292
+ ```bash
293
+ sim configure --set-output json # for this profile, from now on
294
+ sim configure --set-output text --profile scripts # a profile dedicated to scripting
295
+
296
+ sim --output json logs list --level error | jq -r '.[].runId'
297
+ sim logs list --level error --output json | jq -r '.[].runId'
298
+ SIM_OUTPUT=yaml sim logs list --level error > logs.yaml
299
+
300
+ SIM_OUTPUT=text sim files list | while IFS=$'\t' read -r id name size type uploaded; do
301
+ echo "$id $name"
302
+ done
303
+ ```
304
+
305
+ An absent value is an em-dash in `table` and an **empty field** in `text`, so
306
+ emptiness tests downstream behave.
307
+
308
+ An invalid active `SIM_OUTPUT` or `output =` value fails with the accepted
309
+ formats. A valid higher-priority `--output` still overrides a stale lower tier,
310
+ so `sim --output table configure --set-output json` can repair a profile.
311
+
312
+ ## How this stays in sync with the API
313
+
314
+ `src/generated/v2-api.ts` is generated from the Zod route contracts in
315
+ `apps/sim/lib/api/contracts/v2/**` — the same contracts the routes validate
316
+ against, so a shape that disagrees with them is a shape the server would reject.
317
+ It holds every response/request type plus the operation table (method, path,
318
+ path params) the client dispatches through.
319
+
320
+ ```bash
321
+ bun run generate:cli-api # regenerate after changing a contract
322
+ bun run check:cli-api # CI: fails if the generated file is stale
323
+ bun run check:openapi # CI: fails if the docs and contracts disagree
324
+ ```
325
+
326
+ The generated file contains only type declarations and one const — no imports —
327
+ so the `packages/*` must not import `apps/*` boundary is preserved; the script
328
+ does the crossing at build time.
329
+
330
+ The OpenAPI documents under `apps/docs` are deliberately **not** generated. They
331
+ carry hand-written descriptions, examples, and error responses that Zod schemas
332
+ don't encode, so regenerating them would trade real documentation for mechanical
333
+ accuracy. `check:openapi` reconciles them against the same contracts instead —
334
+ field by field, and it parses every documented example with the real Zod schema —
335
+ so the prose survives while drift still fails the build.
336
+
337
+ ## Notes
338
+
339
+ - Commands talk to the `/api/v2` surface, which returns `{ data }` and
340
+ `{ data, nextCursor }`. List commands auto-page up to `--limit`.
341
+
342
+ ## License
343
+
344
+ Apache-2.0
@@ -0,0 +1,30 @@
1
+ The Sim CLI bundle includes the following third-party software.
2
+
3
+ chalk
4
+ Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
5
+
6
+ commander
7
+ Copyright (c) 2011 TJ Holowaychuk <tj@vision-media.ca>
8
+
9
+ js-yaml
10
+ Copyright (C) 2011-2015 by Vitaly Puzrin
11
+
12
+ Each dependency above is licensed under the MIT License:
13
+
14
+ Permission is hereby granted, free of charge, to any person obtaining a copy
15
+ of this software and associated documentation files (the "Software"), to deal
16
+ in the Software without restriction, including without limitation the rights
17
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
18
+ copies of the Software, and to permit persons to whom the Software is
19
+ furnished to do so, subject to the following conditions:
20
+
21
+ The above copyright notice and this permission notice shall be included in
22
+ all copies or substantial portions of the Software.
23
+
24
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
25
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
27
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
29
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
30
+ SOFTWARE.