ohmyzsh/plugins/circleci/README.md

CircleCi Plugin

This plugin provides easy to use cli commands to query circle ci job statuses

To use it, add circleci to the plugins array in your zshrc file:

plugins=(... circleci)

Prerequisites

You need to have the CIRCLECI_API_TOKEN and CIRCLECI_ORG_SLUG as environment variables before calling the circleci_status function
You can learn how to add a circleci api token here
The org slug takes the format of {vcs}/{org_name}

Usage

> circleci_status

The above command would list down all the jobs (with their run status) on the repository and branch that you are currently on
You can also use the cis alias to run the above function