Command Structure
soracom-cli commands follow the pattern soracom <resource> <action> [options]. The resource identifies what you are working with (sims, groups, subscribers, etc.) and the action specifies the operation (list, get, create, etc.).
Global Flags
The following flags are available on all commands.
| Flag | Description |
|---|---|
--coverage-type | Specify coverage type (g: global, jp: japan) |
--profile | Specify the profile name to use |
--output-type | Specify output format (json, table, tsv, raw) |
--body | Request body as a JSON string |
Commands
A list of the primary resource categories and their key commands.
| Command | Description |
|---|---|
soracom sims | Manage SIMs (list, get, update status, set tags) |
soracom groups | Manage groups (list, create, update configuration) |
soracom subscribers | Manage subscribers (list, get, change status) |
soracom users | Manage SAM users (list, create, set permissions) |
soracom operator | Get and update operator information |
soracom query | Search and filter resources |
Output Formats
soracom-cli supports multiple output formats. Use the --output-type flag to switch between them.
- json - JSON — Default output format. Best for structured data
- table - table — Human-readable table format
- tsv - tsv — Tab-separated values. Useful for scripts and spreadsheets
- raw - raw — Raw API response output