ticloud help

November 21, 2024 ยท View on GitHub

Get help information for any command in TiDB Cloud CLI:

ticloud help [command] [flags]

Examples

To get help for the auth command:

ticloud help auth

To get help for the serverless create command:

ticloud help serverless create

Flags

In non-interactive mode, you need to manually enter the required flags. In interactive mode, you can just follow CLI prompts to fill them in.

FlagDescriptionRequiredNote
-h, --helpShows help information for this command.NoWorks in both non-interactive and interactive modes.

Inherited flags

FlagDescriptionRequiredNote
--no-colorDisables color in output.NoOnly works in non-interactive mode. In interactive mode, disabling color might not work with some UI components.
-P, --profile stringSpecifies the active user profile used in this command.NoWorks in both non-interactive and interactive modes.
-D, --debugEnables debug mode.NoWorks in both non-interactive and interactive modes.

Feedback

If you have any questions or suggestions on the TiDB Cloud CLI, feel free to create an issue. Also, we welcome any contributions.