Skip to content

jgallantgs/bitrise-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

71 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Bitrise CLI

A command-line utility for interacting with Bitrise, the continuous integration and delivery platform. With this interface, you can trigger builds, check their status, and receive alerts when they complete, along with specific error messages in case of failure. Plus more!

Installation

Run this in your terminal:

cd ~ && sudo rm -rf bitrise-cli &&
git clone git@github.com:jgallantgs/bitrise-cli.git &&
cd bitrise-cli &&
sudo cp -f bitrise.zsh /usr/local/bin/bitrise &&
sudo chmod +x /usr/local/bin/bitrise

(Or wrap the .zsh file in a function and put it in your .zshrc)

Auth/Preferences

The following preferences can be set within the settings.cfg file.

No quotes are needed, unless your strings contain spaces.

(Ex: BITRISE_APP_SLUG=2j1k3h1289aslkdj)

  • BITRISE_API_TOKEN - Your api token for bitrise. Can be obtained from post request when triggering a build on the web client. Token doesn't expire.

  • BITRISE_APP_SLUG - Your token for the bitrise app

  • NIGHTLY_WORKFLOW_ID - The ID of the workflow to use for nightly builds.

  • QA_BUILD_WORKFLOW_ID - The ID of the workflow to use for QA builds.

  • MONITOR_SLEEP - The number of seconds to wait between monitoring checks.

  • LIMIT - The maximum number of builds to retrieve in the get and list commands.

  • DEFAULT_BRANCH - The default branch to use if no branch is specified.

Example Usage

Building

  • $ bitrise - Trigger a nightly build for $DEFAULT_BRANCH

  • $ bitrise -nightly - Trigger a nightly build for the current branch

  • $ bitrise -nightly feature/new-feature - Trigger a nightly build for a specific branch

  • $ bitrise -qa - Trigger a QA build for the current branch

  • $ bitrise -qa feature/new-feature - Trigger a qa build for a specific branch

Working with Existing Builds

  • $ bitrise -list - List the last few builds based on $LIMIT

  • $ bitrise -stop 123456 - Stop a build by build number

  • $ bitrise -status 123456 - Check the status of a build by build number

  • $ bitrise -alert 123456 - Monitor a build by build number

Other

  • $ bitrise -h - Display the help message

  • $ bitrise -reset - Deletes the config file

About

CLI tool for Bitrise

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages