Skip to main content
DocumentationLibraryReference
On this page

Kater CLI Pages you have open or were sent

kater place

Says what a Kater page shows, from its address: the object it has open, its setup and the files it reads.

Use it for a link that someone sends you. It needs no open tab, and nothing runs on the warehouse.

Examples

Terminal window
# Read what an app page shows, from a link that someone sent you
kater place https://app.kater.ai/app/app_2439965aaef44122926eb42b57f4c8b8/viewing
# Read what the ad_reporting dashboard shows, from its address without the host
kater place "/workspace/connections/snowflake_prod_connection/workspaces/ad_reporting?view=dashboard"
# Read the page that the spend_by_platform query opens on
kater place --path connections/snowflake_prod_connection/workspaces/ad_reporting/query_contracts/spend_by_platform.sql
# Read the page that line 10 of the query opens on
kater place --path connections/snowflake_prod_connection/workspaces/ad_reporting/query_contracts/spend_by_platform.sql --line 10

Arguments

ArgumentDescription
<url>Optional. The page’s address, whole or from the portal’s root, such as https://app.kater.ai/app/app_2439965aaef44122926eb42b57f4c8b8/viewing. Put an address that has ? or & in quotes.

Options

OptionDescription
--path <path>A file or folder, in place of URL. Kater reads the page that opens it. The path is from the folder you are in, or from --kater-root when you give it.
--model <name>With --path: one query of a file that declares several, by its name.
--line <n>With --path: a line of the file, counted from 1. In a file that declares several queries, the page opens on the query that holds that line.
--connection <name>The connection to look for an app in first. A page such as the Sandbox is in this connection.

It also takes the global options --json, --kater-root, --scope and --help.

What it answers

  • url is the page’s address, and crumbs say where the page is.
  • object is the object the page has open, and open is what is open on it, with its detail.
  • says is what the page shows and how it is set up.
  • files lists every file the page has open or reads. Each file has its role on the page: page, query, chart, table, kpi, filter, dashboard, theme or file. A tag’s file also has the heading of what it shows.

Read the files with the file tools or with other kater commands. kater here reads each of your open tabs the same way.

See also