Installing the mittwald CLI

On macOS

On macOS, the recommended way of installing the CLI is using Homebrew:

$ brew tap mittwald/cli
$ brew install mw
$ mw --help

You can also use Homebrew to upgrade the CLI:

$ brew upgrade mw

Read how to install or update autocompletions.

On Windows

Retrieve the latest release package (*.exe file) from our releases page, and run the installer. After running the installer, you should be able to use the mw command on either the CMD prompt or PowerShell.

Read how to install or update autocompletions.

On Linux

Currently, we do not provide a package for Linux distributions. However, you can use the NPM installation method, or run the CLI using Docker.

On any operating system

Using NPM

With a local Node.js installation, you can install the mittwald CLI using NPM:

$ npm install -g @mittwald/cli
$ mw --help

Using Docker

If you have Docker installed on your system, you can use the mittwald/cli Docker image instead of installing the CLI on your system. In case of the Docker container, authentication works a bit differently: Make sure that there is an environment variable MITTWALD_API_TOKEN present on your system; you can then pass that environment variable into your container:

$ export MITTWALD_API_TOKEN=xxx
$ docker run \
    --rm \
    -it \
    -e MITTWALD_API_TOKEN \
    mittwald/cli --help

Autocompletion

We provide autocompletion for the mw CLI. To enable it, run the following command and follow the printed instructions:

$ mw autocomplete

After updating the CLI run mw autocomplete --refresh-cache and open a new shell context to load the new autocompletion.

On macOS​

On Windows​

On Linux​

On any operating system​

Using NPM​

Using Docker​

Autocompletion​