📦 BuildRelease Command Line Interface (CLI)

The BuildRelease CLI is a tool to interact with buildrelease.io's services.

Installation

To be able to use the CLI you must have Node.js version 14 or higher installed.

To install run:

  npm i -g @buildrelease/cli

Authentication

To authenticate with the CLI there are two main methods.

1. Via the Login command

To login via the login command simply run:

buildrelease login

This will open the browser to buildrelease.io and prompt you with a key that you can paste into the cli to authenticate.

2. Via a Project API key

To authenticate with an API key, simple open up your project settings on buildrelease.io, generate a new api key and then pass the api key as an argument to the commands that require authentication. For example

buildrelease build . -k <YOUR_API_KEY>

An api key is generated on a project by project basis so for each project you want to build you will have to generate a new one. expr