{"id":21846577,"url":"https://github.com/tidbcloud/tidbcloud-cli","last_synced_at":"2025-07-27T19:43:29.651Z","repository":{"id":63755724,"uuid":"561609965","full_name":"tidbcloud/tidbcloud-cli","owner":"tidbcloud","description":"The CLI for TiDB Cloud","archived":false,"fork":false,"pushed_at":"2025-04-10T03:30:45.000Z","size":1930,"stargazers_count":9,"open_issues_count":8,"forks_count":3,"subscribers_count":14,"default_branch":"main","last_synced_at":"2025-04-10T04:32:27.344Z","etag":null,"topics":["cli","go","mysql","serverless","tidb","tidbcloud"],"latest_commit_sha":null,"homepage":"https://tidb.cloud/","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tidbcloud.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-11-04T04:11:34.000Z","updated_at":"2025-04-01T03:32:22.000Z","dependencies_parsed_at":"2024-02-19T07:32:00.243Z","dependency_job_id":"aff94f22-84d1-42c2-b434-1eba4a21b139","html_url":"https://github.com/tidbcloud/tidbcloud-cli","commit_stats":null,"previous_names":[],"tags_count":34,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tidbcloud%2Ftidbcloud-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tidbcloud%2Ftidbcloud-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tidbcloud%2Ftidbcloud-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tidbcloud%2Ftidbcloud-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tidbcloud","download_url":"https://codeload.github.com/tidbcloud/tidbcloud-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248888699,"owners_count":21178094,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","go","mysql","serverless","tidb","tidbcloud"],"created_at":"2024-11-27T23:14:30.039Z","updated_at":"2025-04-14T13:32:53.778Z","avatar_url":"https://github.com/tidbcloud.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# TiDB Cloud CLI\n\nThe `ticloud` command line tool brings deploy cluster requests, and other TiDB Cloud concepts to your fingertips.\n\n## Table of Contents\n- [TiDB Cloud CLI](#tidb-cloud-cli)\n  - [Table of Contents](#table-of-contents)\n  - [Installation](#installation)\n    - [macOS and Linux](#macos-and-linux)\n      - [Installing via script](#installing-via-script)\n      - [Installing via TiUP](#installing-via-tiup)\n    - [Manually](#manually)\n    - [GitHub Action](#github-action)\n  - [Quick Start](#quick-start)\n    - [Config a profile](#config-a-profile)\n    - [Create a cluster](#create-a-cluster)\n  - [Documentation](#documentation)\n  - [Telemetry](#telemetry)\n  - [Roadmap](#roadmap)\n\n## Installation\n\n### macOS and Linux\n\n#### Installing via script\n\n```shell\ncurl https://raw.githubusercontent.com/tidbcloud/tidbcloud-cli/main/install.sh | sh\n```\n\n#### Installing via [TiUP](https://tiup.io/)\n\n```shell\ntiup install cloud\n```\n\n### Manually\n\nDownload the pre-compiled binaries from the [releases](https://github.com/tidbcloud/tidbcloud-cli/releases/latest) page and copy to the desired location.\n\n### GitHub Action\n\nTo set up `ticloud` in GitHub Action, use [`setup-tidbcloud-cli`](https://github.com/tidbcloud/setup-tidbcloud-cli).\n\n## Quick Start\n\nIn order to use the `ticloud` CLI, you need to have a TiDB Cloud account. If you don't have one, you can sign up for a free trial [here](https://tidbcloud.com/).\n\n### Config a profile\n\nConfig a profile with your TiDB Cloud [API key](https://docs.pingcap.com/tidbcloud/api/v1beta#section/Authentication/API-Key-Management) or log in via OAuth.\n\n```shell\nticloud config create\n\n# via TiUP\ntiup cloud config create\n\n# via OAuth\nticloud auth login\n```\n\n\u003e :information_source: The config name **MUST NOT** contain '.'\n\n### Create a cluster\n\n```shell\nticloud serverless create\n\n# via TiUP\ntiup cloud serverless create\n```\n\n## Documentation\n\nPlease check the CLI help for more information.\n\n## Telemetry\n\nSee [here](/docs/telemetry.md)\n\n## Roadmap\n\nThere are many features we want to add to the CLI.\n- CLI supports generating demo code for using TiDB Cloud cluster.\n- CLI supports managing the dedicated cluster.\n- CLI supports backing up and restoring the TiDB Cloud cluster.\n- CLI supports connecting in shell command without SQL user.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftidbcloud%2Ftidbcloud-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftidbcloud%2Ftidbcloud-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftidbcloud%2Ftidbcloud-cli/lists"}