← All tools

mittwald/cli

Popularity 75 Updated Development & Build

The mittwald command-line interface

githubauto-collected

Installation

A directly usable install command is not verified yet. Check the project documentation or releases.

<center

mw &mdash; the mittwald command-line tool

</center

Synposis

mw is the command-line tool for interacting with the mittwald mStudio v2 API.

Getting started

Installation

#### macOS, using Homebrew

Installation using Homebrew is the recommended way of installation on macOS.

$ brew tap mittwald/cli
$ brew install mw

#### Windows, using the Installer

Find the appropriate Windows installer from the 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.

#### Any OS, using Node.js+NPM

Installing the CLI via NPM will work on any OS; however we cannot guarantee stability, because functionality of the CLI may depend on the Node.js runtime already installed on your system. Also, the automatic upgrade will not work when using NPM; remember to run npm upgrade -g @mittwald/cli occasionally.

$ npm install -g @mittwald/cli

Attention! When installing via -g flag, make sure you have nodejs = 20.7.0 installed, as package definition is ignored for global installations!

#### Any OS, using Docker

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