Twilioブログ

Twilio CLIのインストール方法

こんにちは、Twilioマーケティング部のkatsu.tです。

TwilioにはAPIを簡単に使うことができるCLI(Command Line Interface)が用意されています。
CLIを利用することでlocal環境から簡単にTwilioのAPIを試せたり、CI/CDツールのスクリプトに簡単にTwilioのAPIを組み込んだりできます。

本記事では、そんなTwilio CLIのセットアップ方法についてご紹介いたします。

目次

Twilio CLIでできること

Twilio CLIを利用することで、TwilioのAPIをCLIから利用できます。またTwilio APIを組み合わせてより便利に使えるCLIの独自機能もあります。

 $ twilio 
Unleash the power of Twilio from your command prompt. Visit https://twil.io/cli for documentation.

VERSION
  twilio-cli/2.31.0 darwin-x64 node-v16.11.1

USAGE
  $ twilio [COMMAND]

TOPICS
  // 全てのTwilioAPIへアクセス
  api            advanced access to all of the Twilio APIs
 // Twilio Autopilot Assistantの作成、更新、削除、リスト、シミュレート、インポートとアップデート
  autopilot      Create, Update, Delete, List, Simulate, Import and Export Twilio Autopilot Assistant
 // アカウントに対して生成されたログイベントのリストを表示する
  debugger       Show a list of log events generated for the account
 // Twilio SendGridを用いて一通または複数通のメールを送信する
  email          sends emails to single or multiple recipients using Twilio SendGrid
 // CLIチームへフィードバックを提供する
  feedback       provide feedback to the CLI team
 // Twilio CLIを利用して、Flex Pluginを作成、開発、デプロイする
  flex           Create, develop and deploy Flex plugins using the Twilio CLI
// Twilioの電話番号を管理 phone-numbers manage Twilio phone numbers
// インストールされた、有効なプラグインをリストを表示 plugins list available plugins for installation
// Twilioの認証情報の管理 profiles manage credentials for Twilio profiles
// Twilioを利用したリアルタイムコミュニケーションを紹介するプラグイン rtc A plugin which showcases real-time communication applications powered by Twilio
// Twilioサーバーレス環境をローカルで開発、デバック、デプロイ serverless locally develop, debug and deploy to Twilio Serverless
// テストアプリケーションに利用する一時的なトークンの作成 token Generate a temporary token for use in test applications COMMANDS
// 自動補完のインストールてxユンを表示する autocomplete display autocomplete installation instructions
// CLIチームにフィードバックを提供する feedback provide feedback to the CLI team
// twilioのヘルプを表示する help display help for twilio
// Twilioアカウントの認証情報と設定を新規プロファイルに保存 login create a new profile to store Twilio Account credentials and configuration
// インストール済みのプラグインを表示 plugins list installed plugins

Twilio CLIのインストール方法

Twilio CLIのインストール方法について、それぞれの環境でのやり方をご紹介いたします。

Windows

Node.jsのインストールを確認

下記コマンドを実行し、「Node.jsがインストールされている」「バージョン12.21以降である」ことを確認します。
※インストールされていない場合、Node.js公式ページを元にインストールを行います。

node -v

Twilio CLIをインストール

下記コマンドでTwilio CLIをインストールします。

npm install twilio-cli -g

Twilio CLIを更新

Twilio CLIは下記コマンドで最新版にアップグレードできます。

npm install twilio-cli@latest -g

Mac

Homebrewをインストール

Homebrewを利用することで、簡単にTwilio CLIをインストールすることが可能です。

まずは、Homebrewをインストールします。
※Homebrewをまだインストールしていない方は、公式ページよりインストールしてください。

Twilio CLIをインストール

下記コマンドでTwilio CLIをインストールします。

brew tap twilio/brew && brew install twilio

Twilio CLIを更新

Twilio CLIは下記コマンドで最新版にアップグレードすることができます。

brew upgrade twilio

Linux

Node.jsのインストールを確認

下記コマンドを実行し、「Node.jsがインストールされている」「バージョン10.12以降である」ことを確認します。

Linux向けlibsecretのインストール

libsecretをインストールします。

//Debian/Ubuntu: 
sudo apt-get install libsecret-1-dev
// Red Hatベース: 
sudo yum install libsecret-devel
// Arch Linux: 
sudo pacman -S libsecret

Twilio CLIをインストール

下記コマンドでTwilio CLIをインストールします。

npm install twilio-cli -g

Twilio CLIを更新

Twilio CLIは下記コマンドで最新版にアップグレードすることができます。

npm install twilio-cli@latest -g

Twilio CLIでTwilioにログイン

Twilio CLIの準備ができたら、初めて使うアカウントのみログインを行います。

下記コマンドを実行するとAccount SIDとAuth Tokenの入力が要求されます。

twilio login

※Account SIDとAuth TokenはTwilioコンソールから取得することが可能です。

Twilio CLIでTwilioにログイン

Twilioアカウントの切り替え

一度ログインしたことがあるアカウントは下記コマンドで確認することが可能です。

twilio profiles:list

アカウントを切り替える際は、下記コマンドを利用します。

// PROFILEはtwilio loginコマンドを実行した際に設定した、identifierを設定してください。
// identifierがわからなくなった場合上記listコマンドで一覧をご確認ください。
twilio profiles:use PROFILE

Twilio CLIのヘルプの確認方法

Twilio CLIはコマンドの後ろに"--help"を入れることで、コマンドのヘルプを確認できます。

// 例
$ twilio profiles:use --help
USAGE
  $ twilio profiles:use PROFILE

ARGUMENTS
  PROFILE  Shorthand identifier for your profile

OPTIONS
OPTIONAL FLAGS
  -l=(debug|info|warn|error|none)  [default: info] Level of logging messages.
  -o=(columns|json|tsv|none)       [default: columns] Format of command output.
  --silent                         Suppress output and logs. This is a shorthand for "-l none -o none".

MORE INFO
  https://twilio.com/docs/twilio-cli/general-usage#profiles

 

 

まとめ

Twilio CLIを用いることで、ローカル環境でも簡単にTwilio APIを試せます。そのほかにもFunctionsの機能開発やシミュレートも実現できるため、ローカル環境での開発が非常にはかどることでしょう。

なおTwilio CLIを用いた電話番号の購入方法については、こちらの「Twilio CLIで電話番号を購入する方法 」をご覧ください。

またTwilio CLIは年に一度開催されるTwilio SINGALで特別なプラグインが提供されるなど、使っていくのが非常に楽しいツールとなっております。この機にぜひお試しください!

アプリケーションエンジニア 葛 智紀
アプリケーションエンジニア 葛 智紀

前職でiOS、Androidのネイティブアプリケーション開発、AngularやLaravelを用いたウェブアプリケーション開発に従事。KDDIウェブコミュニケーションズではTwilioの最新情報の発信やTwilioを用いた地域課題解決を担当。 個人では、Google Developer Group Tokyoのオーガナイザーを務める。

Twilioサインアップ

Share!!

  • お役立ち情報
  • イベント情報
  • 相談会申込
  • 導入事例