Skip to Content
SecaniDokumentation

Secani CLI

Arbeite mit deinem Secani-ISMS im Terminal, in Skripten und aus Coding-Agenten.

Die Secani CLI, secani, bringt Risiken, Tasks, Findings, Maßnahmen und Vorfälle ins Terminal. Du nutzt sie für schnelle Abfragen und Änderungen, Shell-Skripte lesen ihre JSON-Ausgabe, und Coding-Agenten wie Claude Code, Codex oder Cursor arbeiten damit an deinem ISMS, ohne eigene MCP-Einrichtung. Sie spricht mit Secani MCP und hat dieselben Berechtigungen wie dein Konto.

Installieren

npm install --global secani

Oder ohne Installation ausführen:

npx secani login

Die CLI braucht Node.js 22.12 oder neuer und ein Secani-Konto. Sie ist Open Source unter der Lizenz Apache-2.0: github.com/secani/cli.

Anmelden

secani login

Die CLI zeigt eine Anmeldeseite und einen Code und öffnet die Seite im Browser. Melde dich mit deinem Secani-Konto an und bestätige den Code innerhalb von fünf Minuten. Über SSH oder in einem Container nutzt du secani login --no-open und öffnest die Seite auf einem beliebigen Gerät.

Die Anmeldung wird nur für deinen Benutzer gespeichert, in ~/.config/secani/auth.json (das Verzeichnis änderst du mit SECANI_CONFIG_DIR), und erneuert sich selbst. secani whoami zeigt das Konto und den aktuellen Workspace, secani logout entfernt die Anmeldung von diesem Computer.

Die Verbindung startet nur lesend. Um Datensätze anzulegen oder zu ändern, erlaube Schreibzugriffe für Secani CLI in der Secani-App unter Einstellungen > Integrationen. Auf derselben Seite beendest du die Verbindung.

Workspace wählen

secani workspaces list
secani workspaces switch acme/isms

Workspaces heißen <organisation>/<workspace>. Mit --workspace acme/isms oder SECANI_WORKSPACE wählst du einen für einzelne Befehle. Gibt es nur einen Workspace, nutzt die CLI ihn automatisch.

Befehle

BefehlWas er tut
secani login, logout, whoamiAn- und abmelden, Konto und aktuellen Workspace anzeigen
secani workspaces list, switchWorkspaces auflisten und den aktuellen wählen
secani risks list, inspect, create, update, deleteDas Risikoregister
secani controls list, inspectMaßnahmen
secani findings list, inspectAudit- und Assessment-Findings
secani tasks list, inspect, create, update, archive, restoreTasks
secani incidents list, create, updateSicherheitsvorfälle
secani search <suche>Assets, Tasks, Anforderungen und Nachweise
secani tools list, inspect, callJedes Tool von Secani MCP

Jeder Befehl erklärt seine Optionen mit --help, und secani help search <wörter> findet den Befehl für eine Aufgabe. Einige Beispiele:

secani tasks list --assignee me --open
secani risks list --min-level high
secani tasks update TASK-12 --status done
secani incidents create --title "Phishing-Mail geöffnet" --severity high
secani search backup --framework "ISO 27001"

Befehle, die in einem Framework arbeiten, etwa ein Risiko anlegen oder Anforderungen suchen, nehmen --framework mit Name oder ID des Frameworks, oder das einzige Framework des Workspace.

Skripte und Coding-Agenten

  • --json gibt genau ein JSON-Dokument aus und stellt nie eine Rückfrage. Listen liefern die Datensätze und einen pagination.next-Cursor; Änderungen liefern den Datensatz, ein outcome wie created oder updated und den Befehl, um ihn anzusehen.
  • Fehler sind eine einzelne JSON-Zeile auf stderr mit einem stabilen reason, zum Beispiel login_required oder missing_workspace, und status: "action_required", wenn eine Eingabe oder die Freigabe einer Person den Befehl ermöglichen würde.
  • Weitergeleitete Ausgabe ist tabulatorgetrennt, mit Kopfzeile und ISO-Zeitangaben. Eine weitergeleitete Änderung gibt nur die ID des Datensatzes aus.
  • Coding-Agenten werden automatisch erkannt: Sie bekommen nie Rückfragen und geben den Workspace immer mit --workspace oder SECANI_WORKSPACE an.
  • Ein Risiko löschen, einen Task archivieren und destruktive MCP-Tools fragen nach Bestätigung. Ohne Terminal brauchen sie --yes, das ein Agent erst nach der Freigabe einer Person ergänzen sollte.
  • Jede Änderung trägt einen Idempotenzschlüssel. Bricht die Verbindung ab, nachdem eine Änderung gesendet wurde, zeigt die CLI den Befehl, um sie mit --request-id zu wiederholen; Secani wendet sie höchstens einmal an.
  • --limit ist die Gesamtzahl der Ergebnisse über alle Seiten, und --next <cursor> setzt eine Liste mit denselben Filtern fort.

Exit-Codes: 0 erledigt (auch leere Ergebnisse und nichts zu tun), 1 fehlgeschlagen, 2 falsche Verwendung oder fehlende Eingabe, 130 abgebrochen.

Umgebungsvariablen

VariableWirkung
SECANI_WORKSPACEWorkspace für jeden Befehl; muss zu --workspace passen, wenn beide gesetzt sind
SECANI_TOKENEin Access Token für Secani MCP statt der gespeicherten Anmeldung. Tokens sind kurzlebig
SECANI_CONFIG_DIRVerzeichnis für Anmeldung und Einstellungen
SECANI_ACCESSIBLE=1Klartext statt Symbolen
SECANI_GUIDANCE_DISABLED=1Keine optionalen nächsten Schritte
NO_COLOR, FORCE_COLORFarbe aus- oder erzwingen
CIOhne Rückfragen ausführen

Quellcode und Feedback

Die CLI wird offen auf github.com/secani/cli entwickelt und auf npm als secani veröffentlicht. Melde Fehler und Ideen als GitHub-Issues und Sicherheitsprobleme vertraulich über den Tab Security des Repositorys.