ti fs create-file-system

Creates a file system and returns its ID and owner token. The CLI stores and selects the token in the current profile. Use --wait to wait until the file system is ready for use.

You can optionally set a display name and labels. These values appear in list-file-systems and describe-file-system output but do not select the file system in later commands.

Syntax

ti fs create-file-system
  [--display-name <string>]
  [--dry-run]
  [--help]
  [--label <string>]
  [--version]
  [--wait]

Options

• --display-name <string>: Set a display name between 4 and 64 characters shown by file system inventory commands. The value does not select the file system in later commands.
• --dry-run: Validate the request without applying changes.
• --help: Display help information.
• --label <string>: Add an organization-visible key=value label. Repeat this option to add up to 30 labels. Do not put secrets or personal data in labels.
• --version: Display version information.
• --wait: Wait until the created file system is active.

For options shared by all commands, see Global options.

Examples

• Create a file system and wait until it is ready:

  # Wait until the new file system root is readable before returning.
  ti fs create-file-system \
    --display-name agent-workspace \
    --label environment=development \
    --label team=ai \
    --wait
  

• Create a file system asynchronously:

  # Return after provisioning is accepted so work can continue in parallel.
  ti fs create-file-system
  

• Preview file system creation:

  # Validate credentials, placement, and the request without provisioning storage.
  ti fs create-file-system --dry-run
  

Related documentation

• TiDB Cloud Filesystem CLI Command Reference