Skip to main content

Running your first local build with the CLI

Abstract

Run a Bitrise build locally with the Bitrise CLI and a bitrise.yml file. To do so, use the bitrise run command once you have the correct YAML configuration.

To run a Bitrise build locally, you only need to:

  1. Install the Bitrise CLI.

  2. A build configuration: that is, a bitrise.yml file.

If you use bitrise.io, you can download your app’s bitrise.yml from there: open the Workflow Editor of the app on bitrise.io, under the bitrise.yml section.

If you want to create a bitrise.yml yourself, simply create a bitrise.yml file in the root of your project. You can use this as the base content of the bitrise.yml:

format_version: 11
default_step_lib_source: https://github.com/bitrise-io/bitrise-steplib.git

app:
  envs:
  - MY_NAME: My Name

workflows:
  test:
    steps:
    - [email protected]:
        inputs:
        - content: echo "Hello ${MY_NAME}!"

This defines an Environment Variable with your name and a Workflow called test. To run this build:

  1. Open the Terminal or some other CLI app.

  2. Go to the directory where you saved the bitrise.yml file.

  3. Run bitrise run with the name of the Workflow you defined in the file.

     bitrise run test

That’s it: your first build is running with the Bitrise CLI.

In this section:

The bitrise.yml file stores your entire build configuration for an app. It specifies your stack and the build triggers, and defines the Workflows of the app. When you make changes on the graphical UI of our Workflow Editor, you actually modify the bitrise.yml file.

The Bitrise Workflow Editor allows you to edit your Workflows, configure Steps, upload files (including code signing files) and manage your app's triggers and stacks on a graphical user interface. It is available both online and offline.

app