Skip to main content
On this page

Kater CLI Explore and try ideas brainstorm

kater brainstorm show

Shows a page, note or scratch file from a brainstorm folder, a workspace copy, or an app's page.

It gives the title, the link and who can open it. For a page, it checks whether each Kater tag draws. Nothing runs on the warehouse.

Examples

Terminal window
# Go to the snowflake_prod_connection connection
cd connections/snowflake_prod_connection
# List a scratch file's statements, and what each one reads
kater brainstorm show users/you@example.com/brainstorm/sandbox/live_session_check.sql
# Check whether each tag on a brainstorm page draws
kater brainstorm show users/you@example.com/brainstorm/paid_media_query_rules/pages/paid_media_spend_and_return.html
# See what a workspace copy changed since it was copied
kater brainstorm show users/you@example.com/brainstorm/marketing_channel_performance/workspaces/channel_performance_weekly
# Show an installed app's first page
kater brainstorm show users/you@example.com/apps/paid_media_spend_and_return

Arguments

ArgumentDescription
<path>What to show, by its path. That is a page (.html), note (.md) or scratch file (.sql) in a brainstorm folder, or a workspace copy’s folder. It also takes a draft app or an installed app. Its folder or its kater.app.yaml shows its first page, or name one of its pages.

Options

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

What it shows

  • Every kind gives its title, its link and who can open it (access), such as “Only you and admins can open it”. The link is https://app.kater.ai/open?path= and the path, or the same path on KATER_APP_URL when it is set. An app adds its id, its name and its pages.
  • A page says whether each Kater tag draws for you, as the page would read it. A tag’s query must exist, compile and return every field the tag names. A chart along an axis must get one value for each point. When a tag cannot draw, it says why, with each field it lacks and the closest field its query returns. It also lists figures typed into the page that no query backs. A page gives its topic’s kind.
  • Sample rows. A tag that reads sample rows names its block in sample. It draws only on a page in a spike’s folder, and then the summary says that the page cannot be exported.
  • A note gives its title, its topic’s status, and its topic’s kind (topic_kind, spike or change).
  • A scratch file lists its statements. Each gives the line it starts on, how it runs, what it reads, and the chart that charts: keeps for it. It runs none of them. kater show --select with --statement runs one, and kater run --select runs them all.
  • A workspace copy (copy_of) names the workspace it copies, and when it was copied and last applied. It lists each file it changed since, with what kater workspace apply would do with it, worked out without compiling. It says why a file is left out or refused. It also lists its queries, and the commands that compare it and propose applying it.

Files you cannot open

Only a brainstorm folder’s owner, admins and the people it is shared with can see what is in it. An app’s page, anyone who can open the app. Anyone else gets locked, not a refusal: whose folder it is in, who can open it, and what to ask for. Nothing of the file is read.

In a chat

Through the Kater MCP’s kater tool, a page draws in the chat. It opens from a one-time link that works for you for a few minutes, with its tags’ verdict under it. A scratch file shows each statement with Run, and a copy shows Compare and Apply. The result’s app_url is the link in Kater. --json returns the page.show answer.

See also