rag-ls-files Command Reference

docs/commands/ls-files.txt

a8de621a082acf436f490479f885a021cea16b9feb229b4100000003000003b3

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] [--abbrev <n=9>]
            [<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.

Instead of showing the full 64-byte uid, it shows the first `n` bytes of uid,
where `n` is set by `--abbrev` option. Unlike git, it doesn't use any
heuristics to guarantee that the abbreviated uid is unique.

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

66d37bdb (1st chunk of `docs/commands/ls-files.txt`)

Title: rag-ls-files Command Reference

Summary

The rag-ls-files command displays information about files, with optional flags to customize output, including UID, name, statistics, and JSON formatting, allowing users to retrieve specific details about matched files, with support for abbreviated UIDs and customizable output formats.