ti fs copy-file

Copies files between local paths, remote paths, stdin, and stdout. The command alias is ti fs cp.

Syntax

ti fs copy-file
  [--append]
  [--create-parents]
  [--description <string>]
  [--dry-run]
  [--file-system-id <string>]
  [--from-local <string>]
  [--from-remote <string>]
  [--from-stdin]
  [--fs-token <string>]
  [--help]
  [--layer-id <string>]
  [--overwrite]
  [--recursive]
  [--resume]
  [--tag <string>]
  [--to-local <string>]
  [--to-remote <string>]
  [--to-stdout]
  [--version]

Options

• --append: Append the contents of a local file to a file in the TiDB Cloud file system.
• --create-parents: Create missing local parent directories when copying from a TiDB Cloud file system.
• --description <string>: The file description for --to-remote operation.
• --dry-run: Validate the request without applying changes.
• --file-system-id <string>: Select the file system. You can also set TI_FS_FILE_SYSTEM_ID.
• --from-local <string>: The local source path.
• --from-remote <string>: The source path in the TiDB Cloud file system.
• --from-stdin: Read from stdin and write to --to-remote.
• --fs-token <string>: Set the file system user token. If omitted, uses TI_FS_TOKEN.
• --help: Display help information.
• --layer-id <string>: Write one copied file into a file system layer instead of the base file system. Cannot be combined with --recursive.
• --overwrite: Replace an existing destination file.
• --recursive: Copy directory structure recursively. Cannot be combined with --layer-id; seed a layer directory through a writable FUSE mount instead.
• --resume: Resume an active copy operation.
• --tag <string>: Create tags key=value for --to-remote operation; repeatable.
• --to-local <string>: The local destination path.
• --to-remote <string>: The destination path in the TiDB Cloud file system.
• --to-stdout: Write --from-remote to stdout.
• --version: Display version information.

For options shared by all commands, see Global options.

Examples

• Upload a local file:

  # Copy a local report into the selected remote Filesystem.
  ti fs copy-file --file-system-id <file-system-id> --from-local ./report.md --to-remote /reports/report.md
  

• Download a remote file:

  # Create missing local parent directories while downloading the file.
  ti fs copy-file --file-system-id <file-system-id> --from-remote /reports/report.md --to-local ./downloads/report.md --create-parents
  

• Copy a remote directory:

  # Duplicate a complete directory tree without downloading it locally.
  ti fs copy-file --file-system-id <file-system-id> --from-remote /reports --to-remote /archive/reports --recursive
  

• Resume a large upload:

  # Continue an interrupted local-to-remote transfer instead of restarting it.
  ti fs copy-file --file-system-id <file-system-id> --from-local ./large.bin --to-remote /artifacts/large.bin --resume
  

• Append to a remote log:

  # Add local log data to the existing remote object efficiently.
  ti fs copy-file --file-system-id <file-system-id> --from-local ./tail.log --to-remote /logs/app.log --append
  

• Stream standard input to the Filesystem:

  # Upload generated content without creating an intermediate local file.
  printf 'ready\n' | ti fs copy-file --file-system-id <file-system-id> --from-stdin --to-remote /status.txt --tag source=stdin --description "generated status"
  

Related documentation

• TiDB Cloud Filesystem CLI Command Reference