本文へスキップ

CLI リファレンス

soracom-cli のコマンド構造、グローバルフラグ、出力フォーマット

コピー/保存

コマンド構造

soracom-cli のコマンドは soracom <リソース> <アクション> [オプション] の形式に従います。リソースは操作対象(sims、groups、subscribers など)、アクションは実行する操作(list、get、create など)です。

グローバルフラグ

以下のフラグはすべてのコマンドで使用できます。

フラグ説明
--coverage-typeカバレッジタイプを指定(g: グローバル、jp: 日本)
--profile使用するプロファイル名を指定
--output-type出力フォーマットを指定(json、table、tsv、raw)
--bodyリクエストボディを JSON 文字列で指定

コマンド一覧

主要なリソースカテゴリと代表的なコマンドの一覧です。

コマンド説明
soracom simsSIM の管理(一覧、詳細、ステータス変更、タグ設定)
soracom groupsグループの管理(一覧、作成、設定の更新)
soracom subscribersサブスクライバーの管理(一覧、詳細取得、ステータス変更)
soracom usersSAM ユーザーの管理(一覧、作成、権限設定)
soracom operatorオペレーター情報の取得と更新
soracom queryリソースの検索とフィルタリング

出力フォーマット

soracom-cli は複数の出力フォーマットをサポートしています。--output-type フラグで切り替えられます。

  • json - JSON — デフォルトの出力形式。構造化データに最適
  • table - table — 人間が読みやすいテーブル形式
  • tsv - tsv — タブ区切り。スクリプトやスプレッドシートとの連携に便利
  • raw - raw — API レスポンスそのままの出力

関連リソース

CLI 利用ガイドを見る)

検索 Escで閉じる / Enterで検索結果