Skip to main content
DocumentationLibraryReference
On this page

Kater CLI Explore and try ideas scratch

kater scratch list

Lists your scratch files and the ones someone shared with you, newest first.

An admin sees everyone’s. Each line gives the file’s label or its path in its brainstorm folder, and whose it is when it is not yours. It also gives when the file was last edited, and its path.

Examples

Terminal window
# List your scratch files in the snowflake_prod_connection connection
kater scratch list --connection snowflake_prod_connection
# List your whole brainstorm folder as JSON, with its topics and notes
kater scratch list --connection snowflake_prod_connection --json

Options

OptionDescription
--connection <name>The connection to list, by its folder name under connections/. Left out, the connection that --scope names, the one your saved scope is in, or your only one.

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

The JSON answer

--json gives the whole sandbox.files answer, not only the scratch files:

  • topics. Your topics, each with its note (brainstorm/<topic>.md), its folder, its title, its status and its kind.
  • folders. Every folder in your brainstorm folder.
  • files. Every file in your brainstorm folder, and the scratch files shared with you, newest first. Each gives its kind, its ownership (mine, shared or others) and its owner.

A brainstorm folder with more than 5,000 files and folders lists only the first 5,000, and says so.

See also