{"id":21846558,"url":"https://github.com/tidbcloud/setup-tidbcloud-cli","last_synced_at":"2026-05-08T06:35:25.183Z","repository":{"id":69928603,"uuid":"582913650","full_name":"tidbcloud/setup-tidbcloud-cli","owner":"tidbcloud","description":null,"archived":false,"fork":false,"pushed_at":"2024-04-15T13:11:36.000Z","size":591,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-12-17T01:03:12.090Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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-12-28T08:07:54.000Z","updated_at":"2024-06-13T05:54:11.000Z","dependencies_parsed_at":"2024-04-15T14:05:55.134Z","dependency_job_id":"88272f2a-721f-4be2-bafb-b49ae9e1c529","html_url":"https://github.com/tidbcloud/setup-tidbcloud-cli","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tidbcloud%2Fsetup-tidbcloud-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tidbcloud%2Fsetup-tidbcloud-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tidbcloud%2Fsetup-tidbcloud-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tidbcloud%2Fsetup-tidbcloud-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tidbcloud","download_url":"https://codeload.github.com/tidbcloud/setup-tidbcloud-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244831060,"owners_count":20517620,"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":[],"created_at":"2024-11-27T23:14:26.250Z","updated_at":"2025-10-30T16:13:39.618Z","avatar_url":"https://github.com/tidbcloud.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# setup-tidbcloud-cli\n\nThe `tidbcloud/setup-tidbcloud-cli` action is a JavaScript action that sets up [`ticloud`](https://github.com/tidbcloud/tidbcloud-cli) in your GitHub Actions workflow by:\n\n- Downloading a specific version of `ticloud` and adding it to the `PATH`.\n- Configuring `ticloud` with API token.\n\n## Prerequisites\n\n- This action requires TiDB Cloud API Key to execute `ticloud` commands.\n  See [Authentication](https://docs.pingcap.com/tidbcloud/api/v1beta#section/Authentication) for more details.\n- This action only support following runners:\n\n| Architecture Support | macOS | Linux | Windows |\n| -------------------- | ----- | ----- | ------- |\n| arm64                | ✔    | ✔    | ✘       |\n| amd64                | ✔    | ✔    | ✔      |\n\n## Usage\n\nThis action can be run on `ubuntu-latest`, `windows-latest`, and `macos-latest` GitHub Actions runners. When running on `windows-latest` the shell should be set to Bash.\nSee [Prerequisites](#prerequisites) on how to get API key and then set them to repository secrets.\n\n```yaml\nuses: tidbcloud/setup-tidbcloud-cli@v0\nwith:\n  api_public_key: ${{ secrets.TIDB_CLOUD_API_PUBLIC_KEY }}\n  api_private_key: ${{ secrets.TIDB_CLOUD_API_PRIVATE_KEY }}\n```\n\nA specific version of `ticloud` can be installed(Releases can be found [here](https://github.com/tidbcloud/tidbcloud-cli/releases)):\n\n```yaml\nuses: tidbcloud/setup-tidbcloud-cli@v0\nwith:\n  version: 0.1.6\n  api_public_key: ${{ secrets.TIDB_CLOUD_API_PUBLIC_KEY }}\n  api_private_key: ${{ secrets.TIDB_CLOUD_API_PRIVATE_KEY }}\n```\n\n## Inputs\n\nThe action supports the following inputs:\n\n- `api_public_key` - (required) The public key of TiDB Cloud api.\n- `api_private_key` - (required) The private key of TiDB Cloud api.\n- `version` - (optional) The version of `ticloud` to install, defaulting to latest version.\n\n## License\n\nSee [LICENSE](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftidbcloud%2Fsetup-tidbcloud-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftidbcloud%2Fsetup-tidbcloud-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftidbcloud%2Fsetup-tidbcloud-cli/lists"}