Skip to content
This repository has been archived by the owner on Aug 18, 2022. It is now read-only.

Latest commit

 

History

History
57 lines (42 loc) · 1.93 KB

CLI.md

File metadata and controls

57 lines (42 loc) · 1.93 KB

CLI

To use ci-status from the command line, you need to install it globally:

$ npm install -g ci-status

Just want to test the CLI without installing? Use npx like this:

$ npx ci-status <service> ...

Usage

The options you can use in the cli differ per service. Each service is a sub-command of the ci-status tool. To list all options type:

$ ci-status -h

AppVeyor

Short command Full command Description
-o --owner <owner> User account the repositories belong to
-r --repo <repo> The name of the repository your interested in
-h --help Output usage information

AWS Codepipeline

Short command Full command Description
-n --name <name> The name of the pipeline you're interested in
-r --region <region> The AWS region in which your pipeline resides
-h --help Output usage information

Jenkins

Short command Full command Description
-p --project <project> The name of the project your interested in
-r --url <url> The host url to connect to (ex. http://localhost:8080/)
-t --token <token> API token (preferred) / password of the user for authentication
-u --user <user> User account name to connect with
-h --help Output usage information

Travis CI

Short command Full command Description
-b --branch <branch> Show build status for specific branch
-o --owner <owner> User account the repositories belong to
-r --repo <repo> The name of the repository your interested in
-t --token <token> API token (preferred) / password of the user for authentication
-h --help Output usage information