Helper scripts to interact with the Mahlkönig API. The CLI allows one to perform tasks on the API without using the web interface.
The development of this client was kindly supported by Hemro International AG. This module is an official product and the development happens independently. API breaking may happen at any given time.
It's required to set up your user upfront using the API client. Use the admin interface or mobile app to register yourself.
Clone the repository:
$ git clone https://github.com/audius/mahlkoenigInstall the module:
$ poetry installUse --help to get a general overview or COMMAND --help for the detailed help.
$ mahlkoenig --help
mahlkoenig --help
Usage: mahlkoenig [OPTIONS] COMMAND [ARGS]...
╭─ Options ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ * --user-name TEXT User name for the Mahlkönig interface [env var: USER_NAME] [default: None] [required] │
│ * --password TEXT Password for Mahlkönig interface [env var: PASSWORD] [default: None] [required] │
│ * --url TEXT URL to Mahlkönig API [env var: URL] [default: None] [required] │
│ --install-completion Install completion for the current shell. │
│ --show-completion Show completion for the current shell, to copy it or customize the installation. │
│ --help Show this message and exit. │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ company │
│ info │
│ region │
│ regions │
│ store │
│ stores │
│ user │
│ users │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯If you don't want to enter the username, the password and the URL then put them in the environment of your shell.
$ export USERNAME="your.username@example.com"
$ export PASSWORD="your_password"
$ export URL="https://mahlkoenig.com/"or create a Nix shell (see default.nix for details).
mahlkoenig is licensed under MIT, for more details check the LICENSE file.