ti fs read-file

Reads a remote file or byte range and outputs it to stdout. The command alias is ti fs cat.

Syntax

ti fs read-file
  --path <string>
  [--file-system-id <string>]
  [--fs-token <string>]
  [--help]
  [--length <int64>]
  [--offset <int64>]
  [--version]

Options

• --path <string>: File path in the selected file system. [required]
• --file-system-id <string>: Select the file system. You can also set TI_FS_FILE_SYSTEM_ID.
• --fs-token <string>: Set the Filesystem token. If omitted, the command uses the TI_FS_TOKEN environment variable. If neither is provided, the command uses the local token stored for the selected Filesystem.
• --help: Display help information.
• --length <int64>: Byte length for a ranged read.
• --offset <int64>: Zero-based byte offset for a ranged read.
• --version: Display version information.

For options shared by all commands, see Global options.

Examples

• Read a complete file:

  # Write the remote file contents directly to standard output.
  ti fs read-file --file-system-id <file-system-id> --path /reports/report.md
  

• Read a byte range:

  # Fetch only the requested range from a large remote object.
  ti fs read-file --file-system-id <file-system-id> --path /archives/large.bin --offset 1024 --length 4096
  

Related documentation

• TiDB Cloud Filesystem CLI Command Reference