Skip to main content

# kater workspace

Sets the shared model a workspace reads, and writes a brainstorm copy's changes back to its workspace.

{/* Written by apps/landing-page/scripts/docs/write_cli_reference.py from the kater CLI's own help and scripts/docs/cli-reference.md. Do not edit it by hand: change those, then run the script. */}

[`kater new workspace`](https://kater.ai/docs/cli-reference/new/workspace/) makes a workspace. A [workspace](https://kater.ai/docs/model/workspaces/) holds the queries, charts, dashboard and apps of one analysis. It reads one [shared model](https://kater.ai/docs/model/semantic-models/).

## Commands

| Command | What it does |
| --- | --- |
| [`kater workspace apply`](https://kater.ai/docs/cli-reference/workspace/apply/) | Apply a brainstorm copy's changes to its workspace. |
| [`kater workspace source`](https://kater.ai/docs/cli-reference/workspace/source/) | Set the shared model a workspace reads. |

## Where workspaces live

- **Your own workspaces** are in your own folder, `connections/<connection>/users/<you>/workspaces/`.
- **A connection's workspaces** are in its `workspaces/` folder.
- **A copy in a brainstorm topic** is in `users/<you>/brainstorm/<topic>/workspaces/`. [`kater brainstorm copy`](https://kater.ai/docs/cli-reference/brainstorm/copy/) makes it, and [`kater workspace apply`](https://kater.ai/docs/cli-reference/workspace/apply/) writes its changes back. See [Workspace copies](https://kater.ai/docs/analyze/brainstorm/#workspace-copies).

## Examples

```bash
# Make the spend_review workspace in your own folder, over the shared ad_reporting model
kater new workspace spend_review --connection snowflake_prod_connection --from-model semantic.ad_reporting
# See what changes when the ad_reporting workspace reads the campaign report model, and save nothing
kater workspace source use semantic.ad_reporting__campaign_report --scope connections/snowflake_prod_connection/workspaces/ad_reporting --dry-run
# See what your brainstorm copy of ad_reporting changes, and save nothing
kater workspace apply connections/snowflake_prod_connection/users/you@example.com/brainstorm/promote_roas/workspaces/ad_reporting --dry-run
```

## See also

- [All commands](https://kater.ai/docs/cli-reference/kater/)

On this page

Commands
Where workspaces live
Examples
See also

Kater CLI Build an analysis workspace

kater workspace

Sets the shared model a workspace reads, and writes a brainstorm copy's changes back to its workspace.

kater new workspace makes a workspace. A workspace holds the queries, charts, dashboard and apps of one analysis. It reads one shared model.

Commands

Command	What it does
`kater workspace apply`	Apply a brainstorm copy’s changes to its workspace.
`kater workspace source`	Set the shared model a workspace reads.

Where workspaces live

Your own workspaces are in your own folder, connections/<connection>/users/<you>/workspaces/.
A connection’s workspaces are in its workspaces/ folder.
A copy in a brainstorm topic is in users/<you>/brainstorm/<topic>/workspaces/. kater brainstorm copy makes it, and kater workspace apply writes its changes back. See Workspace copies.

Examples

# Make the spend_review workspace in your own folder, over the shared ad_reporting model
kater new workspace spend_review --connection snowflake_prod_connection --from-model semantic.ad_reporting
# See what changes when the ad_reporting workspace reads the campaign report model, and save nothing
kater workspace source use semantic.ad_reporting__campaign_report --scope connections/snowflake_prod_connection/workspaces/ad_reporting --dry-run
# See what your brainstorm copy of ad_reporting changes, and save nothing
kater workspace apply connections/snowflake_prod_connection/users/you@example.com/brainstorm/promote_roas/workspaces/ad_reporting --dry-run

See also

All commands