Skip to Content
SecaniDokumentacja

Secani CLI

Pracuj ze swoim SZBI w Secani w terminalu, w skryptach i z agentów programistycznych.

Secani CLI, czyli secani, przenosi do terminala ryzyka, zadania, ustalenia, środki i incydenty. Ludzie używają jej do szybkiego sprawdzania i zmieniania danych, skrypty powłoki czytają jej wynik w formacie JSON, a agenci programistyczni, tacy jak Claude Code, Codex czy Cursor, mogą pracować z Twoim SZBI bez własnej konfiguracji MCP. Komunikuje się z Secani MCP i ma te same uprawnienia co Twoje konto.

Instalacja

npm install --global secani

Albo uruchom ją bez instalowania:

npx secani login

CLI wymaga Node.js 22.12 lub nowszego oraz konta Secani. Jest open source na licencji Apache-2.0: github.com/secani/cli.

Logowanie

secani login

CLI pokazuje stronę logowania i kod, a następnie otwiera tę stronę w przeglądarce. Zaloguj się kontem Secani i potwierdź kod w ciągu pięciu minut. Przez SSH lub w kontenerze użyj secani login --no-open i otwórz stronę na dowolnym urządzeniu.

Logowanie jest zapisywane tylko dla Twojego użytkownika, w ~/.config/secani/auth.json (katalog zmienisz przez SECANI_CONFIG_DIR), i odnawia się samo. secani whoami pokazuje konto i bieżący obszar roboczy, a secani logout usuwa logowanie z tego komputera.

Połączenie startuje tylko do odczytu. Aby tworzyć lub zmieniać rekordy, zezwól na zapis dla Secani CLI w aplikacji Secani w Ustawienia > Integracje. Na tej samej stronie zakończysz połączenie.

Wybór obszaru roboczego

secani workspaces list
secani workspaces switch acme/isms

Obszary robocze mają nazwy <organizacja>/<obszar>. Użyj --workspace acme/isms lub ustaw SECANI_WORKSPACE, aby wybrać obszar dla pojedynczego polecenia. Jeśli masz tylko jeden, CLI używa go automatycznie.

Polecenia

PolecenieCo robi
secani login, logout, whoamiLogowanie i wylogowanie, konto i bieżący obszar roboczy
secani workspaces list, switchLista obszarów roboczych i wybór bieżącego
secani risks list, inspect, create, update, deleteRejestr ryzyk
secani controls list, inspectŚrodki (zabezpieczenia)
secani findings list, inspectUstalenia z audytów i ocen
secani tasks list, inspect, create, update, archive, restoreZadania
secani incidents list, create, updateIncydenty bezpieczeństwa
secani search <zapytanie>Zasoby, zadania, wymagania i dowody
secani tools list, inspect, callKażde narzędzie Secani MCP

Każde polecenie objaśnia swoje opcje przez --help, a secani help search <słowa> znajduje polecenie do danego zadania. Kilka przykładów:

secani tasks list --assignee me --open
secani risks list --min-level high
secani tasks update TASK-12 --status done
secani incidents create --title "Otwarty e-mail phishingowy" --severity high
secani search backup --framework "ISO 27001"

Polecenia działające w ramach frameworka, takie jak tworzenie ryzyka czy wyszukiwanie wymagań, przyjmują --framework z nazwą lub ID frameworka albo używają jedynego frameworka obszaru roboczego.

Skrypty i agenci programistyczni

  • --json wypisuje dokładnie jeden dokument JSON i nigdy nie zadaje pytań. Listy zwracają rekordy i kursor pagination.next; zmiany zwracają rekord, outcome, na przykład created lub updated, oraz polecenie do jego podglądu.
  • Błędy to pojedyncza linia JSON na stderr ze stałym reason, na przykład login_required lub missing_workspace, oraz status: "action_required", gdy dane wejściowe lub zgoda osoby pozwoliłyby uruchomić polecenie.
  • Przekierowany wynik jest rozdzielony tabulatorami, z wierszem nagłówka i datami ISO. Przekierowana zmiana wypisuje tylko ID rekordu.
  • Agenci programistyczni są rozpoznawani automatycznie: nigdy nie dostają pytań i zawsze podają obszar roboczy przez --workspace lub SECANI_WORKSPACE.
  • Usunięcie ryzyka, archiwizacja zadania i destrukcyjne narzędzia MCP proszą o potwierdzenie. Bez terminala wymagają --yes, które agent powinien dodać dopiero po zgodzie osoby.
  • Każda zmiana ma klucz idempotencji. Jeśli połączenie zerwie się po wysłaniu zmiany, CLI pokaże polecenie, które ją powtórzy z --request-id; Secani zastosuje ją najwyżej raz.
  • --limit to łączna liczba wyników na wszystkich stronach, a --next <kursor> kontynuuje listę z tymi samymi filtrami.

Kody wyjścia: 0 gotowe (także puste wyniki i brak zmian), 1 niepowodzenie, 2 błędne użycie lub brak danych, 130 anulowano.

Zmienne środowiskowe

ZmiennaDziałanie
SECANI_WORKSPACEObszar roboczy dla każdego polecenia; musi zgadzać się z --workspace, jeśli ustawiono oba
SECANI_TOKENToken dostępu do Secani MCP zamiast zapisanego logowania. Tokeny są krótkotrwałe
SECANI_CONFIG_DIRKatalog logowania i ustawień
SECANI_ACCESSIBLE=1Słowa zamiast symboli
SECANI_GUIDANCE_DISABLED=1Bez opcjonalnych kolejnych kroków
NO_COLOR, FORCE_COLORWyłączenie lub wymuszenie kolorów
CIUruchamianie bez pytań

Kod źródłowy i opinie

CLI jest rozwijana otwarcie na github.com/secani/cli i publikowana w npm jako secani. Zgłaszaj błędy i pomysły jako issues na GitHubie, a problemy z bezpieczeństwem poufnie przez zakładkę Security repozytorium.