{"id":13990593,"url":"https://github.com/circleci-tools/circleci-cli","last_synced_at":"2025-04-10T10:06:50.868Z","repository":{"id":3399927,"uuid":"49353429","full_name":"circleci-tools/circleci-cli","owner":"circleci-tools","description":":cyclone: CLI client / command line tool for CircleCI","archived":false,"fork":false,"pushed_at":"2024-05-22T09:08:27.000Z","size":9443,"stargazers_count":86,"open_issues_count":2,"forks_count":7,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-05-22T10:33:57.158Z","etag":null,"topics":["circle-ci","circleci","circler","cli","command-line","command-line-tools","gem","pusher","ruby","websocket"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/circleci-tools.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2016-01-10T04:31:58.000Z","updated_at":"2024-05-30T07:56:06.742Z","dependencies_parsed_at":"2024-03-22T00:25:09.009Z","dependency_job_id":"5b3744c4-4ced-435a-a5b0-78518c001b65","html_url":"https://github.com/circleci-tools/circleci-cli","commit_stats":{"total_commits":798,"total_committers":7,"mean_commits":114.0,"dds":0.5914786967418546,"last_synced_commit":"5ac92ec045f2187cd2350ce82fa96e3990a82e60"},"previous_names":["circleci-tools/circleci-cli","unhappychoice/circleci-cli"],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/circleci-tools%2Fcircleci-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/circleci-tools%2Fcircleci-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/circleci-tools%2Fcircleci-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/circleci-tools%2Fcircleci-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/circleci-tools","download_url":"https://codeload.github.com/circleci-tools/circleci-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248198881,"owners_count":21063628,"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":["circle-ci","circleci","circler","cli","command-line","command-line-tools","gem","pusher","ruby","websocket"],"created_at":"2024-08-09T13:02:58.196Z","updated_at":"2025-04-10T10:06:50.843Z","avatar_url":"https://github.com/circleci-tools.png","language":"Ruby","readme":"# circleci-cli\n[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)\n[![Gem Version](https://badge.fury.io/rb/circleci-cli.svg)](https://badge.fury.io/rb/circleci-cli)\n[![Code Climate](https://codeclimate.com/github/circleci-tools/circleci-cli/badges/gpa.svg)](https://codeclimate.com/github/circleci-tools/circleci-cli)\n[![codecov](https://codecov.io/gh/circleci-tools/circleci-cli/branch/master/graph/badge.svg)](https://codecov.io/gh/circleci-tools/circleci-cli)\n[![Libraries.io dependency status for GitHub repo](https://img.shields.io/librariesio/github/circleci-tools/circleci-cli.svg)](https://libraries.io/github/circleci-tools/circleci-cli)\n![](http://ruby-gem-downloads-badge.herokuapp.com/circleci-cli?type=total)\n![GitHub](https://img.shields.io/github/license/circleci-tools/circleci-cli.svg)\n\ncircleci-cli is a CLI tool for [Circle CI](https://circleci.com).\n\n![sample.gif](https://github.com/circleci-tools/circleci-cli/raw/master/movie/rec.gif)\n\n## Installation\n\n```sh\n$ gem install circleci-cli\n```\n\nset the `CIRCLE_CI_TOKEN` environment variable. (optional)\n\n```sh\nexport CIRCLE_CI_TOKEN=your-circle-ci-token\n```\n\n## Usage\n```\nCommands:\n  circleci-cli browse               # Open CircleCI website\n  circleci-cli build                # Show the build result\n  circleci-cli builds               # List builds\n  circleci-cli cancel               # Cancel a build\n  circleci-cli help [COMMAND]       # Describe available commands or one specific command\n  circleci-cli projects             # List projects\n  circleci-cli retry                # Retry a build\n  circleci-cli version              # Show gem version\n  circleci-cli watch                # Watch builds in real time\n\nOptions:\n  -p user_name/project              # Specify repository\n                                    # Default to the Git remote of current directory\n\n  -b branch                         # Specify branch name\n                                    # Default to the current Git branch\n\n  -a, --all, --no-all               # Ignore the branch option and stop being filtered by the branch\n                                    # Default to false\n\n  -n build_number                   # Specify build number.\n  -l last                           # Get or retry last failed build.\n  -v verbose                        # Show all the logs if applied to watch command.\n\n  --pretty=true/false, --no-pretty  # Make outputs pretty or not\n                                    # Default to true\n```\n\n### Examples\n\n#### Watch your project\n```\n$ circleci-cli watch\n```\n\n#### Watch your project and show all of the build log\n```\n$ circleci-cli watch -v\n```\n\n#### Show last failed build\n```\n$ circleci-cli build --last\n```\n\n#### Retry last failed build\n```\n$ circleci-cli retry --last\n```\n\n#### Open CircleCI webpage for current project\n```\n$ circleci-cli browse\n```\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/circleci-tools/circleci-cli.\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).\n\n## Contributors ✨\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"http://blog.unhappychoice.com\"\u003e\u003cimg src=\"https://avatars3.githubusercontent.com/u/5608948?v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eYuji Ueki\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/unhappychoice/circleci-cli/commits?author=unhappychoice\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://mattbrictson.com/\"\u003e\u003cimg src=\"https://avatars0.githubusercontent.com/u/189693?v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eMatt Brictson\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/unhappychoice/circleci-cli/commits?author=mattbrictson\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"https://github.com/unhappychoice/circleci-cli/commits?author=mattbrictson\" title=\"Tests\"\u003e⚠️\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"http://fzf.me\"\u003e\u003cimg src=\"https://avatars0.githubusercontent.com/u/1462357?v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eFletcher Fowler\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/unhappychoice/circleci-cli/issues?q=author%3Afzf\" title=\"Bug reports\"\u003e🐛\u003c/a\u003e \u003ca href=\"#ideas-fzf\" title=\"Ideas, Planning, \u0026 Feedback\"\u003e🤔\u003c/a\u003e \u003ca href=\"https://github.com/unhappychoice/circleci-cli/commits?author=fzf\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://datadoghq.com\"\u003e\u003cimg src=\"https://avatars3.githubusercontent.com/u/583503?v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eMarco Costa\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"#ideas-marcotc\" title=\"Ideas, Planning, \u0026 Feedback\"\u003e🤔\u003c/a\u003e \u003ca href=\"https://github.com/unhappychoice/circleci-cli/commits?author=marcotc\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-enable --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n","funding_links":[],"categories":["Ruby"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcircleci-tools%2Fcircleci-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcircleci-tools%2Fcircleci-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcircleci-tools%2Fcircleci-cli/lists"}