Konfigurieren der CLI

In diesem Abschnitt wird beschrieben, wie Sie re authentifizieren und konfigurieren. Dabei wird davon ausgegangen, dass Sie die CLI installiert haben; siehe Installationsanweisungen .

Der Abschnitt „ Schnelleinrichtung “ ist eine kurze Schritt-für-Schritt-Anleitung für die ersten Schritte und die Konfiguration der CLI. Der Rest der Seite enthält detaillierte Anweisungen und geht auf alle verfügbaren Optionen ein.

Schnelle Einrichtung

Installieren Sie das Befehlszeilentool für Ihre Plattform (Linux, Mac und Windows werden unterstützt).

Erstellen Sie einen benannten Kontext , um zu vermeiden, dass Sie Ihren Mandantenendpunkt und Ihr API-Token jedes Mal eingeben müssen. Geben Sie Ihren Mandantenendpunkt an:

re config add --name main --endpoint https://<my_api_endpoint>/

Sie werden aufgefordert, Ihr API-Token einzufügen:

I A new context `main` will be created.
  Enter API token [none]: MYSUPERSECRETTOKEN
I New context `main` was created.

Versuchen Sie, einen Befehl auszuführen, um zu sehen, dass alles funktioniert, z. B

re get datasets

Sie können das globale Flag -c oder --context verwenden, um einen bestimmten Kontext mit dem Befehl zu verwenden, z. B

re -c main get datasets

Jede der Kontexteinstellungen kann einmalig mit globalen Flags wie --token, --endpoint und --proxy usw. überschrieben werden. Befehlszeilenargumente haben Vorrang vor den Kontexteinstellungen.

Jedes Mal Anmeldeinformationen

Die einfachste Möglichkeit, die CLI zu authentifizieren, besteht darin, den Endpunkt und das API-Token für jeden Befehl anzugeben. Standardmäßig werden Sie von re aufgefordert, das Token interaktiv einzugeben.

Beispielsweise um die verfügbaren Datasets aufzulisten

➜ re --endpoint https://acme.reinfer.io get datasets
input: Enter API token [none]: MYSUPERSECRETAPITOKEN
 Name                                ID                Updated (UTC)        Title
 InvestmentBank/collateral-streams  aa9dda7c059e5a8d  2019-04-30 17:25:03  IB Collateral Streams
 InvestmentBank/george-test          1aaeacd49dfce8a0  2019-05-10 15:32:34  Test Dataset
 InvestmentBank/margin-call          b9d50fb2b38c3af5  2019-05-08 07:51:09  IB Margin Call
 InvestmentBank/margin-call-large    6d00b9f69ab059f6  2019-05-11 09:23:43  IB Margin Call Large

Das Token kann auch mit --tokenangegeben werden.

➜ re --endpoint https://acme.reinfer.io --token MYSUPERSECRETAPITOKEN get datasets

Im Allgemeinen ist dies keine gute Idee, da das API-Token in Ihrem Shell-Verlauf gespeichert wird. Es wäre besser, das API-Token in einer Umgebungsvariablen zu speichern.

➜ re --endpoint https://acme.reinfer.io --token $REINFER_TOKEN get datasets

Dies ist jedoch immer noch ausführlich, wiederholend und unsicher.

Warnung:

In einigen Fällen kann das Bereitstellen der Konfiguration mithilfe von Befehlszeilen-Flags hilfreich sein. Die empfohlene Verwendungsmethode für die CLI ist jedoch das Konfigurieren eines benannten Kontexts, siehe unten.

Benannte Kontexte

Ein Kontext ist eine Sammlung von Einstellungen und Anmeldeinformationen, die Sie auf einen re -Befehl anwenden können. Wenn Sie einen Kontext zum Ausführen eines Befehls angeben, werden die Einstellungen und Anmeldeinformationen zum Ausführen dieses Befehls verwendet. In der Konfigurationsdatei können mehrere Kontexte gespeichert werden.

Kontexte helfen dabei, zu vermeiden, dass ein Token, ein Endpunkt und andere Konfigurationen bei jedem Befehl manuell angegeben werden müssen. Ein Kontext besteht aus Folgendem:

• Ein einprägsamer Name , der als Bezeichner für den Kontext dient
• Ein API-Token , das zur Authentifizierung des Benutzers verwendet wird, der Anforderungen stellt
• Ein Endpunkt , an den die CLI die Anforderungen stellt
• (Optional) Ein HTTP-Proxy , der für alle Anforderungen verwendet werden soll
• (Optional) Ob ungültige TLS-Zertifikate vom Endpunkt akzeptiert werden sollen (nur nützlich für interne/dev Communications Mining-Cluster)

Sie können einen Standardkontext angeben, der verwendet wird, wenn auf keinen explizit verwiesen wird.

Das globale Flag -c, --context kann verwendet werden, um einen bestimmten Kontext mit Namen zu versehen, die Sie als Parameter in der Befehlszeile für einzelne Befehle angeben können.

Erstellen eines Kontexts

Sie können mit einen neuen Kontext erstellen oder einen vorhandenen ändern

re config add

Wenn der Befehl ohne Optionen ausgeführt wird, fragt er interaktiv nach dem Kontextnamen, dem Endpunkt und dem Token.

➜ re config add
* Context name: acme-prod
I A new context `acme-prod` will be created
* Enter API token [none]: MYSUPERSECRETTOKEN
* Endpoint [https://reinfer.io/]: https://acme.reinfer.io
I Default context set to `acme-prod`
I New context `acme-prod` was created

Beim Erstellen des allerersten Kontexts wird dieser als aktiv festgelegt

➜ re config add --name acme-dev --endpoint https://acme.reinfer.io/
I A new context `acme-dev` will be created.
* Enter API token [none]: MYSUPERSECRETTOKEN
I Default context set to `acme-dev`
I New context `acme-dev` was created.

Wenn Sie einen Kontext mit einem bereits vorhandenen Namen hinzufügen, wird dieser Kontext stattdessen aktualisiert.

# Edit the acme-dev context if it already exists
re config add acme-dev

Um alle ausgeführten Optionen anzuzeigen, re config add -h, sind die wichtigsten zu sehen

Optionen

Name	BESCHREIBUNG
--name <name>	Der Name des Kontexts, der erstellt oder aktualisiert wird
--endpoint <endpoint>	Der Communications Mining-Cluster-Endpunkt, der für diesen Kontext verwendet wird
--token <token>	Das erneute API-Token, das für diesen Kontext verwendet wird
--proxy <proxy>	URL für einen HTTP-Proxy, der für alle Anforderungen verwendet wird, falls angegeben

Der aktuelle Kontext wird für alle nachfolgenden Befehle verwendet. Im Folgenden werden alle Datasets für den aktuellen Kontext gedruckt.

re get datasets

Jede der Kontexteinstellungen kann als einmalig mit globalen Flags wie --token, --endpoint und --proxy überschrieben werden.

re --proxy http://proxy.example get datasets

Verwenden eines Kontexts

Sie können das globale Flag -c oder --context verwenden, um einen bestimmten Kontext mit dem Befehl zu verwenden, z. B

re -c my-context get datasets

neu konfigurieren

Alle Vorgänge, die mit der Verwaltung benannter Kontexte zu tun haben, fallen unter den Befehl re config . Die Unterbefehle ermöglichen das Erstellen, Aktualisieren, Festlegen von Standardeinstellungen, Löschen von Kontexten und vieles mehr.

Alle verfügbaren Optionen finden Sie in der Befehlsreferenz .

Wo werden die Konfigurationseinstellungen gespeichert?

Der Speicherort Ihres Konfigurationsverzeichnisses hängt vom Betriebssystem ab. Das Communications Mining-Befehlszeilentool berücksichtigt diese Betriebssystemstandards. In der Regel finden Sie das Konfigurationsverzeichnis unter

• ~/.config/reinfer unter Linux
• $HOME/.config/reinfer unter macOS
• %AppData%\reinfer unter Windows

Die Kontexteinstellungen werden in einer JSON-Datei contexts.json gespeichert, z. B. ~/.config/reinfer/contexts.json unter Linux. Es sieht ungefähr so aus

{
  "current_context": "prod",
  "contexts": [
    {
      "name": "prod",
      "endpoint": "https://acme.reinfer.io/",
      "token": "MYSUPERSECRETTOKEN",
      "accept_invalid_certificates": false,
      "proxy": null
    }
  ]
}