nctl

nctl ist ein Werkzeug zur Interaktion mit Ihren Nine 'self-service' Produkten.

Installation

Um nctl zu installieren, folgen Sie bitte der Anleitung auf GitHub.

Erste Schritte

Anmelden

Um sich mit nctl anzumelden, können Sie den folgenden Befehl verwenden und zusammen mit Ihren Cockpit Zugangsdaten:

nctl auth login

Projekte und Organisationen

Sie können den folgenden Befehl nutzen um ein neues Standardprojekt, auf das sich alle weiteren nctl Befehle beziehen, festzulegen:

$ nctl get projects
NAME                     DISPLAY NAME
test                     <none>

$ nctl auth set-project test

Um zwischen den Organisationen zu wechseln, können Sie folgenden Befehl verwenden:

$ nctl auth whoami
You are currently logged in with the following account: "test@nine.ch"
Your current organization: "test"

Available Organizations:
    test
    test1

$ nctl auth set-org test1

Interaktion mit Nine-Ressourcen

Um alle verfügbaren Befehle zu sehen, nutzen Sie das Flag --help:

nctl --help

Möchten Sie alle Ihre Ressourcen im aktuellen Projekt anzeigen, nutzen Sie nctl get all:

nctl get all

Um alle Ihre Ressourcen eines anderen Projekts anzuzeigen, nutzen Sie das Flag -p <other-project-name>:

nctl get all -p test1

Um eine Ressource (bspw. ein Projekt) zu erstellen, nutzen Sie nctl create <resource> <name>:

nctl create project test2

Um eine Ressource zu aktualisieren, nutzen Sie nctl update <resource> <name>:

nctl update project test2 --display-name="Test 2"

Um eine Ressource zu löschen, nutzen Sie nctl delete <resource> <name>:

nctl delete project test2

Um eine Ressource in Ihrem Editor zu bearbeiten, nutzen Sie nctl edit <resource> <name>:

nctl edit project test2

Standardmässig wird der Editor von der Shell-Umgebungsvariable EDITOR verwendet. Um dies für nctl zu überschreiben, können Sie allerdings auch die Variable NCTL_EDITOR verwenden.