Skip to main content
DocumentationLibraryReference
On this page

Kater CLI Find and understand files

kater files list

Lists the folders and files in one folder, as the VS Code Explorer shows them in a local copy.

Folders come first, then files, by name in the Explorer’s order, and hidden ones too. Each item is marked when you can only read it.

Examples

Terminal window
# List the content root
kater files list
# List the folder of the ad_reporting workspace
kater files list connections/snowflake_prod_connection/workspaces/ad_reporting
# List your own brainstorm folder
kater files list connections/snowflake_prod_connection/users/you@example.com/brainstorm

Arguments

ArgumentDescription
<path>Optional. A folder, by its path from the folder you are in, or from --kater-root when you give it. Leave it out to list the content root, which holds connections/ and kater.config.yaml. In the Files terminal, leave it out to list the folder you are in.

Options

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

What each line shows

  • A file shows its type, and when it was last saved. A model file shows its model type, such as query.
  • A topic’s note in a brainstorm folder shows its title and its status: open, answered, applied or dropped.
  • read-only marks a file that you cannot change, and a folder that you cannot add files to.

With --json, it returns the files.list answer.

See also