Skip to main content

Arbitrium CLI commands

List of global commands#

The global commands are the commands that you can always use of the CLI without any options.

version, -v Display CLI Version
help, h Shows a list of commands or help for one command
init, i Init the current folder if arbitrium.toml is not present

List of global flags#

--token value, -t value Api token for interaction with Arbitrium API. This flag will replace the Project.ApiToken in your arbitrium.toml for this command only.
--help, -h show help for a command

List of arbi commands#

config, c Shows the current configuration of your TOML
build, b Run the Docker Build command, push to Registry and create App Version in Arbitrium
info Print info about current App Version
patch Update the App Version in Arbitrium without Building Docker again
delete Delete the Current App Version in Arbitrium.
validate Confirm the current App Version is matching the Registry and the Arbitrium Version
versions, ls-versions List Versions on Arbitrium
deploy Create a simple deployment with the current version
deployments List Deployment of the Current Version
version, v Display CLI Version
help, h Shows a list of commands or help for one command

Command descriptions#

init command#

The init command is used to initialize an arbitrium.toml file with everything you need to build, push, and create an application on the Arbitrium API. This command will create a TOML file in the current working directory or overwrite yours if there is already one. A wizard will ask multiple question about your application, docker credentials and API token. Values in parentheses are default value and you can press enter to use that value.

arbi init

config command#

The config command displays your current arbitrium.toml file.

Important : Beware that calling this function in a CI/CD pipeline can expose critical information about your API token, Docker credentials and secret environment variables. Should only be used locally.
config Usage#
arbi config

build command#

With the current config, the build command will try, in order, 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
build Usage#

When semantic versioning is enabled:

arbi build --updateType p

When semantic versioning is disabled:

arbi build --tag v123

build Flags#

API token and Docker credentials required

--updateType value, -u value If semantic versioning is enabled, it will build the next tag based on the following options [M]ajor, [m]inor or [p]atch.

--tag value, -t value Required when semantic versioning is not enabled. Builds an image with the tag name. This option overwrites the "updateType" option. Example: "myapp:v1.0.0"

info command#

API token required

The info command displays (with the field Version.Name in the TOML) your current app version from the API.

info Flags#
  • --version value, -v value If used, it will get the specified version from the API
info Usage#
arbi info --version v1.0.0

patch command#

API token required

The patch command will send a request to Arbitrium API to update your application based on the current arbitrium.toml. This will not recreate a build and will not update your versioning. Shows the result from the API.

patch Usage#
arbi patch

delete command#

API token required

The delete command will send a request to the Arbitrium API to delete your application version based on the current Version.Name in your arbitrium.toml, unless you are using the --all flag.

delete Flags#
  • --all, -a This flag will delete all application versions and the version of this application. (default: false)
  • --yes, -y Use with precaution, the yes flag will not ask the user inputs. (default: false)
  • --version value, -v value If used, it will delete the specified app version from the API
delete Usage#

Deletes the application and all its app versions.

arbi delete --all

Deletes the current application version without user input.

arbi delete --yes

Deletes the specified application version (v1.0.0) without user input.

arbi delete --all --version v1.0.0

validate command#

API token required

The validate command will check if the current application version of your arbitrium.toml is the same as the one in the Arbitrium API, and print any differences.

validate Usage#
arbi validate

versions command#

API token required

The versions command will list all your applications and your app versions.

versions Usage#
arbi versions

deploy command#

API token required

The deploy command will deploy a deployment with your current app version defined in the arbitrium.toml.

deploy Flags#
  • --version value, -v value If used, it will deploy the specified version of your app
deploy Usage#
arbi deploy

If you want to deploy a specific version

arbi deploy --version v1.0.0

deployments command#

API token required

The deployments command will list all your deployments.

deployments Usage#
arbi deployments