mStudio CLI Alpha Onboarding

[martin-helmich]

Hey all 👋

thanks for testing the new mittwald command-line interface! We highly appreciate your time and effort in helping us improve the CLI tool for a seamless experience and are looking forward to your feedback.

Getting Started

To begin, please make sure you have followed the installation instructions provided below. We want to hear your thoughts on how well the installation and updates work on different platforms. Whether you're on Windows, macOS, or Linux, your feedback on the installation process will help us iron out any platform-specific issues.

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 in 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

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 MITTWALD_API_TOKEN present on your system; you can then pass that environment variable into your container:

$ export MITTWALD_API_TOKEN=<enter token here>
$ docker run --rm -it -e MITTWALD_API_TOKEN mittwald/cli help

Authentication

To use the CLI, you will need an mStudio API token. With your token in your clipboard, run the mw login token command:

$ mw login token
Enter your mStudio API token: ****************
token saved to '/Users/mhelmich/.config/mw/token'

Providing Feedback

We are especially interested in your input on specific commands that are missing for your use cases. As you use the CLI tool, take note of any commands that you feel should be included but are currently still missing. Understanding your needs will enable us to enhance the tool's functionality to better align with your requirements.

We are also interested in feedback on the general user experience of the CLI, for example the general structure of commands, the design of command inputs and the output formats. Of special interest is how the CLI tool performs during non-interactive usage, such as in scripting scenarios. Please experiment with scripting the CLI tool in different contexts and share your observations. Your feedback will help us optimize performance and ensure smooth scripting capabilities.

Issue Tracker and Discussions

For reporting any bugs, suggestions, or general feedback, we encourage you to visit the issue tracker on GitHub. There, you can create new issues to detail your findings, experiences, and thoughts on the CLI tool. It will be easier for us to track, respond, and address each of your inputs efficiently through the issue tracker.

For general, more open-ended discussions, you are also welcome to use the discussion board on GitHub.

Alpha Test Phase Expectations

Please be aware that the CLI tool is in its early development stages, and you may encounter unexpected behavior or issues. Your understanding and feedback during this phase will significantly contribute to the tool's improvement and stability.

Happy testing!