Communications Mining

概要

Communications Mining コマンドラインインターフェイス reは、ターミナルから Communications Mining のすべての部分と対話するための一貫したインターフェイスを提供する統合ツールです。

re ソースやデータセットなどの Communications Mining リソースの管理、および通信データのインポートとエクスポートが簡素化されます。さらに、 re では複数のコンテキストが保持されるため、ユーザー、サービスアカウント、または Communications Mining エンドポイントごとに複数の認証トークンを簡単に切り替えることができます。

Communications Mining CLI はオープンソースであり、 GitHub で開発されています。

機能

さまざまな Communications Mining のすべてのリソースに対する作成、取得、更新、削除操作を行います。これには、ソース、データセット、コメント、バケット、ストリームなどが含まれます。
複数の API トークンおよび Communications Mining エンドポイントのコンテキスト管理。
新しいメッセージを簡単にソースにアップロードできます。
一連のソースとデータセットから、人間が適用したアノテーションと一緒にメッセージをダウンロードできます。バックアップを作成する場合や、データを移行する場合、データに変換を適用する場合に便利です。
zshとbashの基本的なシェルオートコンプリート、色付きの端末出力、プログレスバーなど

インストール

バイナリ

依存関係のない静的にリンクされたバイナリは、すべての主要なプラットフォームに提供されます

ソースから

ソースからビルドするには、最新バージョンのRustツールチェーンがインストールされている必要があります。貨物を使用して設置します。

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

パスに cargo bin ディレクトリがあることを確認します (通常は ~/.cargo/bin)。

または、いつでもリポジトリのクローンを作成して、 cargo buildを使用して構築することもできます。

ヘルプ

Communications Mining CLI には、 --help または -h フラグでアクセスできる多くのコマンドドキュメントが付属しています。

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

付属のドキュメントは広範で常に最新のものであるため、このドキュメントをお読みになることをお勧めします。

$ 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

トラブルシューティング

Communications Mining CLI に関する問題のトラブルシューティングを行うには、次が役立つ場合があります

最新バージョンの re がインストールされていることを確認します。 re --version または re -V を実行して、インストールされているバージョンを取得します。
--verbose フラグはデバッグメッセージを出力するため、問題を絞り込むことができます。
接続の問題は、プロキシ設定が正しく構成されていないことが原因である可能性があります。「プロキシを使用して要求プロキシを構成する」を参照してください。
Communications Mining CLI の構成ディレクトリはシステム固有です。たとえば、 Linux または macOS では~/.config/reinfer、Windows では%AppData%/reinfer。安全に削除でき、CLI によって再入力されますが、すべての設定(ユーザセッションを含む)は失われます。

改善のためにできることがある場合、またはバグや予期しない動作が発生した場合は、サポートにお問い合わせください。