https://github.com/instantkom/cli-examples
Workflow examples for the instantKOM CLI
https://github.com/instantkom/cli-examples
automation cli examples instantkom messaging shell
Last synced: 15 days ago
JSON representation
Workflow examples for the instantKOM CLI
- Host: GitHub
- URL: https://github.com/instantkom/cli-examples
- Owner: instantKOM
- License: mit
- Created: 2026-05-15T10:30:21.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2026-06-07T18:36:24.000Z (24 days ago)
- Last Synced: 2026-06-07T20:17:11.341Z (24 days ago)
- Topics: automation, cli, examples, instantkom, messaging, shell
- Homepage: https://instantkom.app/de/help/cli
- Size: 5.86 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# instantKOM CLI Cookbook
Praxisnahe Beispiele für `ikm` in Monitoring, Automatisierung und Incident-Workflows.
[](https://instantkom.app/de/help/cli)
[](https://www.npmjs.com/package/@instantkom/cli)
## Installation
```bash
npm install -g @instantkom/cli
ikm --help
```
## Vor dem Ausführen
Setzen Sie die Ziel-API und authentifizieren Sie sich über Umgebungsvariablen oder ein konfiguriertes Profil:
```bash
export IKM_API_URL="https://api.instantkom.app"
export IKM_API_KEY=""
```
Die Beispiele verwenden bewusst Platzhalter. Ersetzen Sie IDs wie `channel_ops` oder `segment_members` durch IDs aus Ihrem eigenen Mandanten.
## Workflow-Beispiele
| Workflow | Datei | Was das Beispiel zeigt |
|----------|------|----------------------|
| Monitoring-Alarm | [`examples/monit-alert.sh`](examples/monit-alert.sh) | Sendet Infrastruktur-Alarme in einen Operations-Kanal und zeigt aktuelle Aktivität. |
| Sentry-Webhook | [`examples/sentry-webhook.sh`](examples/sentry-webhook.sh) | Wandelt einen Sentry-ähnlichen Webhook-Payload in ein Support-Ticket mit hoher Priorität um. |
| Geplanter Newsletter | [`examples/cron-broadcast.sh`](examples/cron-broadcast.sh) | Plant eine regelmäßige Erinnerung an ein Segment. |
| BOS-Eskalation | [`examples/bos-alerting.sh`](examples/bos-alerting.sh) | Sendet operative Eskalationsmeldungen und erstellt ein Tracking-Ticket. |
| KI-Antwortentwurf | [`examples/ai-reply-bot.sh`](examples/ai-reply-bot.sh) | Erstellt einen kurzen KI-Antwortentwurf und sendet ihn optional in einen aktiven Chat. |
## Newsletter-Zielgruppen
Newsletter werden für Kanäle, Kanal/Segment-Kombinationen oder wiederverwendbare Zielgruppen erstellt. Beliebige Empfängerlisten sind hier nicht das Modell. Verwenden Sie:
```bash
ikm broadcast create --target channel_ops:segment_members --text "..."
```
Modellieren Sie Newsletter nicht als `--recipient`, `--recipients` oder `--to`-Aufrufe.
## Beispiel ausführen
```bash
chmod +x examples/monit-alert.sh
IKM_CHANNEL_ID="channel_ops" IKM_RECIPIENT_ID="recipient_ops_room" examples/monit-alert.sh
```
## Source of Truth
Die kanonische Quelle liegt im instantKOM-Monorepo unter `services/cli/cookbook`.
Das öffentliche Repository spiegelt die geprüften Beispiele nach:
https://github.com/instantKOM/cli-examples