https://github.com/bitrise-io/bitrise
Bitrise runner CLI - run your automations on your Mac or Linux machine -
https://github.com/bitrise-io/bitrise
bitrise cli production-code
Last synced: 23 days ago
JSON representation
Bitrise runner CLI - run your automations on your Mac or Linux machine -
- Host: GitHub
- URL: https://github.com/bitrise-io/bitrise
- Owner: bitrise-io
- License: mit
- Created: 2015-06-27T06:50:32.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-04-12T14:27:29.000Z (about 1 year ago)
- Last Synced: 2024-04-14T15:22:40.850Z (about 1 year ago)
- Topics: bitrise, cli, production-code
- Language: Go
- Homepage: https://www.bitrise.io/cli
- Size: 15.2 MB
- Stars: 825
- Watchers: 35
- Forks: 149
- Open Issues: 40
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome - bitrise - Bitrise runner CLI - run your automations on your Mac or Linux machine - (Go)
- jimsghstars - bitrise-io/bitrise - Bitrise runner CLI - run your automations on your Mac or Linux machine - (Go)
README
# Bitrise CLI
Bitrise CLI is the workflow runner that powers [Bitrise](https://bitrise.io/) 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 validate`)
- run CI workflows locally (`bitrise 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 options to install Bitrise CLI:
- Homebrew: `brew install bitrise`
- Nix: packaged as `bitrise`, run `nix-shell -p bitrise` or your preferred configuration method.
- Download a pre-built binary from the [releases](https://github.com/bitrise-io/bitrise/releases) page
- There might be other [community-maintained packages](https://repology.org/project/bitrise/versions)
You can enable shell completion for the `bitrise run` command: [https://blog.bitrise.io/workflow-id-completion](https://blog.bitrise.io/workflow-id-completion)
### Building from source
First, set up the right Go version indicated by the `go.mod` file.
```sh
go install .
```
## Documentation
CLI documentation is part of the main [Bitrise docs](https://devcenter.bitrise.io). Relevant sections:
- [Workflows and Pipelines](https://devcenter.bitrise.io/en/steps-and-workflows.html)
- [Bitrise CLI local use](https://devcenter.bitrise.io/en/bitrise-cli.html)
## Tutorials and Examples
You can find examples in the [\_examples](https://github.com/bitrise-io/bitrise/tree/master/_examples) folder.
If you're getting started you should start with [\_examples/tutorials](https://github.com/bitrise-io/bitrise/tree/master/_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
## 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 `stepman share` and then following the
guide it prints.