{"id":26246408,"url":"https://github.com/mittwald/cli","last_synced_at":"2026-03-12T15:07:16.333Z","repository":{"id":184381080,"uuid":"664499976","full_name":"mittwald/cli","owner":"mittwald","description":"The mittwald command-line interface","archived":false,"fork":false,"pushed_at":"2025-04-22T11:35:45.000Z","size":449325,"stargazers_count":7,"open_issues_count":22,"forks_count":0,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-22T12:44:26.453Z","etag":null,"topics":["cli","hacktoberfest"],"latest_commit_sha":null,"homepage":"https://developer.mittwald.de/cli","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mittwald.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-07-10T05:53:17.000Z","updated_at":"2025-04-22T11:34:21.000Z","dependencies_parsed_at":"2023-12-20T15:14:02.655Z","dependency_job_id":"cbf5a0ce-7e41-4efc-9c04-af110fd2d83d","html_url":"https://github.com/mittwald/cli","commit_stats":null,"previous_names":["mittwald/cli"],"tags_count":63,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mittwald%2Fcli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mittwald%2Fcli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mittwald%2Fcli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mittwald%2Fcli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mittwald","download_url":"https://codeload.github.com/mittwald/cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250508534,"owners_count":21442246,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","hacktoberfest"],"created_at":"2025-03-13T13:18:26.493Z","updated_at":"2026-02-17T15:03:36.041Z","avatar_url":"https://github.com/mittwald.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ccenter\u003e\n\n# `mw` \u0026mdash; the mittwald command-line tool\n\n![](docs/demo.png)\n\n\u003c/center\u003e\n\n## Synposis\n\n`mw` is the command-line tool for interacting with the mittwald mStudio v2 API.\n\n## Getting started\n\n### Installation\n\n#### macOS, using Homebrew\n\nInstallation using [Homebrew](https://brew.sh/) is the recommended way of\ninstallation on macOS.\n\n```shell\n$ brew tap mittwald/cli\n$ brew install mw\n```\n\n#### Windows, using the Installer\n\nFind the appropriate Windows installer from the\n[releases page](https://github.com/mittwald/cli/releases) and run the installer.\nAfter running the installer, you should be able to use the `mw` command on\neither the CMD prompt or PowerShell.\n\n#### Any OS, using Node.js+NPM\n\nInstalling the CLI via NPM will work on any OS; however we cannot guarantee\nstability, because functionality of the CLI may depend on the Node.js runtime\nalready installed on your system. Also, the automatic upgrade will not work when\nusing NPM; remember to run `npm upgrade -g @mittwald/cli` occasionally.\n\n```shell\n$ npm install -g @mittwald/cli\n```\n\nAttention! When installing via `-g` flag, make sure you have nodejs \u003e= 20.7.0\ninstalled, as package definition is ignored for global installations!\n\n#### Any OS, using Docker\n\nThere is also the\n[`mittwald/cli` Docker image](https://hub.docker.com/r/mittwald/cli) that you\ncan use instead of installing the CLI on your system. In case of the Docker\ncontainer, authentication works a bit differently than described below: Make\nsure that there is an environment variable `MITTWALD_API_TOKEN` present on your\nsystem; you can then pass that environment variable into your container:\n\n```shell\n$ export MITTWALD_API_TOKEN=\u003center token here\u003e\n$ docker run --rm -it -e MITTWALD_API_TOKEN mittwald/cli help\n```\n\n### Authentication\n\nTo use the CLI, you will need an\n[mStudio API token](https://studio.mittwald.de/app/profile/api-tokens). With\nyour token in your clipboard, run the `mw login token` command:\n\n```shell\n$ mw login token\nEnter your mStudio API token: ****************\ntoken saved to '/Users/mhelmich/.config/mw/token'\n```\n\n### Setting up shell autocompletion\n\nThe `mw` CLI offers a lot of commands and flags, and it can be hard to remember\nall of them. To make your life easier, the CLI offers autocompletion for the\nBash and ZSH shells. To enable autocompletion, run the following command:\n\n```shell\n$ mw autocomplete\n```\n\nAfter that, follow the instructions printed by that command (those are specific\nto your shell -- Bash, ZSH and Powershell are supported).\n\n## Contributing\n\nIf you are a developer (either at @mittwald or an external contributor) and want\nto contribute to the CLI, please refer to the [CONTRIBUTING.md](CONTRIBUTING.md)\ndocument.\n\n## Usage\n\n```sh-session\n$ npm install -g @mittwald/cli\n$ mw COMMAND\nrunning command...\n$ mw (--version)\n@mittwald/cli/1.0.0 darwin-arm64 node-v18.11.0\n$ mw --help [COMMAND]\nUSAGE\n  $ mw COMMAND\n...\n```\n\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- commands --\u003e\n# Command Topics\n\n* [`mw app`](docs/app.md) - Manage apps, and app installations in your projects\n* [`mw autocomplete`](docs/autocomplete.md) - Display autocomplete installation instructions.\n* [`mw backup`](docs/backup.md) - Manage backups of your projects\n* [`mw container`](docs/container.md) - Manage containers\n* [`mw context`](docs/context.md) - Save certain environment parameters for later use\n* [`mw conversation`](docs/conversation.md) - Manage your support cases\n* [`mw cronjob`](docs/cronjob.md) - Manage cronjobs of your projects\n* [`mw database`](docs/database.md) - Manage databases (like MySQL and Redis) in your projects\n* [`mw ddev`](docs/ddev.md) - Integrate your mittwald projects with DDEV\n* [`mw domain`](docs/domain.md) - Manage domains, virtual hosts and DNS settings in your projects\n* [`mw extension`](docs/extension.md) - Install and manage extensions in your organisations and projects\n* [`mw help`](docs/help.md) - Display help for mw.\n* [`mw login`](docs/login.md) - Manage your client authentication\n* [`mw mail`](docs/mail.md) - Manage mailboxes and mail addresses in your projects\n* [`mw org`](docs/org.md) - Manage your organizations, and also any kinds of user memberships concerning these organizations.\n* [`mw project`](docs/project.md) - Manage your projects, and also any kinds of user memberships concerning these projects.\n* [`mw registry`](docs/registry.md) - Manage container registries\n* [`mw server`](docs/server.md) - Manage your servers\n* [`mw sftp-user`](docs/sftp-user.md) - Manage SFTP users of your projects\n* [`mw ssh-user`](docs/ssh-user.md) - Manage SSH users of your projects\n* [`mw stack`](docs/stack.md) - Manage container stacks\n* [`mw update`](docs/update.md) - update the mw CLI\n* [`mw user`](docs/user.md) - Manage your own user account\n* [`mw volume`](docs/volume.md) - Manage volumes\n\n\u003c!-- commandsstop --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmittwald%2Fcli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmittwald%2Fcli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmittwald%2Fcli/lists"}