Documentation Table of Contents

2. Command Line Interface (CLI)

2.1 Installing the Build CLI

The preferred way of installing the CLI is to use the Crystal version (the ruby gem is no longer being updated).

2.1.1 Mac

You can install with Homebrew:

$ brew install buildio/cli/bld

2.1.2 Linux

Homebrew

You can install with Homebrew even on Linux.

For Ubuntu, first install this dependency:

$ apt install libpcre3-dev

$ brew install buildio/cli/bld

Manual Install

Install Crystal (lang) and Shards (package manager) using the package manager of the distribution that you are using.

Fedora/RHEL/CentOS

For Fedora, you can use dnf:

$ sudo dnf install crystal

$ sudo dnf install libssh2-devel

Ubuntu/Debian

For Ubuntu, you can use apt:

$ sudo apt install crystal

$ sudo dnf install shards

Generic Linux Install

There is also a generic Linux install that will figure out your package manager for you.

You'll need crystal 1.16. Available from the PPA:
 https://crystal-lang.org/install/

If you inspect the script first:
 https://crystal-lang.org/install.sh

Then this adds to your sources:
$ curl -fsSL https://crystal-lang.org/install.sh | sudo bash

2.1.3 Build the CLI

Once you have Crystal installed, you can downloaded the Crystal CLI directly from the (public) GitHub account with:

$ git clone git@github.com:buildio/cli.git

$ cd cli/ && shards build

2.2 Authentication and login

Not written yet.

This section hasn't been written yet. If this is blocking you, let us know at support@build.io and we'll prioritize it.

2.3 Command reference

Not written yet.

This section hasn't been written yet. If this is blocking you, let us know at support@build.io and we'll prioritize it.

2.4 Configuration and profiles

Not written yet.

This section hasn't been written yet. If this is blocking you, let us know at support@build.io and we'll prioritize it.