| name | update-ticloud-cli-command |
| description | Update TiDB Cloud CLI commands. Use when adding new flags or updating existing commands. |
| license | Complete terms in LICENSE.txt |
| metadata | {"author":"shiyuhang0"} |
Update TiCloud CLI Command
This skill updates TiDB Cloud CLI existing commands, helping users update existing commands with production-ready code.
When to use
- The user asks to add flags to existing commands.
- The user asks to update logic of existing commands.
About TiDB Cloud CLI
TiDB Cloud CLI (TiCloud CLI) is a command-line interface for interacting with TiDB Cloud, built on the Cobra library.
Key design of TiDB Cloud CLI:
-
Built on the Cobra library.
-
Uses the TiDB Cloud Open API as the client and keeps the SDK inside the project.
-
Every command supports both interactive and non-interactive modes.
-
More about TiDB Cloud CLI: references/tidbcloud-cli.md.
-
More about Cobra: references/cobra.md.
Workflow
Must follow the workflow below:
Generate SDK phase
Always prompt the user: "Do you need to add or update swagger? Please provide the swagger path if you need."
Skip this phase if user does not need.
Once in this phase, follow the guide in to generate the SDK.