Skip to main content

Getting Started with the CLI

Arbi CLI (short for Arbitrium Command-line interface) is a project manager enabling you to build, push and manage your Arbitrium applications with a simple TOML file. Arbi CLI requires you to have at least an API token created on either staging or console environment.

Requirements#

  1. Docker Engine installed and running
  2. Dockerfile at the root of your project.
  3. An Arbitrium API token
  4. Any container registry with your credentials. If you don't have one check our guide on Harbor

Installation#

Important : The Installation section is prone to changes.

From the SDK & Tools page of the Dashboard, download the right arbi executable from the list.

Windows download#

Operating systemArchLink
Windows x86arbi.exe
Windows x64arbi.exe

Linux download#

Operating systemArchLink
Linuxamd64arbi
Linuxarm64arbi

Other download#

Operating systemArchLink
Darwinamd64arbi
Darwinarm64arbi

Windows#

Use locally#

Move the executable in your project root folder and add to your .gitignore arbi.exe to make sure you don't push the executable to your code version control host (Github, Bitbucket, etc..). You can now open a new Terminal in your project root and start using arbi.exe

Use anywhere (optionnal)#

Add the path to your arbi.exe to your system variable environment variable PATH. The environment variable PATH should have an entry should look like this

C:\PATH\TO\CLI\arbi.exe

For more information on how to add an environment variable to PATH this article can help a lot

Usage#

Depending of your installation process, you can call arbi --help or arbi.exe --help to get the list of commands.

Step 1 init#

First, you notice that you don't have access to all the commands of the CLI. To have all commands, you need to have an arbitrium.toml file in the same folder you are operating. You can use the arbitrium.toml exemple or use init command to have a wizard ask you questions about you application

arbi init

Step 2 build#

The core of the CLI is in the build command. You'll be able with one command to:

  1. Create a new version if the semantic versioning is enabled
  2. Build your docker image locally with the help of your local Docker daemon
  3. Tag you new Docker image with the new version
  4. Test your credentials on the registry
  5. Push your Docker image to your repository defined in the arbitrium.toml with the credentials
  6. Create an application with your API token if you don't have an application with this name
  7. Create an application version with your API token if you don't have a version with this version name or updates existing version.
  8. Shows results from the Arbitrium API
arbi build