{"id":50921882,"url":"https://github.com/instantkom/cli-examples","last_synced_at":"2026-06-16T19:01:11.157Z","repository":{"id":363179349,"uuid":"1239679550","full_name":"instantKOM/cli-examples","owner":"instantKOM","description":"Workflow examples for the instantKOM CLI","archived":false,"fork":false,"pushed_at":"2026-06-07T18:36:24.000Z","size":6,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-06-07T20:17:11.341Z","etag":null,"topics":["automation","cli","examples","instantkom","messaging","shell"],"latest_commit_sha":null,"homepage":"https://instantkom.app/de/help/cli","language":null,"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/instantKOM.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-05-15T10:30:21.000Z","updated_at":"2026-06-07T18:36:28.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/instantKOM/cli-examples","commit_stats":null,"previous_names":["instantkom/cli-examples"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/instantKOM/cli-examples","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/instantKOM%2Fcli-examples","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/instantKOM%2Fcli-examples/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/instantKOM%2Fcli-examples/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/instantKOM%2Fcli-examples/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/instantKOM","download_url":"https://codeload.github.com/instantKOM/cli-examples/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/instantKOM%2Fcli-examples/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34419350,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-16T02:00:06.860Z","response_time":126,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["automation","cli","examples","instantkom","messaging","shell"],"created_at":"2026-06-16T19:01:09.633Z","updated_at":"2026-06-16T19:01:11.135Z","avatar_url":"https://github.com/instantKOM.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# instantKOM CLI Cookbook\n\nPraxisnahe Beispiele für `ikm` in Monitoring, Automatisierung und Incident-Workflows.\n\n[![CLI-Dokumentation](https://img.shields.io/badge/CLI%20Doku-instantKOM-blue)](https://instantkom.app/de/help/cli)\n[![npm-Paket](https://img.shields.io/badge/npm-%40instantkom%2Fcli-red)](https://www.npmjs.com/package/@instantkom/cli)\n\n## Installation\n\n```bash\nnpm install -g @instantkom/cli\nikm --help\n```\n\n## Vor dem Ausführen\n\nSetzen Sie die Ziel-API und authentifizieren Sie sich über Umgebungsvariablen oder ein konfiguriertes Profil:\n\n```bash\nexport IKM_API_URL=\"https://api.instantkom.app\"\nexport IKM_API_KEY=\"\u003cscoped-api-token\u003e\"\n```\n\nDie Beispiele verwenden bewusst Platzhalter. Ersetzen Sie IDs wie `channel_ops` oder `segment_members` durch IDs aus Ihrem eigenen Mandanten.\n\n## Workflow-Beispiele\n\n| Workflow | Datei | Was das Beispiel zeigt |\n|----------|------|----------------------|\n| Monitoring-Alarm | [`examples/monit-alert.sh`](examples/monit-alert.sh) | Sendet Infrastruktur-Alarme in einen Operations-Kanal und zeigt aktuelle Aktivität. |\n| 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. |\n| Geplanter Newsletter | [`examples/cron-broadcast.sh`](examples/cron-broadcast.sh) | Plant eine regelmäßige Erinnerung an ein Segment. |\n| BOS-Eskalation | [`examples/bos-alerting.sh`](examples/bos-alerting.sh) | Sendet operative Eskalationsmeldungen und erstellt ein Tracking-Ticket. |\n| 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. |\n\n## Newsletter-Zielgruppen\n\nNewsletter werden für Kanäle, Kanal/Segment-Kombinationen oder wiederverwendbare Zielgruppen erstellt. Beliebige Empfängerlisten sind hier nicht das Modell. Verwenden Sie:\n\n```bash\nikm broadcast create --target channel_ops:segment_members --text \"...\"\n```\n\nModellieren Sie Newsletter nicht als `--recipient`, `--recipients` oder `--to`-Aufrufe.\n\n## Beispiel ausführen\n\n```bash\nchmod +x examples/monit-alert.sh\nIKM_CHANNEL_ID=\"channel_ops\" IKM_RECIPIENT_ID=\"recipient_ops_room\" examples/monit-alert.sh\n```\n\n## Source of Truth\n\nDie kanonische Quelle liegt im instantKOM-Monorepo unter `services/cli/cookbook`.\nDas öffentliche Repository spiegelt die geprüften Beispiele nach:\n\nhttps://github.com/instantKOM/cli-examples\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finstantkom%2Fcli-examples","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finstantkom%2Fcli-examples","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finstantkom%2Fcli-examples/lists"}