CLI を設定する

このセクションでは、 reの認証と設定の方法について説明します。CLI がインストールされていることを前提としています。詳しくは、手順をご覧ください。

「クイック セットアップ」セクションでは、CLI の開始方法と設定方法の簡単なステップ バイ ステップのリファレンスです。このページの残りの部分には詳細な手順が含まれており、利用可能なすべてのオプションについて説明します。

クイックセットアップ

お使いのプラットフォーム用のコマンドラインツール(Linux、Mac、Windowsがサポートされています)。

テナントのエンドポイントと API トークンを毎回入力しなくても済むように、 名前付きコンテキスト を作成します。 テナント エンドポイントを指定します。

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

API トークンを貼り付けるよう求められます。

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

コマンドを実行して、すべてが動作することを確認してください。たとえば、

re get datasets

-c または --context グローバル フラグを使用して、コマンドで特定のコンテキストを使用できます。

re -c main get datasets

コンテキスト設定は、 --token、 --endpoint 、 --proxy などのグローバルフラグを使用して1回限りで上書きできます。コマンドライン引数は、コンテキスト設定よりも優先されます。

資格情報を毎回指定する

CLI を認証する最も簡単な方法は、すべてのコマンドのエンドポイントと API トークンを指定することです。 既定では、対話形式でトークンを入力するよう求められ re 。

たとえば、使用可能なデータセットを一覧表示するには、

➜ 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

トークンは、--tokenを使用して指定することもできます

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

APIトークンはシェル履歴に保存されるため、これは一般的には良い考えではありません。 APIトークンを環境変数に格納することをお勧めします。

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

ただし、これは依然として冗長で反復的であり、安全ではありません。

警告:

コマンド ライン フラグを使用して構成を指定すると、場合によっては便利です。ただし、CLI の使用方法として推奨されるのは、 名前付きコンテキストを設定することです。詳しくは、以下のセクションをご覧ください。

名前付きコンテキスト

コンテキストは、re コマンドに適用できる設定と資格情報のコレクションです。コマンドを実行するコンテキストを指定すると、設定と資格情報がそのコマンドを実行するために使用されます。 複数のコンテキストを構成ファイルに格納できます。

コンテキストを使用すると、コマンドごとにトークン、エンドポイント、その他の設定を手動で指定しなくても済みます。コンテキストは、次のもので構成されます。

• コンテキストの識別子として機能する覚えやすい 名前 です
• 要求を行うユーザーの認証に使用される API トークン です
• CLI が要求を行うエンドポイント
• (オプション)すべての要求に使用する HTTP プロキシ
• (オプション)エンドポイントからの無効な TLS 証明書を受け入れるかどうか (Communications Mining™ の内部クラスター/開発クラスターでのみ有用)

明示的に参照されていない場合に使用される既定のコンテキストを 1 つ指定できます。

グローバル -c, --context フラグを使用すると、個々のコマンドのコマンド行でパラメーターとして指定できる名前を持つ特定のコンテキストを使用できます。

コンテキストの作成

を使用して、新しいコンテキストを作成することも、既存のコンテキストを変更することもできます。

re config add

オプションを指定せずに実行すると、コマンドは対話的にコンテキスト名、エンドポイント、およびトークンを要求します。

➜ 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

最初のコンテキストを作成すると、これがアクティブなコンテキストとして設定されます

➜ 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.

既に存在する名前のコンテキストを追加すると、代わりにそのコンテキストが更新されます。

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

すべてのオプションを表示するには、 re config add -hを実行します。最も重要なものは次のとおりです。

オプション

名前	説明
--name <name>	作成または更新されるコンテキストの名前。
--endpoint <endpoint>	このコンテキストに使用される Communications Mining™ のクラスター エンドポイント
--token <token>	このコンテキストに使用される再推論 API トークン
--proxy <proxy>	HTTP プロキシの URL です。指定した場合、すべての要求に使用されます。

現在のコンテキストは、後続のすべてのコマンドで使用されます。 以下は、 現在の コンテキストのすべてのデータセットを出力します。

re get datasets

コンテキスト設定は、 --token、 --endpoint 、 --proxyなどのグローバル フラグを使用して 1 回限りで上書きできます。

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

コンテキストを使用する

-c または --context グローバル フラグを使用して、コマンドで特定のコンテキストを使用できます。

re -c my-context get datasets

再設定

名前付き コンテキスト の管理に関連するすべての操作は、 re config コマンドでスコープが設定されます。 サブコマンドを使用すると、コンテキストの作成、更新、デフォルトの設定、コンテキストの削除などを行うことができます。

使用可能なすべてのオプションについては、 コマンド リファレンスをご覧ください。

構成設定はどこに保存されますか?

構成ディレクトリの場所は、オペレーティング システムによって異なります。Communications Mining のコマンド ライン ツールは、これらの OS の既定値を考慮します。通常、構成ディレクトリは次の™場所にあります。

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

コンテキスト設定は JSON ファイル contexts.jsonに保存されます (Linux では ~/.config/reinfer/contexts.json )。 こんな感じです

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