コマンド構造
soracom-cli のコマンドは soracom <リソース> <アクション> [オプション] の形式に従います。リソースは操作対象(sims、groups、subscribers など)、アクションは実行する操作(list、get、create など)です。
soracom <resource> <action> [options] グローバルフラグ
以下のフラグはすべてのコマンドで使用できます。
| フラグ | 説明 |
|---|---|
--coverage-type | カバレッジタイプを指定(g: グローバル、jp: 日本) |
--profile | 使用するプロファイル名を指定 |
--output-type | 出力フォーマットを指定(json、table、tsv、raw) |
--body | リクエストボディを JSON 文字列で指定 |
コマンド一覧
主要なリソースカテゴリと代表的なコマンドの一覧です。
soracom sims- SIM の管理(一覧、詳細、ステータス変更、タグ設定)
soracom groups- グループの管理(一覧、作成、設定の更新)
soracom subscribers- サブスクライバーの管理(一覧、詳細取得、ステータス変更)
soracom users- SAM ユーザーの管理(一覧、作成、権限設定)
soracom operator- オペレーター情報の取得と更新
soracom query- リソースの検索とフィルタリング
出力フォーマット
soracom-cli は複数の出力フォーマットをサポートしています。--output-type フラグで切り替えられます。
- json — JSON — デフォルトの出力形式。構造化データに最適
- table — table — 人間が読みやすいテーブル形式
- tsv — tsv — タブ区切り。スクリプトやスプレッドシートとの連携に便利
- raw — raw — API レスポンスそのままの出力