--target-path <path> | The folder to make the workspace in: your own workspaces folder, or the connection’s. Use it in place of --connection and --kind. |
--name <name> | Its technical name, the same as NAME. When you give both, they must be the same. |
--duplicate-from <path> | A workspace to copy, by its path from the content root, such as connections/<connection>/workspaces/<name>. It must be in the same connection. |
--label <text> | The name that people see for the workspace. |
--description <text> | What the workspace is for, in a sentence or two. |
--ai-context <text> | Notes for an AI agent that works in the workspace. |
--tags <scaffold-tag> | Model tags: key=value or bare key; repeatable, pass no values to clear. You can give it more than one time. |
--business-question <business-question> | A question the workspace answers, such as “Which campaigns bring the most conversions?”. Repeat it for each. You can give it more than one time. |
--workspace-metadata <workspace-metadata> | More keys for the top of workspace.sql, as a JSON object. A copy made with --duplicate-from refuses it. |
--metadata <metadata> | The label, description, ai_context and tags as one JSON object, such as {“label”: “Spend review”}. A value cannot differ from its own option. |
--dry-run | Show the files it would write and the revisions it checks, and write nothing. |
--from-model <from-model> | The shared semantic model or Kater dataset it reads, by name, typed address or identity, such as semantic.ad_reporting. Without it, the workspace reads nothing. |
--reuse-existing | Run the same create again, such as after a timeout. When the file already holds exactly this, the create succeeds and writes nothing. |
--duplicate-revision <revision> | With --duplicate-from: the duplicate_revision in the witnesses of kater new workspace --dry-run --json. The create stops when the copied workspace changed since. |
--source-revision <revision> | The source_revision in the witnesses of kater new workspace --dry-run --json, when it gives one. The create stops when the model it reads changed since. |
--composition-revision <revision> | With --duplicate-from of a workspace that has apps: the composition_revision in the witnesses of kater new workspace --dry-run --json. The create stops when its apps changed since. |
--connection <connection> | The connection to make the workspace in, such as snowflake_prod_connection. Give it when you give no --target-path. |
--kind <kind> | Without --target-path: personal, the default, puts it in your own workspaces folder. connection puts it in the connection’s workspaces folder. It is personal or connection. |
--start <start-type> | The type to start from: overview, operations, realtime, transactions. Left out: No template, an empty dashboard you add queries and charts to. |
--source <start-source> | Source data. Kater selects the source data that fits what you write. Or select the one you know. A dashboard, a query, a shared model or an app, by its path from the content root. Left out, Kater finds the best fit. |
--refresh-seconds <start-refresh-seconds> | Refresh. Takes 60 (Every minute), 300 (Every 5 minutes), 900 (Every 15 minutes). Left out: 60, unless the type sets its own. For realtime. |