Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/keith/circle-cli
A CLI for interacting with CircleCI
https://github.com/keith/circle-cli
circleci command-line
Last synced: 16 days ago
JSON representation
A CLI for interacting with CircleCI
- Host: GitHub
- URL: https://github.com/keith/circle-cli
- Owner: keith
- License: mit
- Created: 2016-11-20T03:18:55.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-07-08T18:18:37.000Z (4 months ago)
- Last Synced: 2024-10-12T06:08:17.448Z (about 1 month ago)
- Topics: circleci, command-line
- Language: Python
- Homepage:
- Size: 45.9 KB
- Stars: 11
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# circle-cli
These are a set of tools for interacting with
[CircleCI](https://circleci.com).
## Installation
```sh
$ brew install keith/formulae/circle-cli
```
## Authentication
Add a Circle [API token](https://circleci.com/account/api) to your
`~/.netrc` file. The format looks like this:
```
machine circleci.com
password YOUR_TOKEN
```
## Usage
This repo has a collection of commands for different uses. Here's the
basic use of each of them. Use `circle COMMAND --help` to see all
available options.
### `artifacts`
Download the artifacts from a specific build number:
```sh
$ circle artifacts --repo keith/circle-cli --number 42
```
### `builds`
List the builds for a repo:
```sh
$ circle builds --repo keith/circle-cli --all --count 5
```
Or for a specific branch:
```sh
$ circle builds --repo keith/circle-cli --branch master
```
### `cancel`
Cancel a specific build (`--repo` can be omitted if your current
directory has remote set):
```sh
$ circle cancel --number 42
```
### `cancel-all`
Cancel all builds on the project:
```sh
$ circle cancel-all
```
Cancel all builds for a specific branch:
```sh
$ circle cancel-all -b master
```
### `clear-cache`
Clear your project's build cache:
```sh
$ circle clear-cache -r keith/circle-cli
```
### `open`
Open the Circle web interface for the project:
```sh
$ circle open
```
Or for a specific branch:
```sh
$ circle open master
```
Or a specific build:
```sh
$ circle open 42
```
### `rebuild`
Restart a circle build:
```sh
$ circle rebuild --number 42
```
Restart a build without cache:
```sh
$ circle rebuild --repo keith/circle-cli --number 42 --no-cache
```
### `watch`
Watch a running build a get notified of its output:
```sh
$ circle watch -n 42
```
Or for the newest build running on a branch:
```sh
$ circle watch -b master
```
### `whoami`
Get current info about your logged in user:
```sh
$ circle whoami
```