rag-ls-files Command Reference

docs/commands/ls-files.txt

ed9c258d00cdc004c65e328354363a1a434a29f1f04bb7c600000003000002c5

rag-ls-files(1)
==========

NAME
----
rag-ls-files - Show information about files

SYNOPSIS
--------
[verse]
'rag ls-files' [--name-only | --stat-only | --uid-only]
            [--staged | --processed] [--json | -j] [<uid>..]

DESCRIPTION
-----------
Run `rag help uid-query` to read how uid-query works. If the uid is of a chunk
or an image, it dies.

If multiple files are matched, it shows the information about all the matched
files.

If `--json` is set, it dumps a valid json to stdout. Its schema is,

- no flags: `[file_schema: object]`
- `--uid-only`: `[uid: string]`
- `--name-only`: `[name: string]`
- `--stat-only`: `{ "total files": integer, "staged files": integer, "processed files": integer }`

Chunks

9a30ebd4 (1st chunk of `docs/commands/ls-files.txt`)

Title: rag-ls-files Command Reference

Summary

The rag-ls-files command displays information about files, allowing for various output formats and filtering options, including JSON output and querying by UID, with parameters to control the level of detail and type of data shown, such as file names, statistics, and user IDs.