# circle-cli

> circle-ci cli

Latest version **1.1.2** (published 2017-03-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install circle-cli
pnpm add circle-cli
yarn add circle-cli
bun add circle-cli
```

Provides the command `circle-cli`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.2 |
| Published | 2017-03-30 |
| First published | 2016-11-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Known vulnerabilities | 0 (+3 in 2 direct dependencies) |
| Install scripts | no |
| Author | maskzh |
| Maintainers | maskzh |

## Links

- npm: https://www.npmjs.com/package/circle-cli
- npm.io page: https://npm.io/package/circle-cli

## Dependencies (5)

- [yargs](https://npm.io/package/yargs.md) ^6.4.0
- [colors](https://npm.io/package/colors.md) ^1.1.2
- [shelljs](https://npm.io/package/shelljs.md) ^0.7.5
- [easy-table](https://npm.io/package/easy-table.md) ^1.0.0
- [node-fetch](https://npm.io/package/node-fetch.md) ^1.6.3

## Recent versions

- 1.1.2 (latest) — 2017-03-30
- 1.1.1 — 2016-12-02
- 1.1.0 — 2016-11-30
- 1.0.9 — 2016-11-29
- 1.0.8 — 2016-11-29
- 1.0.7 — 2016-11-29
- 1.0.6 — 2016-11-28
- 1.0.5 — 2016-11-28
- 1.0.4 — 2016-11-28
- 1.0.3 — 2016-11-28
- 1.0.2 — 2016-11-28
- 1.0.1 — 2016-11-26
- 1.0.0 — 2016-11-26

## README

# circle-cli [![npm version](https://img.shields.io/npm/v/circle-cli.svg)](https://www.npmjs.org/package/circle-cli)

A CircleCI CLI via node

## Install
```shell
npm i circle-cli -g
```

## Configuration
```shell
export CIRCLE_TOKEN='your circleci token'
export CIRCLE_VCS_TYPE='github'
export CIRCLE_USERNAME='maskzh'
```
add these to `.bashrc` or `.zshrc`

## Usage
```
circle-cli ls # 最近 build 记录

circle-cli projects # 列出项目
circle-cli projects -v # 列出项目及分支

circle-cli show      # 最近一条 build 记录的构建详情
circle-cli artifacts # 最近一条 build 记录的 artifacts
circle-cli cancel    # 取消最近一条 build
circle-cli retry     # rebuild 最近一条 build

circle-cli project -p reponame           # reponame 的 build 记录
circle-cli project -p reponame -n 199    # reponame 序号为 199 的 build 详情
circle-cli project -p reponame -n 199 -a # reponame 序号为 199 的 artifacts
circle-cli project -p reponame -n 199 -c # 取消 reponame 序号为 199 的 build
circle-cli project -p reponame -n 199 -r # rebuild reponame 序号为 199 的 build
```

## Preview
![](./screenshot.png)

---
_Source: https://npm.io/package/circle-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._