Dokumentacja okKoala ►
Przykłady kodu ►
Uruchamianie okKoala w konsoli

Ten artykuł ma 380 słów.

Uruchamianie okKoala w konsoli

Wprowadzenie

okKoala CLI (Command-Line-Interface) pozwala wykonywać dokładnie te same czynności, na które pozwalają aplikacje webowe dostępne pod adresem https://okkola.com. Jego zaletą jest to, że łatwo jest tworzyć automatyzacje procesów wg własnego uznania. Jest zbudowany na Node.js, a ponieważ JavaScript jest językiem niekompilowanym - skryptowym - można zobaczyć kod źródłowy zanim zainstaluje się CLI w systemie. Kod źródłowy jest dostępny na https://github.com/okkoala/cli.

Skąd mam wiedzieć, czy potrzebuję okkoala CLI?

Jeśli na co dzień pracujesz w konsoli i chcesz automatyzować pracę z koalą na kontach wielu firm, to okKoala CLI może pomóc. Jeśli jesteś entuzjastą filozofii Unixa, z pewnością znajdziesz coś dla siebie. okKoala CLI pomoże, kiedy jesteś odpowiedzialny za cyberbezpieczeństwo jako podwykonawca w wielu firmach, a okKoala to Twoje codzienne narzędzie pracy. Używanie CLI do pracy z firmą poniżej <100 użytkowników najprawdopodobniej nie ma wielkiego sensu.

Wymagania systemowe

okKoala CLI działa niezależnie od systemu operacyjnego. Wymogiem jest posiadanie folderu użytkownika oraz dowolnego interpretatora powłoki: sh, powershell, bash, zsh etc. Uruchomienie w trybie administratora nie jest zalecane, może skończyć się błędem.

Instalacja

Proces instalacji:

  1. Zainstaluj Node.js. Stan instalacji możesz sprawdzić poprzez komendę: node –version
  2. Zainstaluj okkoala-cli: npm install -g @okkoala/koala@latest

Jeśli chcesz zaktualizować CLI, wystarczy wywołać polecenie z punktu 2. Zaleca się instalowanie aktualizacji na biężąco.

Logowanie do platformy

  1. Zaloguj się konto firmy jako administrator na stronie https://okkoala.com
  2. Wejdź w Ustawienia > Integracja > Pobierz token, a następnie skopiuj zawartość pola z tokenem
  3. Otwórz konsolę
  4. Wywołaj polecenie koala auth X, gdzie zamiast X wklej wartość tokenu pobraną ze strony
  5. Możesz sprawdzić, czy wszystko działa, wyliczając wszystkich pracowników: koala ListEmployee

Wynikiem logowania jest utworzenie pliku .koala/token w katalogu domowym użytkownika. Jeśli chcesz się wylogować, usuń ten plik.

Wylogowanie się z lokalne sesji

Usuń plik .koala/token w katalogu domowym użytkownika.

Lista komend, pomoc do komend

Aktualną listę komend możesz uzyskać używając polecenia koala help. Jeśli potrzebujesz wiedzieć jakie parametry wymaga dana komenda (np. do stworzenia użytkownika), możesz użyć koala CreateEmployee help

Do czego stosować CLI?

Do czego nie stosować CLI?