Skip to main content

# kater source

Writes your Kater content files by hand: whole files, single properties, and the workspace that a query's SQL reads.

{/* 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. */}

Use these commands for changes that no other `kater` command makes.

## Commands

| Command | What it does |
| --- | --- |
| [`kater source write`](https://kater.ai/docs/cli-reference/source/write/) | Create or replace a whole file with your text. |
| [`kater source rebase`](https://kater.ai/docs/cli-reference/source/rebase/) | Point a query or chart's SQL at its own workspace. |
| [`kater source patch`](https://kater.ai/docs/cli-reference/source/patch/) | Change properties of a Kater file in place. |

## Examples

```bash
# Go to the ad_reporting workspace in your local copy of Kater content
cd connections/snowflake_prod_connection/workspaces/ad_reporting
# Set the label of the spend_by_platform query
kater source patch query_contracts/spend_by_platform.sql --edits '[{"at": "label", "value": "Spend by platform"}]'
# Make a query that reads the shared model read its workspace instead
kater source rebase query_contracts/clicks_by_platform.sql --move read_through
```

## See also

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

On this page

Commands
Examples
See also

Kater CLI Build an analysis source

kater source

Writes your Kater content files by hand: whole files, single properties, and the workspace that a query's SQL reads.

Use these commands for changes that no other kater command makes.

Commands

Command	What it does
`kater source write`	Create or replace a whole file with your text.
`kater source rebase`	Point a query or chart’s SQL at its own workspace.
`kater source patch`	Change properties of a Kater file in place.

Examples

# Go to the ad_reporting workspace in your local copy of Kater content
cd connections/snowflake_prod_connection/workspaces/ad_reporting
# Set the label of the spend_by_platform query
kater source patch query_contracts/spend_by_platform.sql --edits '[{"at": "label", "value": "Spend by platform"}]'
# Make a query that reads the shared model read its workspace instead
kater source rebase query_contracts/clicks_by_platform.sql --move read_through

See also

All commands