Vonage CLIを始める

Vonage CLIにはVonageのAPIでブートストラップできるコマンドがたくさんあります。ダッシュボードを使用して 多くのCLIタスクを達成するためにダッシュボードを使用することができますが、サーバー上のアプリケーションをプログラムで設定および構成することもできます。すでに Vonageアプリケーションを設定済みですか？CLIを使用すると、設定をJSONまたはYAMLに素早くエクスポートして、プログラムで利用することができます。 プログラムで利用することができます。

バージョン3の新機能

CLIを初めて使う人は、このセクションを読み飛ばしても構わない。CLIの最新バージョン3は、過去のバージョンの欠点のいくつかに対処するために、グラウンドアップされた実用的な設計を提供しています。 過去のバージョンの欠点のいくつかに対処しています。

標準化された旗

Vonage CLI のすべてのフラグで ケバブケース一貫性を確保し、コマンドをよりわかりやすくする。

JSONおよびYAML出力のサポート

JSONまたはYAMLを使用してコマンドの出力形式を指定できるようになった。 ツールやワークフローと柔軟に統合できます。

アクション別にグループ化されたコマンド

コマンドは、使いやすさを向上させ、必要な機能を見つけやすくするために、アクションごとに整理されています。

yargsで構築

バージョン3は yargs リンク パッケージで ユーザーフレンドリーな体験を提供します。

より簡単な設定

CLIの設定が簡素化され、VonageアプリケーションまたはVonage Account内での作業が容易になりました。 下記参照 CLIの設定方法については

自動アップデート

バージョン3は定期的に新しいアップデートをチェックし、アップグレードのタイミングをお知らせします。これにより Vonage APIを正しく呼び出し、ツールにバグがないことを保証します。

インストール

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

npmを使ったインストール

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

npm install -g @vonage/cli

糸を使った取り付け

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

yarn global add @vonage/cli

グローバルフラッグ

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

  • --verbose:詳細情報を印刷する。
  • --debug:デバッグ情報を表示します。
  • --no-color:カラー出力をオフに切り替える。
  • --help:ヘルプを表示

verbose そして debug 情報が書き込まれる STDERR 他のプログラムへのパイプ出力を可能にする

認証

Vonage CLIは柔軟な設定システムを使用してAPI認証情報を管理します。ローカルまたはグローバル 設定ファイルと、これらの値を上書きするためのコマンドラインフラグをサポートしています。 プロジェクトのニーズや個人的な好みに応じて設定をカスタマイズできます。

構成

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

  1. コマンドライン・フラグ --api-key, --api-secret, --private-keyそして --app-id.
  2. 現在の作業ディレクトリにあるローカル・コンフィギュレーション・ファイル .vonagerc.
  3. のグローバル・コンフィギュレーション・ファイル。 .vonage ホームディレクトリの $HOME/.vonage/config.json.

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

注:秘密鍵の内容はコンフィギュレーション・ファイルの中に保存されます。これは 新しい鍵が生成されたときに鍵が上書きされないようにするためです。

フラッグ:

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

認証の設定

CLIを設定せずに使用することもできますが、コマンドを実行する際にフラグを渡す必要があります。 フラグを使用するには vonage auth set コマンドを実行するたびに入力する手間を省くために、このコマンドを推奨する。

フラッグ:

このコマンドは グローバル認証フラグ

例:

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

注走る vonage auth set は現在の値を削除しない。したがって、APIキー/シークレットまたは を個別に設定することができる。ただし、APIキーとシークレットが設定されていないと、アプリIDとプライベートキーの設定はできません。 を設定することはできない。これは、コマンドが認証情報の有効性をチェックする方法によるものだ。

注:このコマンドは、コミットする前に認証情報が正しいかどうかもチェックする。

認証チェック

認証の詳細が有効であることをVerifyする。デフォルトでは、グローバル設定ファイルを使用します。認証情報の確認 認証情報のチェックは次のように動作します：

  1. APIキーとシークレットは、アプリケーションをリストアップするために アプリケーションAPI.
  2. Applications IDと秘密鍵の検証は、アプリケーション情報を取得し、公開鍵と秘密鍵が正しくペアになっていることを確認することで行われる。

注意：このコマンドはコマンドライン引数を使用しません。設定ファイル

フラッグ:

  • --local:ローカル設定ファイル(.vonagerc).

例:

グローバル・コンフィギュレーションを確認する：

vonage auth check 

Global credentials found at: C:\Users\bob\.vonage\config.json

API Key: abcd1234
API Secret: abc**************
App ID: 00000000-0000-0000-0000-000000000000
Private Key: Is Set

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

ローカル・コンフィギュレーションをチェックする：

vonage auth check --local

Global credentials found at: .vonagerc

API Key: abcd1234
API Secret: abc**************
App ID: 00000000-0000-0000-0000-000000000000
Private Key: Is Set

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

認証を表示する

現在の認証設定を表示する。これは、前述の設定ロードに従います。 上記 で、CLIがどの設定ファイルを使用しているかを知ることができる。

注:このコマンドは、認証情報が正しいかどうかもチェックする。

フラッグ:

  • --show-all:Redactされていない秘密鍵とAPIシークレットを表示します。
  • --yaml:YAML形式で出力。
  • --json:JSON形式で出力。

例:

コンフィギュレーションを表示する

vonage auth show

Global credentials found at: C:\Users\bob\.vonage\config.json

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

お困りですか？

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