CLI Reference
Quick Reference
Section titled “Quick Reference”| Command | Description | Reference |
|---|---|---|
balance | Check SOMA balance | Common Commands |
send | Send SOMA to a recipient | Common Commands |
transfer | Transfer an object | Common Commands |
pay | Pay SOMA to multiple recipients | Common Commands |
stake | Stake SOMA with a validator or model | Common Commands |
unstake | Withdraw staked SOMA | Common Commands |
faucet | Request test tokens | Common Commands |
status | Show network status | Common Commands |
objects | Query owned objects | Query Commands |
tx | Inspect and execute transactions | Query Commands |
wallet | Manage addresses and keys | Management Commands |
env | Manage environments | Management Commands |
model | Register and manage models | Submission Commands |
target | List targets and submit data | Submission Commands |
challenge | Submit fraud challenges | Submission Commands |
validator | Validator operations | Operators & Nodes |
start | Start nodes and services | Operators & Nodes |
network | Inspect network configuration | Operators & Nodes |
genesis | Bootstrap a new network | Operators & Nodes |
keytool | Low-level key management | Operators & Nodes |
completions | Generate shell completions | Operators & Nodes |
Global Options
Section titled “Global Options”These flags apply to all commands.
| Option | Description |
|---|---|
--client.config <PATH> | Path to the file storing user account state |
--client.env <ENV> | SOMA environment to use (must exist in current config) |
-y, --yes | Create new soma config without prompting if none exists |
--json | Output as JSON (available on most commands) |
Transaction Processing Arguments
Section titled “Transaction Processing Arguments”| Option | Description |
|---|---|
--tx-digest | Compute the transaction digest and print it without executing |
--simulate | Perform a dry run (simulation) without executing |
--serialize-unsigned-transaction | Serialize unsigned transaction data as base64 instead of executing |
--serialize-signed-transaction | Serialize signed transaction data as base64 instead of executing |
Configuration
Section titled “Configuration”| File | Description |
|---|---|
~/.soma/soma.yaml | Client config — RPC URL, active environment, active address |
soma.keystore | Encrypted keystore for account keys |
network-config.yaml | Local network validator configs (created by genesis) |
genesis.blob | Serialized genesis state (created by genesis) |
fullnode-config.yaml | Fullnode configuration (created by start localnet) |
Environment Variables
Section titled “Environment Variables”| Variable | Description |
|---|---|
RUST_LOG | Set log verbosity (e.g. info, debug, soma=trace) |
Exit Codes
Section titled “Exit Codes”| Code | Meaning |
|---|---|
0 | Success |
1 | Error |