Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions apps/docs/content/docs/cli/billing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ import { CommandTable } from '@/components/ui/command-table'

Every command below also accepts the [global options](/cli/commands#global-options).

## Show billing status and current-period credit usage
## Show billing status, credits spent this period, and storage used

```bash
sim billing status [options]
```

Show billing status and current-period credit usage (credits and storage require an OAuth login or personal API key)
Show billing status, credits spent this period, and storage used (credits and storage require an OAuth login or personal API key)

**Options**

Expand Down
24 changes: 24 additions & 0 deletions apps/docs/content/docs/cli/cli.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: CLI
description: Discover commands in this CLI — every subcommand, argument, and flag
---

import { CommandTable } from '@/components/ui/command-table'

Every command below also accepts the [global options](/cli/commands#global-options).

## Find the command for a task, described in plain words

```bash
sim cli search <query...>
```

**Arguments**

<CommandTable>

| Argument | Required | Description |
| --- | --- | --- |
| `query...` | Yes | What you want to do, e.g. "cancel a workflow run" |

</CommandTable>
5 changes: 3 additions & 2 deletions apps/docs/content/docs/cli/commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ These apply to every command, and may be written before or after it.
| --- | --- |
| [`sim profiles`](/cli/profiles) | List profiles or add a workspace profile that shares a stored login |
| [`sim telemetry`](/cli/telemetry) | Control anonymous usage reporting |
| [`sim cli`](/cli/cli) | Discover commands in this CLI |
| [`sim audit-logs`](/cli/audit-logs) | Manage audit logs |
| [`sim billing`](/cli/billing) | Manage billing |
| [`sim blocks`](/cli/blocks) | Manage blocks |
Expand All @@ -56,7 +57,7 @@ These apply to every command, and may be written before or after it.
| [`sim workflows`](/cli/workflows) | Manage workflows |
| [`sim workspaces`](/cli/workspaces) | Manage workspaces |

## Sign in through the browser and store the login for the profile
## Log in through the browser and store the login for the profile

```bash
sim login [options]
Expand Down Expand Up @@ -108,7 +109,7 @@ sim whoami [options]

</CommandTable>

## Set a profile's endpoint, default workspace, or output format
## Switch a profile's default workspace, or set its endpoint or output format

```bash
sim configure [options]
Expand Down
4 changes: 2 additions & 2 deletions apps/docs/content/docs/cli/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ sim profile add acme --workspace 7e2d9c14-6b83-4a55-8f01-c4d3e9a76b28
```bash
sim configure --set-endpoint http://localhost:3000 --profile dev
sim configure --set-workspace 5c81f3a6-0e27-4b94-8d15-a7f60c39b2e8 --profile dev
sim configure --set-output json
sim configure --set-output table
```

| Option | What it sets |
Expand All @@ -64,7 +64,7 @@ Each setting resolves independently, and the first match wins:
| 1 | Command-line flag — `--endpoint`, `--workspace`, `--output` |
| 2 | Environment — `SIM_ENDPOINT`, `SIM_API_KEY`, `SIM_WORKSPACE`, `SIM_OUTPUT` |
| 3 | `~/.sim/config` for the selected profile and `~/.sim/credentials` for its `auth_profile`, when set |
| 4 | Built-in default — `https://www.sim.ai` and `table` |
| 4 | Built-in default — `https://www.sim.ai` and `json` |

`sim whoami` prints the winning source for each setting:

Expand Down
2 changes: 1 addition & 1 deletion apps/docs/content/docs/cli/files.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -646,7 +646,7 @@ sim files upload <path> [options]

</CommandTable>

## Get a file’s content
## Download a file’s content to stdout or a local file

```bash
sim files get <fileId> [options]
Expand Down
7 changes: 4 additions & 3 deletions apps/docs/content/docs/cli/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,10 @@ import { Step, Steps } from 'fumadocs-ui/components/steps'
import { Tab, Tabs } from 'fumadocs-ui/components/tabs'

`sim` is the command line for Sim. Sign in once, then run workflows, query tables,
move files, search knowledge bases, and read run logs from the terminal. Use
`--output json` for structured results that pipe into `jq`, cron jobs, and CI
pipelines. See [Output formats](/cli/output) for commands that emit raw content
move files, search knowledge bases, and read run logs from the terminal. Results
are JSON by default, so they pipe into `jq`, cron jobs, CI pipelines, and coding
agents; use `--output table` to read them as tables. Don't know a command? Run
`sim cli search "<what you want to do>"`. See [Output formats](/cli/output) for commands that emit raw content
or local configuration.

## Install
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/content/docs/cli/knowledge.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -455,7 +455,7 @@ Enable or disable every matching document (OAuth login or personal API key requi

</CommandTable>

## Delete document
## Delete a document from a knowledge base

```bash
sim knowledge documents delete <knowledgeBaseId> <documentId> [options]
Expand Down
4 changes: 2 additions & 2 deletions apps/docs/content/docs/cli/logs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ sim logs stats [options]

</CommandTable>

## List logs
## List run logs, such as failed or errored runs, by workflow, trigger or time

```bash
sim logs list [options]
Expand Down Expand Up @@ -100,7 +100,7 @@ sim logs list [options]

</CommandTable>

## Watch runs as they arrive, printing each new run once
## Watch runs live as they arrive, printing each new run once

```bash
sim logs follow [options]
Expand Down
1 change: 1 addition & 0 deletions apps/docs/content/docs/cli/meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
"commands",
"profiles",
"telemetry",
"cli",
"audit-logs",
"billing",
"blocks",
Expand Down
8 changes: 4 additions & 4 deletions apps/docs/content/docs/cli/output.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@ Commands that return structured API data support four output formats.

| Format | For |
| --- | --- |
| `table` | reading (default) |
| `json` | piping into `jq` |
| `json` | agents, scripts, and piping into `jq` (default) |
| `table` | reading |
| `yaml` | piping into anything that reads YAML |
| `text` | shell loops — tab-separated, no header, no colour |

Select one per command, save it to the profile, or set it in the environment:

```bash
sim tables get tbl_9f3c1a05d4b7426e8c2f0917ab35de64 --output json
sim configure --set-output json
sim tables get tbl_9f3c1a05d4b7426e8c2f0917ab35de64 --output table
sim configure --set-output table
SIM_OUTPUT=yaml sim logs list > logs.yaml
```

Expand Down
40 changes: 30 additions & 10 deletions apps/docs/content/docs/cli/reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ These apply to every command, and may be written before or after it.

## sim login

Sign in through the browser and store the login for the profile
Log in through the browser and store the login for the profile

```bash
sim login [options]
Expand Down Expand Up @@ -84,7 +84,7 @@ sim whoami [options]

## sim configure

Set a profile's endpoint, default workspace, or output format
Switch a profile's default workspace, or set its endpoint or output format

```bash
sim configure [options]
Expand Down Expand Up @@ -215,6 +215,26 @@ Turn usage reporting off for this machine
sim telemetry disable
```

## sim cli

### sim cli search

Find the command for a task, described in plain words

```bash
sim cli search <query...>
```

**Arguments**

<CommandTable>

| Argument | Required | Description |
| --- | --- | --- |
| `query...` | Yes | What you want to do, e.g. "cancel a workflow run" |

</CommandTable>

## sim audit-logs

Also spelled `sim audit-log`.
Expand Down Expand Up @@ -280,7 +300,7 @@ sim audit-logs list [options]

### sim billing status

Show billing status and current-period credit usage (credits and storage require an OAuth login or personal API key)
Show billing status, credits spent this period, and storage used (credits and storage require an OAuth login or personal API key)

```bash
sim billing status [options]
Expand Down Expand Up @@ -1424,7 +1444,7 @@ sim files upload <path> [options]

### sim files get

Get a file’s content
Download a file’s content to stdout or a local file

```bash
sim files get <fileId> [options]
Expand Down Expand Up @@ -1952,7 +1972,7 @@ sim knowledge documents batch-update <knowledgeBaseId> [options]

### sim knowledge documents delete

Delete Document
Delete a document from a knowledge base

```bash
sim knowledge documents delete <knowledgeBaseId> <documentId> [options]
Expand Down Expand Up @@ -2764,7 +2784,7 @@ sim logs stats [options]

### sim logs list

List Logs
List run logs, such as failed or errored runs, by workflow, trigger or time

```bash
sim logs list [options]
Expand Down Expand Up @@ -2806,7 +2826,7 @@ sim logs list [options]

### sim logs follow

Watch runs as they arrive, printing each new run once
Watch runs live as they arrive, printing each new run once

```bash
sim logs follow [options]
Expand Down Expand Up @@ -4074,7 +4094,7 @@ sim secrets list [options]

### sim secrets set

Create or replace a named secret (OAuth login or personal API key required)
Create or replace a named secret, such as an API key or environment variable (OAuth login or personal API key required)

```bash
sim secrets set <name> [options]
Expand Down Expand Up @@ -4763,7 +4783,7 @@ sim tables rows list <tableId> [options]

### sim tables rows query

Query Rows
Query rows with a filter and sort

```bash
sim tables rows query <tableId> [options]
Expand Down Expand Up @@ -6048,7 +6068,7 @@ sim workflows activate create <workflowId> <version> [options]

### sim workflows operations apply

Apply Workflow Operations (OAuth login or personal API key required)
Edit a workflow’s blocks, connections and settings with a batch of operations (OAuth login or personal API key required)

```bash
sim workflows operations apply <workflowId> [options]
Expand Down
4 changes: 2 additions & 2 deletions apps/docs/content/docs/cli/secrets.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -60,13 +60,13 @@ List Secrets (OAuth login or personal API key required)

</CommandTable>

## Create or replace a named secret
## Create or replace a named secret, such as an API key or environment variable

```bash
sim secrets set <name> [options]
```

Create or replace a named secret (OAuth login or personal API key required)
Create or replace a named secret, such as an API key or environment variable (OAuth login or personal API key required)

**Arguments**

Expand Down
2 changes: 1 addition & 1 deletion apps/docs/content/docs/cli/tables.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -382,7 +382,7 @@ sim tables rows list <tableId> [options]

</CommandTable>

## Query rows
## Query rows with a filter and sort

```bash
sim tables rows query <tableId> [options]
Expand Down
4 changes: 2 additions & 2 deletions apps/docs/content/docs/cli/workflows.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,13 @@ Activate Workflow Version (OAuth login or personal API key required)

</CommandTable>

## Apply workflow operations
## Edit a workflow’s blocks, connections and settings with a batch of operations

```bash
sim workflows operations apply <workflowId> [options]
```

Apply Workflow Operations (OAuth login or personal API key required)
Edit a workflow’s blocks, connections and settings with a batch of operations (OAuth login or personal API key required)

**Arguments**

Expand Down
1 change: 1 addition & 0 deletions apps/sim/lib/mothership/generated/docs-manifest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ export const DOCS_MANIFEST: readonly string[] = [
'cli/billing.mdx',
'cli/blocks.mdx',
'cli/chat-deployments.mdx',
'cli/cli.mdx',
'cli/commands.mdx',
'cli/configuration.mdx',
'cli/connector-types.mdx',
Expand Down
5 changes: 4 additions & 1 deletion bun.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading