sim 2.0.0-dev.6.1 → 2.0.0-preview.11.1

package/README.md

@@ -3,17 +3,12 @@
 Talk to the [Sim](https://sim.ai) API from your terminal.
 
 ```bash
-npm install --global sim
+npm install -g sim
 sim login
 sim workflows list
 ```
 
-Prerelease channels track the corresponding Sim environments:
-
-```bash
-npm install --global sim@staging # staging
-npm install --global sim@dev     # dev
-```
+Full documentation: **https://docs.sim.ai/cli**
 
 ## Profiles
 
@@ -51,7 +46,7 @@ The section-naming asymmetry — `[profile dev]` in config, `[dev]` in credentia
 sim configure --set-endpoint http://localhost:3000 --profile dev
 sim configure --set-workspace ws_local --profile dev
 sim profiles          # list them; * marks the active one
-sim whoami            # resolved values, and where each came from
+sim whoami            # resolved values, where each came from, and whether they work
 ```
 
 ## Where settings come from
@@ -68,7 +63,16 @@ Each setting resolves independently, first match wins:
 Formats are listed under [Output formats](#output-formats).
 
 `sim whoami` prints the winning source per setting, which is usually the fastest
-way to explain a surprising result.
+way to explain a surprising result. It then reads the configured workspace to
+prove the settings actually work; `--no-verify` skips that and stays offline.
+
+Its exit status is the answer, so CI can branch on it:
+
+| Code | Meaning |
+| --- | --- |
+| `0` | The key works and reached the configured workspace |
+| `1` | The credentials are wrong — no key stored, or the API refused it |
+| `2` | The check could not be made — nothing to check against, or the endpoint did not answer |
 
 For CI, skip `sim login` entirely and set `SIM_API_KEY` and `SIM_WORKSPACE` —
 nothing needs to touch the filesystem. `SIM_CONFIG_DIR` relocates both files if
@@ -108,6 +112,10 @@ Settings → API keys.
 
 ## Commands
 
+The commands below are the common ones. The complete reference — every group,
+subcommand, argument, and flag, generated from this package — is at
+[docs.sim.ai/cli/commands](https://docs.sim.ai/cli/commands).
+
 Plural resource names are canonical, but every plural top-level resource group
 also accepts its singular form: for example, `sim table list`,
 `sim file get`, and `sim workflow get` are equivalent to their plural
@@ -142,7 +150,7 @@ sim tables list [--folder <path>]
 sim tables get <tableId>
 sim tables update <tableId> [--name <name>] [--description <text>] [--folder <path>]
 sim tables mv <tableId> <folder>
-sim tables columns <tableId>
+sim tables columns create|update|delete|run <tableId>
 sim tables rows list <tableId> [--limit <n>]
 sim tables rows create <tableId> --data <json|@file>
 sim tables rows create <tableId> --rows <json|@file>
@@ -173,6 +181,8 @@ sim knowledge search --query <text> --kb <id>… [--search-mode vector|hybrid]
 sim knowledge documents list <knowledgeBaseId> [--search <text>]
 sim knowledge documents get <knowledgeBaseId> <documentId>
 sim knowledge documents upload <knowledgeBaseId> <path> [--tag <value>...]
+sim knowledge documents update <knowledgeBaseId> <documentId> [--filename <name>] [--enabled]
+sim knowledge documents batch-update <knowledgeBaseId> --operation enable|disable
 sim knowledge documents delete <knowledgeBaseId> <documentId> --yes
 
 sim billing status [--all-workspaces]
@@ -249,9 +259,12 @@ grammar is a tree; there's no honest flag encoding for it.
 sim tables rows query tbl_123 \
   --filter '{"all":[{"field":"status","op":"eq","value":"open"},
                     {"field":"score","op":"gt","value":10}]}' \
-  --sort score:desc --limit 50
+  --sort '[{"field":"score","direction":"desc"}]' --limit 50
 ```
 
+`--sort` is JSON for the same reason: it is an ordered list of keys, each with a
+`field` and a `direction` of `asc` or `desc`.
+
 Row columns are discovered at runtime from the returned data, unioned across the
 page so a sparse row doesn't hide a column.