# TiDB Cloud CLI Command Index

This file is generated from the upstream docs at `https://github.com/tidbcloud/tidbcloud-cli/tree/main/docs/generate_doc`.
Do not edit generated references by hand; run `scripts/generate_references.py` instead.

## How to Use These References

- Start with interactive commands whenever the CLI supports them.
- Keep non-interactive output human-friendly; prefer `-o human` where the docs support it.
- Require explicit confirmation before dangerous operations.
- Regenerate after upstream docs change.

## Top-Level Families

- [ticloud ai](generated/commands/ticloud_ai.md) - `ticloud ai`
- [Authentication](generated/families/ticloud_auth.md) - `ticloud auth`
- [Shell Completion](generated/families/ticloud_completion.md) - `ticloud completion`
- [Configuration](generated/families/ticloud_config.md) - `ticloud config`
- [Projects](generated/families/ticloud_project.md) - `ticloud project`
- [Serverless Core](generated/families/ticloud_serverless.md) - `ticloud serverless`
- [ticloud upgrade](generated/commands/ticloud_upgrade.md) - `ticloud upgrade`

## Full Command Tree

- [`ticloud ai`](generated/commands/ticloud_ai.md) - Chat with TiDB Bot
- [`ticloud auth`](generated/commands/ticloud_auth.md) - Login and logout via TiDB Cloud API
  - [`ticloud auth login`](generated/commands/ticloud_auth_login.md) - Authenticate with TiDB Cloud
  - [`ticloud auth logout`](generated/commands/ticloud_auth_logout.md) - Log out of TiDB Cloud (sensitive)
  - [`ticloud auth whoami`](generated/commands/ticloud_auth_whoami.md) - Display information about the current user
- [`ticloud completion`](generated/commands/ticloud_completion.md) - Generate the autocompletion script for the specified shell
  - [`ticloud completion bash`](generated/commands/ticloud_completion_bash.md) - Generate the autocompletion script for bash
  - [`ticloud completion fish`](generated/commands/ticloud_completion_fish.md) - Generate the autocompletion script for fish
  - [`ticloud completion powershell`](generated/commands/ticloud_completion_powershell.md) - Generate the autocompletion script for powershell
  - [`ticloud completion zsh`](generated/commands/ticloud_completion_zsh.md) - Generate the autocompletion script for zsh
- [`ticloud config`](generated/commands/ticloud_config.md) - Configure and manage your user profiles
  - [`ticloud config create`](generated/commands/ticloud_config_create.md) - Configure a user profile to store settings
  - [`ticloud config delete`](generated/commands/ticloud_config_delete.md) - Delete a profile (dangerous)
  - [`ticloud config describe`](generated/commands/ticloud_config_describe.md) - Describe a specific profile
  - [`ticloud config edit`](generated/commands/ticloud_config_edit.md) - Open the config file with the default text editor (sensitive)
  - [`ticloud config list`](generated/commands/ticloud_config_list.md) - List all profiles
  - [`ticloud config set`](generated/commands/ticloud_config_set.md) - Configure specific properties of the active profile (sensitive)
  - [`ticloud config use`](generated/commands/ticloud_config_use.md) - Use the specified profile as the active profile (sensitive)
- [`ticloud project`](generated/commands/ticloud_project.md) - Manage projects
  - [`ticloud project list`](generated/commands/ticloud_project_list.md) - List all accessible projects (human-output)
- [`ticloud serverless`](generated/commands/ticloud_serverless.md) - Manage TiDB Cloud Serverless clusters
  - [`ticloud serverless audit-log`](generated/commands/ticloud_serverless_audit-log.md) - Manage TiDB Cloud Serverless database audit logging
    - [`ticloud serverless audit-log config`](generated/commands/ticloud_serverless_audit-log_config.md) - Manage TiDB Cloud Serverless database audit logging configuration
      - [`ticloud serverless audit-log config describe`](generated/commands/ticloud_serverless_audit-log_config_describe.md) - Describe the database audit logging configuration
      - [`ticloud serverless audit-log config update`](generated/commands/ticloud_serverless_audit-log_config_update.md) - Update the database audit logging configuration (sensitive)
    - [`ticloud serverless audit-log describe`](generated/commands/ticloud_serverless_audit-log_describe.md) - Describe the database audit logging configuration
    - [`ticloud serverless audit-log disable`](generated/commands/ticloud_serverless_audit-log_disable.md) - Disable the database audit logging (dangerous)
    - [`ticloud serverless audit-log download`](generated/commands/ticloud_serverless_audit-log_download.md) - Download the database audit log files (sensitive)
    - [`ticloud serverless audit-log enable`](generated/commands/ticloud_serverless_audit-log_enable.md) - Enable the database audit logging (sensitive)
    - [`ticloud serverless audit-log filter-rule`](generated/commands/ticloud_serverless_audit-log_filter-rule.md) - Manage TiDB Cloud Serverless database audit logging filter rules
      - [`ticloud serverless audit-log filter-rule create`](generated/commands/ticloud_serverless_audit-log_filter-rule_create.md) - Create an audit log filter rule
      - [`ticloud serverless audit-log filter-rule delete`](generated/commands/ticloud_serverless_audit-log_filter-rule_delete.md) - Delete an audit log filter rule (dangerous)
      - [`ticloud serverless audit-log filter-rule describe`](generated/commands/ticloud_serverless_audit-log_filter-rule_describe.md) - Describe an audit log filter rule
      - [`ticloud serverless audit-log filter-rule disable`](generated/commands/ticloud_serverless_audit-log_filter-rule_disable.md) - Disable an audit log filter rule (dangerous)
      - [`ticloud serverless audit-log filter-rule enable`](generated/commands/ticloud_serverless_audit-log_filter-rule_enable.md) - Enable an audit log filter rule (sensitive)
      - [`ticloud serverless audit-log filter-rule list`](generated/commands/ticloud_serverless_audit-log_filter-rule_list.md) - List audit log filter rules (human-output)
      - [`ticloud serverless audit-log filter-rule template`](generated/commands/ticloud_serverless_audit-log_filter-rule_template.md) - Show audit log filter rule templates
      - [`ticloud serverless audit-log filter-rule update`](generated/commands/ticloud_serverless_audit-log_filter-rule_update.md) - Update an audit log filter rule (sensitive)
  - [`ticloud serverless authorized-network`](generated/commands/ticloud_serverless_authorized-network.md) - Manage TiDB Cloud Serverless cluster authorized networks
    - [`ticloud serverless authorized-network create`](generated/commands/ticloud_serverless_authorized-network_create.md) - Create an authorized network
    - [`ticloud serverless authorized-network delete`](generated/commands/ticloud_serverless_authorized-network_delete.md) - Delete an authorized network (dangerous)
    - [`ticloud serverless authorized-network list`](generated/commands/ticloud_serverless_authorized-network_list.md) - List all authorized networks (human-output)
    - [`ticloud serverless authorized-network update`](generated/commands/ticloud_serverless_authorized-network_update.md) - Update an authorized network (sensitive)
  - [`ticloud serverless backup`](generated/commands/ticloud_serverless_backup.md) - Manage serverless cluster backups
    - [`ticloud serverless backup describe`](generated/commands/ticloud_serverless_backup_describe.md) - Describe a serverless cluster backup
    - [`ticloud serverless backup list`](generated/commands/ticloud_serverless_backup_list.md) - List serverless cluster backups (human-output)
  - [`ticloud serverless branch`](generated/commands/ticloud_serverless_branch.md) - Manage TiDB Cloud Serverless branches
    - [`ticloud serverless branch create`](generated/commands/ticloud_serverless_branch_create.md) - Create a branch
    - [`ticloud serverless branch delete`](generated/commands/ticloud_serverless_branch_delete.md) - Delete a branch (dangerous)
    - [`ticloud serverless branch describe`](generated/commands/ticloud_serverless_branch_describe.md) - Describe a branch
    - [`ticloud serverless branch list`](generated/commands/ticloud_serverless_branch_list.md) - List branches (human-output)
    - [`ticloud serverless branch reset`](generated/commands/ticloud_serverless_branch_reset.md) - Reset a branch to its parent's latest state (dangerous)
    - [`ticloud serverless branch shell`](generated/commands/ticloud_serverless_branch_shell.md) - Connect to a branch
  - [`ticloud serverless capacity`](generated/commands/ticloud_serverless_capacity.md) - Set capacity for a TiDB Cloud Serverless cluster
  - [`ticloud serverless changefeed`](generated/commands/ticloud_serverless_changefeed.md) - Manage TiDB Cloud Serverless changefeeds
    - [`ticloud serverless changefeed create`](generated/commands/ticloud_serverless_changefeed_create.md) - Create a changefeed
    - [`ticloud serverless changefeed delete`](generated/commands/ticloud_serverless_changefeed_delete.md) - Delete a changefeed (dangerous)
    - [`ticloud serverless changefeed describe`](generated/commands/ticloud_serverless_changefeed_describe.md) - Describe a changefeed
    - [`ticloud serverless changefeed edit`](generated/commands/ticloud_serverless_changefeed_edit.md) - Edit a changefeed (sensitive)
    - [`ticloud serverless changefeed list`](generated/commands/ticloud_serverless_changefeed_list.md) - List changefeeds (human-output)
    - [`ticloud serverless changefeed pause`](generated/commands/ticloud_serverless_changefeed_pause.md) - Pause a changefeed (sensitive)
    - [`ticloud serverless changefeed resume`](generated/commands/ticloud_serverless_changefeed_resume.md) - Resume a paused changefeed (sensitive)
    - [`ticloud serverless changefeed template`](generated/commands/ticloud_serverless_changefeed_template.md) - Show changefeed Kafka, MySQL and Filter JSON templates
  - [`ticloud serverless create`](generated/commands/ticloud_serverless_create.md) - Create a TiDB Cloud Serverless cluster
  - [`ticloud serverless delete`](generated/commands/ticloud_serverless_delete.md) - Delete a TiDB Cloud Serverless cluster (dangerous)
  - [`ticloud serverless describe`](generated/commands/ticloud_serverless_describe.md) - Describe a TiDB Cloud Serverless cluster
  - [`ticloud serverless export`](generated/commands/ticloud_serverless_export.md) - Manage TiDB Cloud Serverless exports
    - [`ticloud serverless export cancel`](generated/commands/ticloud_serverless_export_cancel.md) - Cancel an export task (dangerous)
    - [`ticloud serverless export create`](generated/commands/ticloud_serverless_export_create.md) - Export data from a TiDB Cloud Serverless cluster (sensitive)
    - [`ticloud serverless export describe`](generated/commands/ticloud_serverless_export_describe.md) - Describe an export task
    - [`ticloud serverless export download`](generated/commands/ticloud_serverless_export_download.md) - Download the exported data (sensitive)
    - [`ticloud serverless export list`](generated/commands/ticloud_serverless_export_list.md) - List export tasks (human-output)
  - [`ticloud serverless import`](generated/commands/ticloud_serverless_import.md) - Manage TiDB Cloud Serverless data imports
    - [`ticloud serverless import cancel`](generated/commands/ticloud_serverless_import_cancel.md) - Cancel a data import task (dangerous)
    - [`ticloud serverless import describe`](generated/commands/ticloud_serverless_import_describe.md) - Describe a data import task
    - [`ticloud serverless import list`](generated/commands/ticloud_serverless_import_list.md) - List data import tasks (human-output)
    - [`ticloud serverless import start`](generated/commands/ticloud_serverless_import_start.md) - Start a data import task
  - [`ticloud serverless list`](generated/commands/ticloud_serverless_list.md) - List all TiDB Cloud Serverless clusters (human-output)
  - [`ticloud serverless migration`](generated/commands/ticloud_serverless_migration.md) - Manage TiDB Cloud Serverless migrations
    - [`ticloud serverless migration create`](generated/commands/ticloud_serverless_migration_create.md) - Create a migration
    - [`ticloud serverless migration delete`](generated/commands/ticloud_serverless_migration_delete.md) - Delete a migration (dangerous)
    - [`ticloud serverless migration describe`](generated/commands/ticloud_serverless_migration_describe.md) - Describe a migration
    - [`ticloud serverless migration list`](generated/commands/ticloud_serverless_migration_list.md) - List migrations (human-output)
    - [`ticloud serverless migration pause`](generated/commands/ticloud_serverless_migration_pause.md) - Pause a migration (sensitive)
    - [`ticloud serverless migration resume`](generated/commands/ticloud_serverless_migration_resume.md) - Resume a paused migration (sensitive)
    - [`ticloud serverless migration template`](generated/commands/ticloud_serverless_migration_template.md) - Show migration JSON templates
  - [`ticloud serverless private-link-connection`](generated/commands/ticloud_serverless_private-link-connection.md) - Manage private link connections for dataflow
    - [`ticloud serverless private-link-connection attach`](generated/commands/ticloud_serverless_private-link-connection_attach.md) - Attach domains to a private link connection (sensitive)
    - [`ticloud serverless private-link-connection attach-domains`](generated/commands/ticloud_serverless_private-link-connection_attach-domains.md) - Attach domains to a private link connection (sensitive)
    - [`ticloud serverless private-link-connection create`](generated/commands/ticloud_serverless_private-link-connection_create.md) - Create a private link connection for dataflow
    - [`ticloud serverless private-link-connection delete`](generated/commands/ticloud_serverless_private-link-connection_delete.md) - Delete a private link connection for dataflow (dangerous)
    - [`ticloud serverless private-link-connection describe`](generated/commands/ticloud_serverless_private-link-connection_describe.md) - Describe a private link connection for dataflow
    - [`ticloud serverless private-link-connection detach`](generated/commands/ticloud_serverless_private-link-connection_detach.md) - Detach domains from a private link connection (dangerous)
    - [`ticloud serverless private-link-connection detach-domains`](generated/commands/ticloud_serverless_private-link-connection_detach-domains.md) - Detach domains from a private link connection (sensitive)
    - [`ticloud serverless private-link-connection list`](generated/commands/ticloud_serverless_private-link-connection_list.md) - List private link connections for dataflow (human-output)
    - [`ticloud serverless private-link-connection zones`](generated/commands/ticloud_serverless_private-link-connection_zones.md) - Get account and availability zones
  - [`ticloud serverless region`](generated/commands/ticloud_serverless_region.md) - List all available regions for TiDB Cloud Serverless (human-output)
  - [`ticloud serverless restore`](generated/commands/ticloud_serverless_restore.md) - Restore a serverless cluster (sensitive)
  - [`ticloud serverless shell`](generated/commands/ticloud_serverless_shell.md) - Connect to a TiDB Cloud Serverless cluster
  - [`ticloud serverless spending-limit`](generated/commands/ticloud_serverless_spending-limit.md) - Set spending limit for a TiDB Cloud Serverless cluster
  - [`ticloud serverless sql-user`](generated/commands/ticloud_serverless_sql-user.md) - Manage cluster SQL users
    - [`ticloud serverless sql-user create`](generated/commands/ticloud_serverless_sql-user_create.md) - Create a SQL user
    - [`ticloud serverless sql-user delete`](generated/commands/ticloud_serverless_sql-user_delete.md) - Delete a SQL user (dangerous)
    - [`ticloud serverless sql-user list`](generated/commands/ticloud_serverless_sql-user_list.md) - List all accessible SQL users (human-output)
    - [`ticloud serverless sql-user update`](generated/commands/ticloud_serverless_sql-user_update.md) - Update a SQL user (sensitive)
  - [`ticloud serverless update`](generated/commands/ticloud_serverless_update.md) - Update a TiDB Cloud Serverless cluster (sensitive)
- [`ticloud upgrade`](generated/commands/ticloud_upgrade.md) - Upgrade the CLI to the latest version (sensitive)

## Dangerous Commands

- [`ticloud config delete`](generated/commands/ticloud_config_delete.md)
- [`ticloud serverless audit-log disable`](generated/commands/ticloud_serverless_audit-log_disable.md)
- [`ticloud serverless audit-log filter-rule delete`](generated/commands/ticloud_serverless_audit-log_filter-rule_delete.md)
- [`ticloud serverless audit-log filter-rule disable`](generated/commands/ticloud_serverless_audit-log_filter-rule_disable.md)
- [`ticloud serverless authorized-network delete`](generated/commands/ticloud_serverless_authorized-network_delete.md)
- [`ticloud serverless branch delete`](generated/commands/ticloud_serverless_branch_delete.md)
- [`ticloud serverless branch reset`](generated/commands/ticloud_serverless_branch_reset.md)
- [`ticloud serverless changefeed delete`](generated/commands/ticloud_serverless_changefeed_delete.md)
- [`ticloud serverless delete`](generated/commands/ticloud_serverless_delete.md)
- [`ticloud serverless export cancel`](generated/commands/ticloud_serverless_export_cancel.md)
- [`ticloud serverless import cancel`](generated/commands/ticloud_serverless_import_cancel.md)
- [`ticloud serverless migration delete`](generated/commands/ticloud_serverless_migration_delete.md)
- [`ticloud serverless private-link-connection delete`](generated/commands/ticloud_serverless_private-link-connection_delete.md)
- [`ticloud serverless private-link-connection detach`](generated/commands/ticloud_serverless_private-link-connection_detach.md)
- [`ticloud serverless sql-user delete`](generated/commands/ticloud_serverless_sql-user_delete.md)

## Commands With Documented Human Output

- [`ticloud project list`](generated/commands/ticloud_project_list.md)
- [`ticloud serverless audit-log filter-rule list`](generated/commands/ticloud_serverless_audit-log_filter-rule_list.md)
- [`ticloud serverless authorized-network list`](generated/commands/ticloud_serverless_authorized-network_list.md)
- [`ticloud serverless backup list`](generated/commands/ticloud_serverless_backup_list.md)
- [`ticloud serverless branch list`](generated/commands/ticloud_serverless_branch_list.md)
- [`ticloud serverless changefeed list`](generated/commands/ticloud_serverless_changefeed_list.md)
- [`ticloud serverless export list`](generated/commands/ticloud_serverless_export_list.md)
- [`ticloud serverless import list`](generated/commands/ticloud_serverless_import_list.md)
- [`ticloud serverless list`](generated/commands/ticloud_serverless_list.md)
- [`ticloud serverless migration list`](generated/commands/ticloud_serverless_migration_list.md)
- [`ticloud serverless private-link-connection list`](generated/commands/ticloud_serverless_private-link-connection_list.md)
- [`ticloud serverless region`](generated/commands/ticloud_serverless_region.md)
- [`ticloud serverless sql-user list`](generated/commands/ticloud_serverless_sql-user_list.md)