stellar
Build, sign, and deploy on the Stellar network
TLDR
SYNOPSIS
stellar [OPTIONS] COMMAND
DESCRIPTION
stellar is the command-line client for the Stellar network. The binary name is stellar. The Rust package is stellar-cli. It builds Soroban contracts, manages identities and networks, signs and sends transactions, and talks to a local network container.Top-level commands:- contract — compile, deploy, invoke, and inspect smart contracts- doctor — check the local setup- events — read contract events- env — environment helpers- keys — identities- network — named networks, including network ls- container — local networks- config — client configuration- snapshot — ledger snapshots- token — SEP-41 / SAC tokens- tx — sign, simulate, and send transactions- xdr — encode and decode XDR- strkey — StrKey helpers- completion — shell completion- cache — local cache- version — version- skill — print a guide meant for an AI agent- plugin — plugins- ledger — ledger queries- message — SEP-53 sign and verify- fees — fee stats- fee-stats — deprecated name of fees statsGlobal options:- --config-dir — configuration directory. The default is ~/.config/stellar, or the stellar directory under XDG config home- -f, --filter-logs — log filter. The same filter is read from the Rust log variable- -q, --quiet- -v, --verbose- --very-verbose (also vv)- --no-cacheEach command has its own flags. stellar contract --help and the same form for the other commands print them.
CONFIGURATION
Configuration lives in the directory from --config-dir. Identities created with keys generate and networks added with the network command are stored there.
INSTALL
CAVEATS
--fund and deploy commands submit transactions. A network name of mainnet spends real lumens. fee-stats is deprecated in favor of fees stats.Distro packages named stellar are often the unrelated stellar-core daemon. This client is the stellar-cli package when a distribution ships it under that name.
