Bitrise CLI

Bitrise CLI is the workflow runner that powers Bitrise builds. It's the component that runs inside build machines and execute steps defined in bitrise.yml.

It's also useful as a standalone dev tool in your local environment. You can:

• quickly validate your bitrise.yml changes before pushing a commit (bitrise yml validate)
• run CI workflows locally (bitrise local run workflow_name)
• run the workflow editor in localhost and edit your configs and pipelines visually (bitrise :workflow-editor)
• perform various other tasks (for a full list run bitrise help)

Install

There are multiple ways to install Bitrise CLI:

• Homebrew: brew install bitrise
• Nix: available as bitrise in nixpkgs, run nix-shell -p bitrise or your preferred configuration method.
• Download a pre-built binary from the releases page
• There might be other community-maintained packages

You can enable shell completion for the bitrise local run command: https://blog.bitrise.io/workflow-id-completion

Building from source

Set up the right Go version indicated by the go.mod file, then run go install .

Documentation

CLI documentation is part of the main Bitrise docs. Relevant sections:

• Workflows and Pipelines
• Bitrise CLI local use

Tutorials and Examples

You can find examples in the _examples folder.

If you're getting started you should start with _examples/tutorials, this should guide you through the basics, while you'll already use bitrise (requires installed bitrise).

You can find a complete iOS sample project at: https://github.com/bitrise-io/sample-apps-ios-with-bitrise-yml

Commands

app — List, inspect, and manage apps.

Command	Description
app create	Register a new app on Bitrise
app list	List apps the authenticated user can access
app view	Show details of a single app

auth — Manage the Bitrise access token

Command	Description
auth login	Save a Bitrise access token
auth logout	Remove the saved access token
auth status	Show whether an access token is configured and where it came from

build — Trigger, list, and inspect builds.

Command	Description
build abort	Abort a running or queued build
build list	List builds for an app
build log	Print the build log
build rebuild	Start a new build with the parameters of a finished build
build steps	List a build's steps with their status and failure or skip reasons
build trigger	Start a new build
build view	Show details of a single build
build watch	Stream logs for a running build
build yml	Print the bitrise.yml a specific build ran with

config — Manage CLI configuration (defaults persisted to a YAML file).

Command	Description
config get	Print the value of a single config key
config list	List the values currently saved in the global config file
config path	Print the absolute path of the global config file
config set	Set a config key and save the global config file
config unset	Remove a config key and save the global config file

local — Run and manage Bitrise workflows on the local host.

Command	Description
local init	Init bitrise config.
local run	Runs a specified Workflow.
local setup	Setup the current host. Install every required tool to run Workflows.
local tools catalog	List officially supported tools
local tools info	Show information about installed or active tools.
local tools install	Install a specific tool version
local tools latest	Query the latest version of a tool
local tools setup	Install tools from version files or bitrise.yml
local tools versions	List available versions for a supported tool
local workflows	List of available workflows in config.

This is the beginning of the README. Read the rest at the original. Read the full README ↗