Vonage CLI入門

Vonage CLIには、サーバー上のアプリケーションをプログラムでセットアップして設定したり、設定をJSONやYAMLにエクスポートしてプログラムで利用したりするためのコマンドが多数用意されています。

インストール

Vonage CLI は ノードJS を利用している。 @vonage/server-sdk パッケージは ギットハブ.CLIは、常に最も低いLong Term Supported (LTS) で動作します。 バージョン 現在18.20）。

注： NodeJSの奇数番号のバージョンは実験的とみなされ、限られたサポートしかありません。

npmを使ったインストール

を使用してVonage CLIをインストールするには npm次のコマンドを実行する：

npm install -g @vonage/cli

糸を使った取り付け

を使用してVonage CLIをインストールするには yarn:

yarn global add @vonage/cli

初期設定

Vonage CLI は柔軟な設定システムを使用して API クレデンシャルを管理します。ローカルまたはグローバル設定ファイルと、これらの値を上書きするためのコマンドライン・フラグをサポートしており、プロジェクトのニーズや個人的な好みに基づいて設定を調整することができます。

CLIは以下の順序でコンフィグレーションをロードする：

  1. コマンドラインのフラグ：
  2. 現在の作業ディレクトリにあるローカル・コンフィギュレーション・ファイル .vonagerc.
  3. のグローバル・コンフィギュレーション・ファイル。 .vonage ホームディレクトリの $HOME/.vonage/config.json.

注： CLIだけがこれらの値を .vonagerc.Vonage SDKは、独自の認証情報を使って個別に初期化する必要があります。 を必要とします。

注:秘密鍵の内容は設定ファイル内に保存されます。これは 新しい鍵が生成されたときに鍵が上書きされないようにするためです。

認証の設定

CLIは設定しなくても使用できるが、コマンドを実行する際にフラグを渡す必要がある。

を使用している。 vonage auth set コマンドを実行するたびに入力する手間を省くために、このコマンドを推奨する。

フラッグ

このコマンドは、以下のグローバル認証フラグを使用する：

  • --api-key:ダッシュボードの「API設定」セクションにあるAPIキー。
  • --api-secret:ダッシュボードの「API設定」セクションにあるAPIシークレット。
  • --app-id:使用するアプリケーションのID。ダッシュボードの "Applications "セクションに表示されます。 で出力されます。 vonage apps.
  • --private-key:秘密鍵のパスまたは内容。秘密鍵にアクセスできるのは、アプリケーションを作成するときか、ダッシュボードで鍵を再生成するときだけです。 を作成したとき、またはダッシュボードでキーを再生成したときにのみアクセスできます。

送信されると、コミットする前に資格情報が正しいかどうかチェックされる。

注走る vonage auth set は現在の値を削除せず、ユーザーの確認があった場合のみ、すべての設定ファイルを更新します。そのため、API Key/SecretまたはApp ID/PrivateKeyだけを個別に設定することができる。ただし、APIキーとシークレットが設定されていないと、アプリIDとプライベートキーを設定することはできない。

例

Vonage API認証情報を設定するには、以下の手順に従います：

vonage auth set `
--api-key='your-api-key' `
--api-secret='your-api-secret' `
--app-id='your-application-id' `
--private-key=C:\path\to\private.key

API Key: your-api-key
API Secret: your-**************
App ID: your-application-id
Private Key: Is Set

✅ Checking API Key Secret
✅ Checking App ID and Private Key

CLIの使用

利用可能なコマンドの表示

コマンドは、製品またはアクションごとにグループ化されています。利用可能なコマンドのリストを表示するには、次のコマンドを実行します。 vonage 引数なしで：

vonage 

vonage <command>

Commands:
  vonage apps [command]           Manage applications
  vonage auth [command]           Manage authentication information
  vonage balance                  Check your account balance
  vonage conversations [command]  Manage conversations
  vonage jwt <command>            Manage JWT tokens
  vonage members [command]        Manage applications
  vonage numbers [command]        Manage numbers
  vonage tunnel <which>           Open a tunnel in order to test webhooks
  vonage users [command]          Manage users

Options:
      --version   Show version number                                                                                                                                                  [boolean]
  -v, --verbose   Print more information                                                                                                                                               [boolean]
  -d, --debug     Print debug information                                                                                                                                              [boolean]
      --no-color  Toggle color output off                                                                                                                                              [boolean]
  -h, --help      Show help                                                                                                                                                            [boolean]

を追加することができます。 --help フラグをどこに置いても、利用可能なすべてのコマンドとその使い方を見ることができる。

グローバルフラッグ

Vonage CLI は、すべてのコマンドで使用可能なグローバル・フラグのセットを提供します：

  • --version:現在インストールされているCLIのバージョンを表示します。
  • --no-color:カラー出力をオフに切り替える。
  • --help:ヘルプを表示
  • --yaml:YAML形式で出力。
  • --json:JSON形式で出力。

YAMLフラグとJSONフラグに対応しているのは一部のコマンドだけです。YAMLフラグとJSONフラグには --help フラグをどのコマンドにも付けて、それらが使えるかどうかを確認する。

デバッグ

について --verbose そして --debug フラグを使用して、CLIの動作に関する追加情報を表示することもできます。フラグについては デバッグ のガイドを参照してください。

お困りですか？

何か問題が発生したり、助けが必要な場合は、私たちの コミュニティSlackチャンネル.