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.

auth — Manage the Bitrise access token

build — Trigger, list, and inspect builds.

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

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

plugin — Plugin handling.

rde — Manage Bitrise Remote Dev Environments (sessions, templates, …)

stack — Manage build stacks.

step — Manage steps.

user — Create and manage your Bitrise account.

yml — Work with bitrise.yml files.

Other commands

Tooling support & JSON output format

bitrise CLI commands support a --format=[format] parameter. This is intended mainly for tooling support, by adding --format=json you'll get a JSON formatted output on Standard Output.

Every error, warning etc. message will go to StdErr; and on the StdOut you should only get the valid JSON output.

An example calling the version command:

$ bitrise version --format=json

Will print {"version":"1.2.4"} to the Standard Output (StdOut).

Share your Step

You can use your own Step as you can see in the _examples, even if it's not yet committed into a repository, or from a repository directly.

If you would like to share your awesome Step with others you can do so by calling bitrise step share and then following the guide it prints.