Skip to main content
DocumentationLibraryReference
On this page

Kater CLI Make and compare new

kater new

Makes a new object in your Kater content: a workspace, a query, a chart, an app, a field, a test, a scratch file, a semantic model, a DB dataset or a Kater dataset.

Each kind has its own command, which takes only the options that work for that kind. kater new options lists where a new object can go, a free name, and what you can start it from. See Create commands.

Commands

CommandWhat it does
kater new dashboardMake a dashboard: a workspace with its dashboard, from a type with --start.
kater new workspaceMake a workspace over a shared model, with its dashboard. The same as kater new dashboard.
kater new queryMake a query in a workspace, blank or from SQL.
kater new chartMake a chart from a query in your workspace.
kater new appMake an app from Kater’s starter page, or from a type with --start.
kater new projectMake a project in your own projects folder, in one commit.
kater new workflowMake a workflow in your own folder, in one commit.
kater new fieldMake a field and preview it before it’s saved.
kater new testMake a test that checks one of a model’s answers.
kater new scratchMake a scratch file in your brainstorm folder.
kater new semantic-modelMake a semantic model built on shared datasets.
kater new db-datasetMake a DB dataset that describes one warehouse table.
kater new kater-datasetMake a Kater dataset over one DB dataset.
kater new optionsList where a new object can go, its default name and what you can copy.

Where it runs

The Kater MCP’s kater tool and the Files terminal run kater new workspace, query, chart, app, field, test and scratch. Run kater new semantic-model, db-dataset, kater-dataset and options in your own terminal.

Examples

Terminal window
# Go to a connection's folder in your local copy of Kater content
cd connections/snowflake_prod_connection
# See where a new semantic model can go, and the models it can start from
kater new options semantic_model --scope modeling
# See the file that a new semantic model would get, and write nothing
kater new semantic-model --target-path modeling/kater_objects/semantic_models/marketing --name google_ads_campaigns --base kater_dataset.google_ads__campaign_report --dry-run
# 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
# Add a blank query to the ad_reporting workspace
kater new query --target-path workspaces/ad_reporting --name clicks_by_platform
# Make a scratch file in the sandbox folder of your brainstorm folder
kater new scratch --connection snowflake_prod_connection --folder sandbox

See also