unikube

The Unikube CLI provides several command groups to manage all required aspects to develop cloud native software on a Kubernetes-based environment.

There are a couple of shortcut commands directly available from here.

unikube [OPTIONS] COMMAND [ARGS]...

login

Authenticate with a Unikube host. The default login process is a Browser-based method. If you want to login without being redirected to the Browser, you can just specify the parameter -e for email and enable the direct login method. For a non-interactive login, you can provide -p along with the password.

unikube login [OPTIONS]

Options

-e, --email <email>

Authentication email

-p, --password <password>

Authentication password

logout

Log out of a Unikube host.

unikube logout [OPTIONS]

install

Install a deck. For further information please refer to :ref:`

unikube install [OPTIONS] [DECK]

Options

-o, --organization <organization>

Select an organization

-p, --project <project>

Select a project

Arguments

DECK

Optional argument

up

This command starts or resumes a Kubernetes cluster for the specified project. As it is a selection command, the project can be specified and/or filtered in several ways:

  • as a positional argument, id or project title can be specified, or from a set context

  • as an interactive selection from available projects

  • via -o or --organization option, specifying an organisation to which a project belongs

unikube up [OPTIONS] [PROJECT]

Options

-o, --organization <organization>

Select an organization

--ingress <ingress>

Overwrite the ingress port for the project from cluster settings

-p, --provider <provider>

Specify the Kubernetes provider type for this cluster (default uses k3d)

--workers <workers>

Specify count of k3d worker nodes

Arguments

PROJECT

Optional argument

shell

Drop into an interactive shell.

unikube shell [OPTIONS] [APP]

Options

-o, --organization <organization>

Select an organization

-p, --project <project>

Select a project

-d, --deck <deck>

Select a deck

-c, --container <container>

Specify the container in this app

Arguments

APP

Optional argument