You can install the CLI with a
curl utility script or by downloading the binary from the releases page. Once installed you'll get the
wget https://cli.komiser.io/3.0.7/windows/komiser -O komiser.exe
Mac OS X
For ARM architecture (M1 & M2 Chip)
For AMD architecture (Intel Chip)
Note Make sure to add the execution permission to Komiser
chmod +x komiser.
brew tap tailwarden/komiser
brew install komiser
How to use
Komiser CLI installation
komiser start [command]
config Create configuration file
help Help about any command
start Run Komiser server
version Show tool version
-h, --help help for komiser
Komiser is also available as a Docker image:
Check Docker Hub of the Komiser changelog to find the latest version of Komiser.
Note: From Komiser v3 onwards, we natively support multiple cloud account authentication through the
config.tomlfile, you will need to mount this fill along with a credentials file (not needed is using ENVIRONMENT_VARIABLES as the auth source) to the Docker container using the
-vflags as seen in the
Docker runcommand below.
docker run -v /local/path/to/config.toml:/etc/config/config.toml -v /local/path/to/credentials.yaml:/etc/config/credentials.yaml -d -p 3000:3000 --name komiser tailwarden/komiser:3.0.7 komiser start --config /etc/config/config.toml
Docker installation tutorial
Slack integration (Alerts)
To integrate Komiser with Slack you will have to generate a webhook and add it to the
Find the steps to generate the slack webhook in the official slack documentation here.
Steps to integrate Komiser with Slack:
- Create a Slack app (if you don't have one already)
- Enable Incoming Webhooks
- Create an Incoming Webhook
- Pick a channel that the app will post to, and then click to
Authorize your app
- You'll be sent back to your app settings, and you should now see a new entry under the Webhook URLs for Your Workspace section, with a Webhook URL that'll look something like this
Then simply add the
[slack] block to your
Head over to your cloud provider of choice to learn how to connect your Komiser CLI to your cloud account and to deploy a self hosted version of the tool.