Vue d'ensemble (Overview)

L'interface de ligne de commande de Communications Mining ( re) est un outil unifié qui fournit une interface cohérente pour interagir avec tous les éléments de Communications Mining à partir d'un terminal.

re simplifie la gestion des ressources de Communications Mining, telles que les sources et les jeux de données, ainsi que l'importation ou l'exportation de données de communication. De plus, re gère plusieurs contextes, ce qui permet de basculer facilement entre plusieurs jetons d'authentification pour différents utilisateurs, comptes de service ou points de terminaison Communications Mining.

La CLI Communications Mining est en open source et développée sur GitHub.

Fonctionnalités

Créer, obtenir, mettre à jour et supprimer des opérations pour toutes les différentes ressources Communications Mining. Cela inclut les sources, les ensembles de données, les commentaires, les compartiments, les flux et plus encore.
Gestion du contexte pour plusieurs jetons API et points de terminaison Communications Mining.
Téléchargez facilement de nouveaux messages vers une source.
Téléchargez les messages à partir d'un ensemble de sources et d'ensembles de données ainsi que les annotations appliquées par l'homme. Utile pour les sauvegardes, la migration des données ou pour appliquer certaines transformations aux données.
Complétion automatique du shell de base pour zsh et bash, sortie de terminal colorisée, barres de progression et bien plus encore

Installation

Binaire

Des fichiers binaires liés statiquement sans dépendances sont fournis pour toutes les principales plates-formes

Source

Pour construire à partir de la source, vous avez besoin d'une version récente de la chaîne d' outilsRust installée. Pour installer en utilisant le chargement.

cargo install --locked reinfer-clicargo install --locked reinfer-cli

Assurez-vous que le répertoire de la corbeille est bien présent dans votre chemin d'accès (généralement ~/.cargo/bin).

Vous pouvez également toujours cloner le référentiel et le créer avec cargo build.

Help

La CLI Communications Mining est fournie avec une grande documentation de commande accessible avec l'indicateur --help ou -h .

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

Nous vous encourageons à lire la documentation incluse, car elle est complète et toujours à jour.

$ 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$ 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

Résolution des problèmes

Pour résoudre les problèmes avec la CLI Communications Mining, les éléments suivants peuvent être utiles

Assurez-vous que la dernière version de re est installée. Récupérez la version installée en exécutant re --version ou re -V
L'indicateur --verbose imprime des messages de débogage, ce qui peut affiner le problème.
Les problèmes de connexion peuvent être dus à des paramètres de proxy incorrectement configurés. Voir Utilisation d'un proxy pour configurer le proxy de requête.
Le répertoire de configuration de l'interface en ligne de commande de Communications Mining est spécifique au système, par exemple ~/.config/reinfer sous Linux ou macOS et %AppData%/reinfer sous Windows. Il peut être supprimé en toute sécurité et l'interface en ligne de commande le remplira, mais toute la configuration (y compris les sessions utilisateur) sera perdue.

Si vous pensez que nous pouvons l’améliorer ou si vous rencontrez des bugs ou un comportement inattendu, contactez le support technique.

À cette page