CLI Usage Guide

Installation

soracom-cli is available for macOS, Linux, and Windows. Install via Homebrew, binary download, or Docker.

Homebrew (macOS / Linux)

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

Binary Download

Download the latest binary from the GitHub releases page and place it in a directory on your PATH.

Configuration

Run soracom configure to set up your credentials. You will be prompted for coverage type (global or japan), authentication method, and credentials.

1. Run soracom configure
2. Select your coverage type (global or japan)
3. Enter your credentials (AuthKeyId and AuthKey recommended)

soracom configure

First Commands

Once configured, try these commands to verify your setup.

List your SIMs

soracom sims list

Get operator info

soracom operator get

List groups

soracom groups list

Common Workflows

Here are some common tasks you can accomplish with soracom-cli.

Change SIM Status

Use soracom sims update-speed-class to change the speed class of a SIM.

Export Data

Combine soracom query commands with jq to export data in CSV or JSON format.

Batch Operations

Combine shell scripts and loops to perform batch operations across multiple SIMs.

See Also

View the CLI Reference