Bitrise runner CLI - run your automations on your Mac or Linux machine -
Go Shell
BirmacherAkos and trapacska mutex lock added to the Flush() and Write() methods. (#624)
* - mutex lock have been added to the filterwriter's Flush() method;
- mutex lock have been added to filterwriter's Write() method;
- test cases have been added to the Writer() test: write with multiple gorutine at the same time.

* clean (+1 squashed commit)
Squashed commits:
[ea66323] clean
Latest commit 33761ae Jul 18, 2018
Failed to load latest commit information.
_docs Update (#585) Mar 13, 2018
_examples New trigger (#402) Sep 13, 2016
_lessons New trigger (#402) Sep 13, 2016
_scripts Feature/internal tools handling revision (#374) Jul 26, 2016
_tests v 1.19.0 Jul 12, 2018
bitrise bump min wf editor version (#622) Jul 11, 2018
cli highlight the security warning (#623) Jul 11, 2018
configs secret filtering flag (#596) Apr 27, 2018
models ensitive input validation update (#620) Jul 11, 2018
output godeps update (#370) Jul 12, 2016
plugins filter secrets from log lines (#583) Mar 20, 2018
toolkits Go (toolkit) 1.10.2 (#597) May 8, 2018
tools mutex lock added to the Flush() and Write() methods. (#624) Jul 18, 2018
utils revert include-workflow-metadata & godeps update (#569) Jan 9, 2018
vendor dep update (#621) Jul 11, 2018
version v 1.19.0 Jul 12, 2018
.codeclimate.yml base codeclimate config Oct 2, 2015
.gitignore .DS_Store gitignore Sep 24, 2016 v 1.19.0 Jul 12, 2018
Dockerfile Feature/readme and docker revision (#392) Sep 5, 2016
Gopkg.lock dep update (#621) Jul 11, 2018
Gopkg.toml Git update (#594) Apr 26, 2018
LICENSE Initial commit Jun 27, 2015 v1.14.0 Mar 12, 2018
bitrise.yml prepare for 1.19.0 Jul 12, 2018
deps.go deps.go comment Sep 22, 2015
docker-compose.yml renames, from the old `bitrise-cli` to the new, official `bitrise` to… Aug 5, 2015
gows.yml gows init & go-utils/pathutil fix Jun 15, 2016
main.go init fix Aug 25, 2015
release_config.yml prepare for release Apr 6, 2016

Bitrise (offline) CLI

Discussion forum:

Run your Bitrise automations with this CLI tool on any Mac or Linux machine, and use the same configuration on (automation service, with a mobile app focus).

Part of the Bitrise Continuous Integration, Delivery and Automations Stack, with stepman and envman.

For a nice & quick intro you should check:

Install and Setup

The installation is quick and easy, check the latest release for instructions at:

Installing with Homebrew:

brew update && brew install bitrise

Optionally, you can call bitrise setup to verify that everything what's required for bitrise to run is installed and available, but if you forget to do this it'll be performed the first time you call bitrise run.

You can enable shell completion for the bitrise run command:

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:

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.

This is still work-in-progress, we're working on providing the --format param to every command except run.

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 stepman share and then following the guide it prints.


We added some documents to make it a bit easier to get started with Bitrise CLI. The documentation includes a quick and a little longer guides for CLI, a React Native project workflow guide and an overview of the Step share process. You can find them in the _docs folder.



  • Easy to use: the UX for the end-user, always keep it in mind, make it a pleasant experience to work with this tool (and all of the Bitrise tools)!
  • Code should be kept simple: easy to understand, easy to collaborate/contribute (as much as possible of course).
  • Compatibility: never do an incompatible change, unless you can't avoid it. Release new features as additional options, to not to break existing configurations.
  • Stability: related to compatibility, but in general stability is really important, especially so in a CI/automation environment, where you expect fully reproducible outcomes.
  • Flexibility: should also be kept in mind, but only if it does not affect the previous points.

Updating dependencies

To do a full dependency update use bitrise-tools/gows, for a clean workspace:

gows clear && gows bitrise run dep-update

to test that all dependency is included:

gows clear && gows go test ./... && gows go install && gows bitrise run test

and/or with docker-compose:

docker-compose build && docker-compose run --rm app go test ./...

Release a new version

  1. Update go dependencies (bitrise run dep-update)

  2. PR & merge these changes to the master branch

  3. Release a new versions of bitrise-tools (stepman, envman) [if no changes applied since the previous release, update the go dependencies and release a new version], you can find the dependent tools in ./bitrise/setup.go -> minEnvmanVersion, minStepmanVersion

  4. Release a new versions of default plugins if there are changes, you can find the default plugins in ./bitrise/setup.go -> PluginDependencyMap

  5. Bump bitrise-tools and default plugins versions in ./bitrise/setup.go

  6. PR & merge these changes to the master branch

  7. Bump RELEASE_VERSION (minor, e.g. 1.9.0 -> 1.10.0) in bitrise.yml

  8. Commit (do not push) these changes to the master branch

  9. Run bitrise-run create-release

  10. Fill the current version's Release Notes section in

  11. Update version integration test in ./_tests/integration/version_test.go

  12. Push the changes to the master

  13. Open the project's bitrise app on, find the triggered create-release workflow run's build

  14. Download and test the generated bitrise binaries (version --full and plugins)

  15. Create the new version's release on github:

    • Fill Tag and Version inputs
    • Copy paste the Changelog's Release Notes and Install or upgrade sections to the release description on github
    • Attach the generated (on linux and darwin binaries to the release
    • Push the Publish release button on github