CLI tool

Download the CLI

MacOS/Linux

Install the Wandelbots NOVA CLI tool with homebrew (opens in a new tab).

brew install wandelbotsgmbh/wandelbots/nova

Enabled autocompletion for zsh

echo 'source <(nova completion zsh)' >> ~/.zshrc

Manual Installation

Set up a container registry

To deploy an application you need a container registry that NOVA can pull your app from.
We recommend the official public docker registry for getting started quickly.
You can also use any other OCI registry like privately hosted ones.
When using the public docker registry, create an account here (opens in a new tab) and install the docker desktop application (opens in a new tab).

Continue by signing in to your account by running the following command:

docker login --username MY-DOCKER-USERNAME MY-REGISTRY

MY-REGISTRY will be registry-1.docker.io/MY-DOCKER-USERNAME if you're using the default public docker registry.

You can now build your applications' container image and push it to your registry.

If you are using docker hub and do not want make your image available to the public, switch your docker hub registry to "Make private" in the repository settings.

Next, you need to specify the docker registry where the application will be pushed to:

nova config set image-registry MY-REGISTRY

Setup the CLI

Use the config command to configure the CLI. Set the following parameters:

• URL of the Wandelbots NOVA instance,
• Set the authentication, and
• The OCI registry to which the application will be pushed to. The CLI builds your application as an OCI image and pushes it to the specified registry.

In case you want to deploy your application on an physical instance, you need to indicate its IP, e.g. 192.168.1.100. If you need to deploy your application on a virtual instance, you need to indicate its URL, e.g. my.instance.wandelbots.io.

To tell the Wandelbots NOVA CLI Tool to which instance you want to deploy the application run the following command:

nova config set host 192.168.1.100

Create an application

Now it's time to create your first application!

The CLI will automatically write the required settings in the .env.local file. Use the app command to create either a Python or TypeScript application.

nova app create myapp

This command will create a new directory with the name of your application and the template app for the selected language. You can open the directory in your desired IDE and start developing your application. Or directly deploy it on your instance.

Deploy to instance

And finally, deploy your application. Use the following command in the parent folder of your application:

nova app install <your-nova-app>

The application is now deployed on your cloud instance. The CLI prints out the URL of the application which you can open with your browser. The application is also available on the home screen of the Wandelbots NOVA instance.