Überblick

Die Communications Mining-Befehlszeilenschnittstelle, re, ist ein einheitliches Tool, das eine konsistente Schnittstelle für die Interaktion mit allen Teilen von Communications Mining von einem Terminal aus bietet.

re vereinfacht die Verwaltung von Communications Mining-Ressourcen, wie z. B. Quellen und Datasets, sowie das Importieren oder Exportieren von Kommunikationsdaten. Darüber hinaus verwaltet re mehrere Kontexte, was den Wechsel zwischen mehreren Authentifizierungstokens für verschiedene Benutzer, Dienstkonten oder Communications Mining-Endpunkte einfach macht.

Die Communications Mining-CLI ist Open Source und wurde auf GitHub entwickelt.

Funktionen

• Create-, get-, update- und Delete- Vorgänge für all die unterschiedlichen Communications Mining-Ressourcen. Dazu gehören Quellen, Datasets, Kommentare, Buckets, Streams und mehr.
• Kontextverwaltung für mehrere API-Token und Communications Mining-Endpunkte.
• Laden Sie neue Nachrichten ganz einfach in eine Quelle hoch.
• Laden Sie Nachrichten aus einer Reihe von Quellen und Datasets zusammen mit den von Menschen angewendeten Anmerkungen herunter. Nützlich für Sicherungen, das Migrieren von Daten oder zum Anwenden von Transformationen auf die Daten.
• Grundlegende Shell-Autovervollständigung für zsh und bash, eingefärbte Terminalausgabe, Fortschrittsbalken und mehr

Installation

Binär

Statisch verknüpfte Binärdateien ohne Abhängigkeiten werden für alle Hauptplattformen bereitgestellt

• Linux (x86_64-unknown-linux-musl)
• macOS (x86_64-apple-darwin)
• Windows (x86_64-PC-Windows-GNU)

Aus Quelle

Zum Erstellen aus Quellen muss eine aktuelle Version der Runtime installiert sein. Zum Installieren mit Ladedruck.

cargo install --locked reinfer-cli

Stellen Sie sicher, dass Sie das Frachtbereich-Verzeichnis in Ihrem Pfad haben (normalerweise ~/.cargo/bin).

Alternativ können Sie das Repository jederzeit klonen und mit cargo build erstellen.

Help

Die Communications Mining-CLI enthält eine umfangreiche Befehlsdokumentation, auf die mit dem Flag --help oder -h zugegriffen werden kann.

$ re --help
$ re <command> --help
$ re <command> <subcommand> --help

Wir empfehlen Ihnen, die beiliegende Dokumentation zu lesen, da sie umfangreich und immer auf dem neuesten Stand ist.

$ re --help

reinfer-cli 0.11.0
re is the command line interface to reinfer clusters

USAGE:
    re [FLAGS] [OPTIONS] <SUBCOMMAND>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information
    -v, --verbose    Enable more verbose logging

OPTIONS:
    -k, --accept-invalid-certificates <accept-invalid-certificates>
        --config-file <config>
            Path to the configuration file. Typically defaults to ~/.config/reinfer on Linux

    -c, --context <context>
            Specify what context to use. Overrides the current context, if any

        --endpoint <endpoint>
            Specify what endpoint to use. Overrides the one from the current context, if any

    -o, --output <output>
            Output format. One of: json, table [default: table]

        --proxy <proxy>
            URL for an HTTP proxy that will be used for all requests if specified

        --token <token>
            Specify what API token to use. Overrides the one from the current context, if any


SUBCOMMANDS:
    completion    Output shell completion code for the specified shell (bash or zsh)
    config        Manage reinfer authentication and endpoint contexts
    create        Create new resources
    delete        Delete a resource
    get           Display resources and export comments to the local filesystem
    help          Prints this message or the help of the given subcommand(s)
    update        Update existing resources

Fehlersuche und ‑behebung

Um Probleme mit der Communications Mining-CLI zu beheben, können die folgenden Informationen hilfreich sein

• Stellen Sie sicher, dass die aktuelle Version von re installiert ist. Rufen Sie die installierte Version ab, indem Sie re --version oder re -V
• Das Flag --verbose gibt Debugging-Meldungen aus, die das Problem eingrenzen können.
• Verbindungsprobleme können auf falsch konfigurierte Proxyeinstellungen zurückzuführen sein. Siehe Verwenden eines Proxys zum Konfigurieren des Anforderungsproxys.
• Das Communications Mining CLI-Konfigurationsverzeichnis ist systemspezifisch, z. B ~/.config/reinfer unter Linux oder macOS und %AppData%/reinfer unter Windows. Er kann sicher gelöscht werden und wird von der CLI neu eingetragen. Die gesamte Konfiguration (einschließlich der Benutzersitzungen) geht jedoch verloren.

Wenn Sie das Gefühl haben, dass wir etwas verbessern können, oder wenn Fehler oder unerwartetes Verhalten auftreten, wenden Sie sich bitte an den Support.