ti fs unpack-file-system

Restores local overlay state from a remote archive.

Syntax

ti fs unpack-file-system
  [--archive-path <string>]
  [--dry-run]
  [--file-system-id <string>]
  [--fs-token <string>]
  [--help]
  [--local-root <string>]
  [--mount-path <string>]
  [--mount-profile <string>]
  [--no-replace]
  [--remote-root <string>]
  [--version]

Options

• --archive-path <string>: The path for the packed archive.
• --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.
• --fs-token <string>: Set the file system user token. If omitted, uses TI_FS_TOKEN.
• --help: Display help information.
• --local-root <string>: The local overlay root to restore into.
• --mount-path <string>: The local mounted path.
• --mount-profile <string>: Mount profile: coding-agent, portable, or none. If omitted, uses none.
• --no-replace: Merge archive entries instead of replacing them.
• --remote-root <string>: Find the packed archive under the specified root path when --archive-path is omitted. [default: /]
• --version: Display version information.

For options shared by all commands, see Global options.

Examples

• Unpack into a mounted workspace:

  # Restore the portable archive associated with an existing mount.
  ti fs unpack-file-system --file-system-id <file-system-id> --mount-path /path/to/workspace
  

• Unpack explicit roots without replacement:

  # Restore missing files while preserving existing destination entries.
  ti fs unpack-file-system --file-system-id <file-system-id> --local-root ./overlay --remote-root /workspace --mount-profile portable --no-replace
  

Related documentation

• TiDB Cloud Filesystem CLI Command Reference