Soracom

Users

開発者向けツール
Home 開発者向けツール SORACOM CLI 利用ガイド インストール / アンインストール

SORACOM CLI をインストールする

SORACOM CLI をインストールして、認証情報を保存します。認証情報を保存しておけば、SORACOM CLI を実行するときに認証情報の入力を省略できます。

SORACOM CLI のソースコードは GitHub で公開しています

SORACOM CLI のソースコードや最新パッケージ、使いかたの詳細は https://github.com/soracom/soracom-cli で公開しています。

特に、README_ja.md には、引数補完 (bash completion / zsh completion) や、複数のプロファイルを使い分ける方法なども記載されています。あわせて参照してください。

ステップ 1: SORACOM CLI をインストールする

SORACOM CLI の Releases ページ から、SORACOM CLI を利用するアーキテクチャに合ったパッケージファイルをダウンロードして展開し、実行形式ファイルを PATH が通っているフォルダまたはディレクトリに配置します。

以下のコマンドでインストールできます。

$ brew tap soracom/soracom-cli
$ brew install soracom-cli

以下のコマンドでインストールできます。${version} には、任意のバージョン番号 (例:0.14.0) を指定します。最新のバージョンは Releases ページ を参照してください。

$ wget https://github.com/soracom/soracom-cli/releases/download/v${version}/soracom_${version}_linux_amd64.tar.gz
$ tar xvf ./soracom_${version}_linux_amd64.tar.gz
$ cp ./soracom_${version}_linux_amd64/soracom /usr/local/bin/

この手順では、例として amd64 用のファイルをインストールしていますが、そのほかのアーキテクチャ用のファイルも用意しています。また、上記のコマンドでは /usr/local/bin にインストールしていますが、任意の PATH が通っているディレクトリにインストールできます。

  1. Releases ページ へアクセスし、パッケージファイル (例: soracom_[バージョン]_windows_amd64.zip) をクリックして、ダウンロードします。
  2. ダウンロードしたファイルを解凍します。
  3. 実行形式ファイル (拡張子が exe のファイル) を、PATH が通っているフォルダ (%SystemRoot%\system32 など) にコピーします。

この手順では、例として amd64 用のパッケージファイルをダウンロードしていますが、i386 用のパッケージファイルも用意しています。

SORACOM CLI のバージョンを確認する

soracom version を実行すると、SORACOM CLI のバージョンを確認できます。

$ soracom version
SORACOM API client v1.2.0

ステップ 2: 認証情報を準備する

SORACOM CLI を実行するために、以下のいずれかの認証情報を準備します。準備した認証情報は、ステップ 3: 認証情報を保存する で入力します。

認証情報説明
SAM ユーザーの認証情報

SAM ユーザー のオペレーター ID、名前、コンソールログインパスワードを確認してください。

SAM ユーザーを作成する操作や、コンソールログインパスワードを設定する操作については、以下のページを参照してください。

SAM ユーザーの認証キー (認証キー ID および認証キーシークレット)SAM ユーザーの認証キーを生成してください。詳しくは、認証キーを生成する を参照してください。
ルートユーザーの認証キー (認証キー ID および認証キーシークレット)ルートユーザーの認証キーを生成してください。詳しくは、ルートユーザーの認証キーを生成する を参照してください。
ルートユーザーのメールアドレスとパスワードルートユーザーのメールアドレスとパスワードを確認してください。
安全のため SAM ユーザーの認証キーを使用することを推奨します

SORACOM CLI 呼び出し専用の SAM ユーザーを作成し、SAM ユーザーの認証キーを使用することを推奨しています。

認証情報が漏洩した場合、専用の SAM ユーザーを作成していれば、あらかじめ設定した権限の操作のみが実行される可能性があります。一方、ルートユーザーの認証情報を使用していると権限を限定できないため、すべての操作が実行される可能性があります。

SORACOM CLI は、多要素認証 には対応していません。

ステップ 3: 認証情報を保存する

SORACOM CLI を実行するために必要な認証情報を保存します。

  1. soracom configure を実行します。

    $ LANG=ja soracom configure
    
    --- SORACOM CLI セットアップ ---
    /home/xxxxx/.soracom ディレクトリがなければ作成し、そこにファイル 'default.json' を作成します。
    
    カバレッジタイプを選択してください。
    
    1. Global
    2. Japan
    
    選択してください (1-2) >
    
    メッセージを日本語化する

    実行例のように LANG 環境変数に ja を指定すると、soracom コマンドのメッセージが日本語化されます。ただし、一部のメッセージは英語で表示される場合があります。

    複数の SAM ユーザーの認証情報を利用するには

    すでに既存の SAM ユーザーの認証情報で SORACOM CLI を利用している場合は、--profile {任意の名前} のように指定すると、新しい SAM ユーザーの認証情報を利用して SORACOM CLI を利用できます。

    たとえば、--profile orbit のように指定して、Orbit 用のプロファイルを作成できます。

    $ LANG=ja soracom configure --profile orbit
    

    このようにプロファイルを保存した場合は、SORACOM CLI を呼び出すときに --profile orbit のように利用するプロファイルを指定してください。

  2. 1 または 2 を入力して、Enter を押します。

    1 (Global): SORACOM IoT SIM (グローバルカバレッジ) のサブスクリプション (plan01s など) を利用する IoT SIM を管理する

    2 (Japan): 特定地域向け IoT SIM (日本カバレッジ) のサブスクリプション (plan-D など) を利用する IoT SIM を管理する

    認証方法を選択してください。
    
    1. AuthKeyId と AuthKey を入力する (推奨)
    2. オペレーターのメールアドレスとパスワードを入力する
    3. SAM ユーザーの認証情報を入力する (オペレーター ID、ユーザー名、パスワード)
    
    選択してください (1-3) >
    
  3. 希望する認証方式の番号 (例:1) を入力して、Enter を押します。

    ここでは、1 (AuthKeyId と AuthKey を入力する) の操作を説明します。

  4. ステップ 2: 認証情報を準備する で準備した認証情報 (ここでは、認証キー ID と認証キーシークレット) を以下のように入力します。

    authKeyId: (認証キー ID を入力して、Enter を押します。入力した内容が表示されます。)
    authKey: (認証キーシークレットを入力して、Enter を押します。入力した内容は表示されません。)
    
  5. 過去に SORACOM CLI を実行して、SORACOM プラットフォームにアクセスしたことがあれば、設定を上書きしてよいか確認するメッセージが表示されます。上書きする場合は Y を入力して Enter を押します。

    認証情報が プロファイル に保存されます。SORACOM CLI を実行するときは、プロファイルに記載されている認証情報を利用して認証が行われます。

プロファイルに記載されている認証情報が漏洩しないように、プロファイルのアクセス権限を慎重に管理してください。

使用できるコマンドを確認する