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- Docker Engine installed and running
- Dockerfile at the root of your project.
- An Arbitrium API token
- Any container registry with your credentials. If you don't have one check our guide on Harbor
#
InstallationFrom the SDK & Tools page of the Dashboard, download the right arbi executable from the list.
#
Windows downloadOperating system | Arch | Link |
---|---|---|
Windows x86 | arbi.exe | |
Windows x64 | arbi.exe |
#
Linux downloadOperating system | Arch | Link |
---|---|---|
Linux | amd64 | arbi |
Linux | arm64 | arbi |
#
Other downloadOperating system | Arch | Link |
---|---|---|
Darwin | amd64 | arbi |
Darwin | arm64 | arbi |
#
Windows#
Use locallyMove 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
For more information on how to add an environment variable to PATH this article can help a lot
#
UsageDepending of your installation process, you can call arbi --help
or arbi.exe --help
to get the list of commands.
init
#
Step 1 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
build
#
Step 2 The core of the CLI is in the build
command. You'll be able with one command to:
- Create a new version if the semantic versioning is enabled
- Build your docker image locally with the help of your local Docker daemon
- Tag you new Docker image with the new version
- Test your credentials on the registry
- Push your Docker image to your repository defined in the arbitrium.toml with the credentials
- Create an application with your API token if you don't have an application with this name
- Create an application version with your API token if you don't have a version with this version name or updates existing version.
- Shows results from the Arbitrium API