Skip to main content

# kater files index

Lists every file and folder that you can read in one connection, as the tree on the Files page shows them.

{/* Written by apps/landing-page/scripts/docs/write_cli_reference.py from the kater CLI's own help and scripts/docs/cli-reference.md. Do not edit it by hand: change those, then run the script. */}

It starts at the connection's folder and opens every folder in it. It reads no file's content. Use it to see what is yours, what is shared with you, and what you cannot rename, move or delete.

## Examples

```bash
# List every file and folder you can read in snowflake_prod_connection
kater files index --connection snowflake_prod_connection
# List them as JSON, with each file's type, size and last save
kater files index --connection snowflake_prod_connection --json
```

## Options

<div class="cli-options">

| Option | Description |
| --- | --- |
| `--connection <name>` | The connection, by its folder name under `connections/`, such as `snowflake_prod_connection`. Leave it out to use the connection that `--scope` names. Next, it uses the connection of your saved scope, or of the Files terminal's folder. Last, it uses the only connection you can see. |

</div>

It also takes the [global options](https://kater.ai/docs/cli-reference/global-options/) `--json`, `--kater-root`, `--scope` and `--help`.

## Marks

| Mark | Meaning |
| --- | --- |
| `read-only` | You can only read it. |
| `yours` | It is in your own folder. |
| `shared with you` | Someone shared it with you from their folder. |
| `someone else's` | It is the rest of someone's folder. An admin reaches it, or it leads down to what someone shared with you. |
| `fixed` | It cannot be renamed or moved. |
| `kept` | It cannot be deleted. |

A `fixed` or `kept` mark names a reason. The end of the list says what each reason means.

## What it leaves out

- It leaves out `.gitkeep` files, and each `.kater` folder, which holds Kater's own records.
- It lists at most 20,000 files and folders. When there are more, the last line says so.

With `--json`, it returns the `files.index` answer. Its entries also have each file's type, size and last save, and its `ownership`: `mine`, `shared` or `others`.

## See also

- [`kater files`](https://kater.ai/docs/cli-reference/files/)
- [All commands](https://kater.ai/docs/cli-reference/kater/)

On this page

Examples
Options
Marks
What it leaves out
See also

Kater CLI Find and understand files

kater files index

Lists every file and folder that you can read in one connection, as the tree on the Files page shows them.

It starts at the connection’s folder and opens every folder in it. It reads no file’s content. Use it to see what is yours, what is shared with you, and what you cannot rename, move or delete.

Examples

# List every file and folder you can read in snowflake_prod_connection
kater files index --connection snowflake_prod_connection
# List them as JSON, with each file's type, size and last save
kater files index --connection snowflake_prod_connection --json

Options

Option	Description
`--connection <name>`	The connection, by its folder name under `connections/`, such as `snowflake_prod_connection`. Leave it out to use the connection that `--scope` names. Next, it uses the connection of your saved scope, or of the Files terminal’s folder. Last, it uses the only connection you can see.

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

Marks

Mark	Meaning
`read-only`	You can only read it.
`yours`	It is in your own folder.
`shared with you`	Someone shared it with you from their folder.
`someone else's`	It is the rest of someone’s folder. An admin reaches it, or it leads down to what someone shared with you.
`fixed`	It cannot be renamed or moved.
`kept`	It cannot be deleted.

A fixed or kept mark names a reason. The end of the list says what each reason means.

What it leaves out

It leaves out .gitkeep files, and each .kater folder, which holds Kater’s own records.
It lists at most 20,000 files and folders. When there are more, the last line says so.

With --json, it returns the files.index answer. Its entries also have each file’s type, size and last save, and its ownership: mine, shared or others.

See also