Skip to main content
DocumentationLibraryReference
On this page

Kater CLI Your terminal scope

kater scope

Saves the workspace, model folder or model that your commands work on.

You then do not give --scope each time. Find a place with kater scope list, then save it with kater scope use.

Commands

CommandWhat it does
kater scope listList the workspaces and model folders you can pick.
kater scope useSet the folder or model your commands work on.
kater scope showShow the scope your commands work on.

How a command finds its scope

A command works on the first of these that it has:

  1. Its --scope option. KATER_SCOPE works the same way.
  2. A path that the command takes, such as a file.
  3. The scope that kater scope use saved, when it is in the project you are in.
  4. The folder you are in. It must be in a project, a folder that holds kater_project.yml, or a folder in one.

The Files terminal and the Kater MCP never read the saved scope. In the Files terminal, a command works on the folder that the terminal is in.

Examples

Terminal window
# List the places you can work in
kater scope list
# Work in the ad_reporting workspace from now on
kater scope use connections/snowflake_prod_connection/workspaces/ad_reporting
# Show the saved scope
kater scope show

See also