# Stellar CLI Manual This document contains the help content for the `stellar` command-line program. ## `stellar` Work seamlessly with Stellar accounts, contracts, and assets from the command line. - Generate and manage keys and accounts - Build, deploy, and interact with contracts - Deploy asset contracts - Stream events - Start local testnets - Decode, encode XDR - More! For additional information see: - Stellar Docs: https://developers.stellar.org - Smart Contract Docs: https://developers.stellar.org/docs/build/smart-contracts/overview - CLI Docs: https://developers.stellar.org/docs/tools/developer-tools/cli/stellar-cli To get started generate a new identity: stellar keys generate alice Use keys with the `--source` flag in other commands. Commands that work with contracts are organized under the `contract` subcommand. List them: stellar contract --help Use contracts like a CLI: stellar contract invoke --id CCR6QKTWZQYW6YUJ7UP7XXZRLWQPFRV6SWBLQS4ZQOSAF4BOUD77OTE2 --source alice --network testnet -- --help Anything after the `--` double dash (the "slop") is parsed as arguments to the contract-specific CLI, generated on-the-fly from the contract schema. For the hello world example, with a function called `hello` that takes one string argument `to`, here's how you invoke it: stellar contract invoke --id CCR6QKTWZQYW6YUJ7UP7XXZRLWQPFRV6SWBLQS4ZQOSAF4BOUD77OTE2 --source alice --network testnet -- hello --to world **Usage:** `stellar [OPTIONS] ` ###### **Subcommands:** - `contract` — Tools for smart contract developers - `doctor` — Diagnose and troubleshoot CLI and network issues - `events` — Watch the network for contract events - `env` — Prints the environment variables - `keys` — Create and manage identities including keys and addresses - `network` — Configure connection to networks - `container` — Start local networks in containers - `config` — Manage CLI configuration - `snapshot` — Download a snapshot of a ledger from an archive - `tx` — Sign, Simulate, and Send transactions - `xdr` — Decode and encode XDR - `strkey` — Decode and encode strkey - `completion` — Print shell completion code for the specified shell - `cache` — Cache for transactions and contract specs - `version` — Print version information - `plugin` — The subcommand for CLI plugins - `ledger` — Fetch ledger information - `fee-stats` — ⚠️ Deprecated, use `fees stats` instead. Fetch network feestats - `fees` — Fetch network feestats and configure CLI fee settings ###### **Options:** - `--list` — ⚠️ Deprecated, use `stellar plugin ls`. List installed plugins. E.g. `stellar-hello` ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `-f`, `--filter-logs ` — Filter logs output. To turn on `stellar_cli::log::footprint=debug` or off `=off`. Can also use env var `RUST_LOG` - `-q`, `--quiet` — Do not write logs to stderr including `INFO` - `-v`, `--verbose` — Log DEBUG events - `--very-verbose` [alias: `vv`] — Log DEBUG and TRACE events - `--no-cache` — Do not cache your simulations and transactions ## `stellar contract` Tools for smart contract developers **Usage:** `stellar contract ` ###### **Subcommands:** - `asset` — Utilities to deploy a Stellar Asset Contract or get its id - `alias` — Utilities to manage contract aliases - `bindings` — Generate code client bindings for a contract - `build` — Build a contract from source - `extend` — Extend the time to live ledger of a contract-data ledger entry - `deploy` — Deploy a wasm contract - `fetch` — Fetch a contract's Wasm binary - `id` — Generate the contract id for a given contract or asset - `info` — Access info about contracts - `init` — Initialize a Soroban contract project - `inspect` — ⚠️ Deprecated, use `contract info`. Inspect a WASM file listing contract functions, meta, etc - `upload` — Install a WASM file to the ledger without creating a contract instance - `install` — ⚠️ Deprecated, use `contract upload`. Install a WASM file to the ledger without creating a contract instance - `invoke` — Invoke a contract function - `optimize` — ⚠️ Deprecated, use `build --optimize`. Optimize a WASM file - `read` — Print the current value of a contract-data ledger entry - `restore` — Restore an evicted value for a contract-data legder entry ## `stellar contract asset` Utilities to deploy a Stellar Asset Contract or get its id **Usage:** `stellar contract asset ` ###### **Subcommands:** - `id` — Get Id of builtin Soroban Asset Contract. Deprecated, use `stellar contract id asset` instead - `deploy` — Deploy builtin Soroban Asset Contract ## `stellar contract asset id` Get Id of builtin Soroban Asset Contract. Deprecated, use `stellar contract id asset` instead **Usage:** `stellar contract asset id [OPTIONS] --asset ` ###### **Options:** - `--asset ` — ID of the Stellar classic asset to wrap, e.g. "native", "USDC:G...5", "USDC:alias" ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ###### **Options (RPC):** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config ## `stellar contract asset deploy` Deploy builtin Soroban Asset Contract **Usage:** `stellar contract asset deploy [OPTIONS] --asset --source-account ` ###### **Options:** - `--asset ` — ID of the Stellar classic asset to wrap, e.g. "USDC:G...5" - `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path - `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` - `--sign-with-lab` — Sign with https://lab.stellar.org - `--sign-with-ledger` — Sign with a ledger wallet - `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm - `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided - `--alias ` — The alias that will be used to save the assets's id. Whenever used, `--alias` will always overwrite the existing contract id configuration without asking for confirmation - `--build-only` — Build the transaction and only write the base64 xdr to stdout ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ###### **Options (RPC):** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config - `--resource-fee ` — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee - `--instructions ` — ⚠️ Deprecated, use `--instruction-leeway` to increase instructions. Number of instructions to allocate for the transaction - `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation - `--cost` — Output the cost execution to stderr ## `stellar contract alias` Utilities to manage contract aliases **Usage:** `stellar contract alias ` ###### **Subcommands:** - `remove` — Remove contract alias - `add` — Add contract alias - `show` — Show the contract id associated with a given alias - `ls` — List all aliases ## `stellar contract alias remove` Remove contract alias **Usage:** `stellar contract alias remove [OPTIONS] ` ###### **Arguments:** - `` — The contract alias that will be removed ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ###### **Options (RPC):** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config ## `stellar contract alias add` Add contract alias **Usage:** `stellar contract alias add [OPTIONS] --id ` ###### **Arguments:** - `` — The contract alias that will be used ###### **Options:** - `--overwrite` — Overwrite the contract alias if it already exists - `--id ` — The contract id that will be associated with the alias ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ###### **Options (RPC):** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config ## `stellar contract alias show` Show the contract id associated with a given alias **Usage:** `stellar contract alias show [OPTIONS] ` ###### **Arguments:** - `` — The contract alias that will be displayed ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ###### **Options (RPC):** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config ## `stellar contract alias ls` List all aliases **Usage:** `stellar contract alias ls [OPTIONS]` ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar contract bindings` Generate code client bindings for a contract **Usage:** `stellar contract bindings ` ###### **Subcommands:** - `json` — Generate Json Bindings - `rust` — Generate Rust bindings - `typescript` — Generate a TypeScript / JavaScript package - `python` — Generate Python bindings - `java` — Generate Java bindings - `flutter` — Generate Flutter bindings - `swift` — Generate Swift bindings - `php` — Generate PHP bindings ## `stellar contract bindings json` Generate Json Bindings **Usage:** `stellar contract bindings json --wasm ` ###### **Options:** - `--wasm ` — Path to wasm binary ## `stellar contract bindings rust` Generate Rust bindings **Usage:** `stellar contract bindings rust --wasm ` ###### **Options:** - `--wasm ` — Path to wasm binary ## `stellar contract bindings typescript` Generate a TypeScript / JavaScript package **Usage:** `stellar contract bindings typescript [OPTIONS] --output-dir <--wasm |--wasm-hash |--contract-id >` ###### **Options:** - `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` - `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` - `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` - `--output-dir ` — Where to place generated project - `--overwrite` — Whether to overwrite output directory if it already exists ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ###### **Options (RPC):** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config ## `stellar contract bindings python` Generate Python bindings **Usage:** `stellar contract bindings python` ## `stellar contract bindings java` Generate Java bindings **Usage:** `stellar contract bindings java` ## `stellar contract bindings flutter` Generate Flutter bindings **Usage:** `stellar contract bindings flutter` ## `stellar contract bindings swift` Generate Swift bindings **Usage:** `stellar contract bindings swift` ## `stellar contract bindings php` Generate PHP bindings **Usage:** `stellar contract bindings php` ## `stellar contract build` Build a contract from source Builds all crates that are referenced by the cargo manifest (Cargo.toml) that have cdylib as their crate-type. Crates are built for the wasm32 target. Unless configured otherwise, crates are built with their default features and with their release profile. In workspaces builds all crates unless a package name is specified, or the command is executed from the sub-directory of a workspace crate. To view the commands that will be executed, without executing them, use the --print-commands-only option. **Usage:** `stellar contract build [OPTIONS]` ###### **Features:** - `--features ` — Build with the list of features activated, space or comma separated - `--all-features` — Build with the all features activated - `--no-default-features` — Build with the default feature not activated ###### **Metadata:** - `--meta ` — Add key-value to contract meta (adds the meta to the `contractmetav0` custom section) ###### **Options:** - `--manifest-path ` — Path to Cargo.toml - `--package ` — Package to build If omitted, all packages that build for crate-type cdylib are built. - `--profile ` — Build with the specified profile Default value: `release` - `--out-dir ` — Directory to copy wasm files to If provided, wasm files can be found in the cargo target directory, and the specified directory. If ommitted, wasm files are written only to the cargo target directory. - `--optimize` — Optimize the generated wasm ###### **Other:** - `--print-commands-only` — Print commands to build without executing them ## `stellar contract extend` Extend the time to live ledger of a contract-data ledger entry. If no keys are specified the contract itself is extended. **Usage:** `stellar contract extend [OPTIONS] --ledgers-to-extend --source-account ` ###### **Options:** - `--ledgers-to-extend ` — Number of ledgers to extend the entries - `--ttl-ledger-only` — Only print the new Time To Live ledger - `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended - `--key ` — Storage key (symbols only) - `--key-xdr ` — Storage key (base64-encoded XDR) - `--wasm ` — Path to Wasm file of contract code to extend - `--wasm-hash ` — Path to Wasm file of contract code to extend - `--durability ` — Storage entry durability Default value: `persistent` Possible values: - `persistent`: Persistent - `temporary`: Temporary - `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path - `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` - `--sign-with-lab` — Sign with https://lab.stellar.org - `--sign-with-ledger` — Sign with a ledger wallet - `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm - `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided - `--build-only` — Build the transaction and only write the base64 xdr to stdout ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ###### **Options (RPC):** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config - `--resource-fee ` — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee - `--instructions ` — ⚠️ Deprecated, use `--instruction-leeway` to increase instructions. Number of instructions to allocate for the transaction - `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation - `--cost` — Output the cost execution to stderr ## `stellar contract deploy` Deploy a wasm contract **Usage:** `stellar contract deploy [OPTIONS] --source-account <--wasm |--wasm-hash > [-- ...]` ###### **Arguments:** - `` — If provided, will be passed to the contract's `__constructor` function with provided arguments for that function as `--arg-name value` ###### **Options:** - `--wasm ` — WASM file to deploy - `--wasm-hash ` — Hash of the already installed/deployed WASM file - `--salt ` — Custom salt 32-byte salt for the token id - `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path - `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` - `--sign-with-lab` — Sign with https://lab.stellar.org - `--sign-with-ledger` — Sign with a ledger wallet - `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm - `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided - `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts Default value: `false` - `--alias ` — The alias that will be used to save the contract's id. Whenever used, `--alias` will always overwrite the existing contract id configuration without asking for confirmation - `--build-only` — Build the transaction and only write the base64 xdr to stdout ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ###### **Options (RPC):** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config - `--resource-fee ` — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee - `--instructions ` — ⚠️ Deprecated, use `--instruction-leeway` to increase instructions. Number of instructions to allocate for the transaction - `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation - `--cost` — Output the cost execution to stderr ## `stellar contract fetch` Fetch a contract's Wasm binary **Usage:** `stellar contract fetch [OPTIONS]` ###### **Options:** - `--id ` — Contract ID to fetch - `--wasm-hash ` — Wasm to fetch - `-o`, `--out-file ` — Where to write output otherwise stdout is used ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ###### **Options (RPC):** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config ## `stellar contract id` Generate the contract id for a given contract or asset **Usage:** `stellar contract id ` ###### **Subcommands:** - `asset` — Deploy builtin Soroban Asset Contract - `wasm` — Deploy normal Wasm Contract ## `stellar contract id asset` Deploy builtin Soroban Asset Contract **Usage:** `stellar contract id asset [OPTIONS] --asset ` ###### **Options:** - `--asset ` — ID of the Stellar classic asset to wrap, e.g. "native", "USDC:G...5", "USDC:alias" ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ###### **Options (RPC):** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config ## `stellar contract id wasm` Deploy normal Wasm Contract **Usage:** `stellar contract id wasm [OPTIONS] --salt --source-account ` ###### **Options:** - `--salt ` — ID of the Soroban contract - `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path - `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` - `--sign-with-lab` — Sign with https://lab.stellar.org - `--sign-with-ledger` — Sign with a ledger wallet - `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm - `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ###### **Options (RPC):** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config ## `stellar contract info` Access info about contracts **Usage:** `stellar contract info ` ###### **Subcommands:** - `interface` — Output the interface of a contract - `meta` — Output the metadata stored in a contract - `env-meta` — Output the env required metadata stored in a contract - `build` — Output the contract build information, if available ## `stellar contract info interface` Output the interface of a contract. A contract's interface describes the functions, parameters, and types that the contract makes accessible to be called. The data outputted by this command is a stream of `SCSpecEntry` XDR values. See the type definitions in [stellar-xdr](https://github.com/stellar/stellar-xdr). [See also XDR data format](https://developers.stellar.org/docs/learn/encyclopedia/data-format/xdr). Outputs no data when no data is present in the contract. **Usage:** `stellar contract info interface [OPTIONS] <--wasm |--wasm-hash |--contract-id >` ###### **Options:** - `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` - `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` - `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` - `--output ` — Format of the output Default value: `rust` Possible values: - `rust`: Rust code output of the contract interface - `xdr-base64`: XDR output of the info entry - `json`: JSON output of the info entry (one line, not formatted) - `json-formatted`: Formatted (multiline) JSON output of the info entry ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ###### **Options (RPC):** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config ## `stellar contract info meta` Output the metadata stored in a contract. A contract's meta is a series of key-value pairs that the contract developer can set with any values to provided metadata about the contract. The meta also contains some information like the version of Rust SDK, and Rust compiler version. The data outputted by this command is a stream of `SCMetaEntry` XDR values. See the type definitions in [stellar-xdr](https://github.com/stellar/stellar-xdr). [See also XDR data format](https://developers.stellar.org/docs/learn/encyclopedia/data-format/xdr). Outputs no data when no data is present in the contract. **Usage:** `stellar contract info meta [OPTIONS] <--wasm |--wasm-hash |--contract-id >` ###### **Options:** - `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` - `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` - `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` - `--output ` — Format of the output Default value: `text` Possible values: - `text`: Text output of the meta info entry - `xdr-base64`: XDR output of the info entry - `json`: JSON output of the info entry (one line, not formatted) - `json-formatted`: Formatted (multiline) JSON output of the info entry ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ###### **Options (RPC):** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config ## `stellar contract info env-meta` Output the env required metadata stored in a contract. Env-meta is information stored in all contracts, in the `contractenvmetav0` WASM custom section, about the environment that the contract was built for. Env-meta allows the Soroban Env to know whether the contract is compatibility with the network in its current configuration. The data outputted by this command is a stream of `SCEnvMetaEntry` XDR values. See the type definitions in [stellar-xdr](https://github.com/stellar/stellar-xdr). [See also XDR data format](https://developers.stellar.org/docs/learn/encyclopedia/data-format/xdr). Outputs no data when no data is present in the contract. **Usage:** `stellar contract info env-meta [OPTIONS] <--wasm |--wasm-hash |--contract-id >` ###### **Options:** - `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` - `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` - `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` - `--output ` — Format of the output Default value: `text` Possible values: - `text`: Text output of the meta info entry - `xdr-base64`: XDR output of the info entry - `json`: JSON output of the info entry (one line, not formatted) - `json-formatted`: Formatted (multiline) JSON output of the info entry ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ###### **Options (RPC):** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config ## `stellar contract info build` Output the contract build information, if available. If the contract has a meta entry like `source_repo=github:user/repo`, this command will try to fetch the attestation information for the WASM file. **Usage:** `stellar contract info build [OPTIONS] <--wasm |--wasm-hash |--contract-id >` ###### **Options:** - `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` - `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` - `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ###### **Options (RPC):** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config ## `stellar contract init` Initialize a Soroban contract project. This command will create a Cargo workspace project and add a sample Stellar contract. The name of the contract can be specified by `--name`. It can be run multiple times with different names in order to generate multiple contracts, and files won't be overwritten unless `--overwrite` is passed. **Usage:** `stellar contract init [OPTIONS] ` ###### **Arguments:** - `` ###### **Options:** - `--name ` — An optional flag to specify a new contract's name. Default value: `hello-world` - `--overwrite` — Overwrite all existing files. ## `stellar contract inspect` ⚠️ Deprecated, use `contract info`. Inspect a WASM file listing contract functions, meta, etc **Usage:** `stellar contract inspect [OPTIONS] --wasm ` ###### **Options:** - `--wasm ` — Path to wasm binary - `--output ` — Output just XDR in base64 Default value: `docs` Possible values: - `xdr-base64`: XDR of array of contract spec entries - `xdr-base64-array`: Array of xdr of contract spec entries - `docs`: Pretty print of contract spec entries ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar contract upload` Install a WASM file to the ledger without creating a contract instance **Usage:** `stellar contract upload [OPTIONS] --source-account --wasm ` ###### **Options:** - `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path - `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` - `--sign-with-lab` — Sign with https://lab.stellar.org - `--sign-with-ledger` — Sign with a ledger wallet - `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm - `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided - `--wasm ` — Path to wasm binary - `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts Default value: `false` - `--build-only` — Build the transaction and only write the base64 xdr to stdout ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ###### **Options (RPC):** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config - `--resource-fee ` — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee - `--instructions ` — ⚠️ Deprecated, use `--instruction-leeway` to increase instructions. Number of instructions to allocate for the transaction - `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation - `--cost` — Output the cost execution to stderr ## `stellar contract install` ⚠️ Deprecated, use `contract upload`. Install a WASM file to the ledger without creating a contract instance **Usage:** `stellar contract install [OPTIONS] --source-account --wasm ` ###### **Options:** - `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path - `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` - `--sign-with-lab` — Sign with https://lab.stellar.org - `--sign-with-ledger` — Sign with a ledger wallet - `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm - `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided - `--wasm ` — Path to wasm binary - `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts Default value: `false` - `--build-only` — Build the transaction and only write the base64 xdr to stdout ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ###### **Options (RPC):** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config - `--resource-fee ` — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee - `--instructions ` — ⚠️ Deprecated, use `--instruction-leeway` to increase instructions. Number of instructions to allocate for the transaction - `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation - `--cost` — Output the cost execution to stderr ## `stellar contract invoke` Invoke a contract function Generates an "implicit CLI" for the specified contract on-the-fly using the contract's schema, which gets embedded into every Soroban contract. The "slop" in this command, everything after the `--`, gets passed to this implicit CLI. Get in-depth help for a given contract: stellar contract invoke ... -- --help **Usage:** `stellar contract invoke [OPTIONS] --id --source-account [-- ...]` ###### **Arguments:** - `` — Function name as subcommand, then arguments for that function as `--arg-name value` ###### **Options:** - `--id ` — Contract ID to invoke - `--is-view` — ⚠️ Deprecated, use `--send=no`. View the result simulating and do not sign and submit transaction - `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path - `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` - `--sign-with-lab` — Sign with https://lab.stellar.org - `--sign-with-ledger` — Sign with a ledger wallet - `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm - `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided - `--send ` — Whether or not to send a transaction Default value: `default` Possible values: - `default`: Send transaction if simulation indicates there are ledger writes, published events, or auth required, otherwise return simulation result - `no`: Do not send transaction, return simulation result - `yes`: Always send transaction - `--build-only` — Build the transaction and only write the base64 xdr to stdout ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ###### **Options (RPC):** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config - `--resource-fee ` — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee - `--instructions ` — ⚠️ Deprecated, use `--instruction-leeway` to increase instructions. Number of instructions to allocate for the transaction - `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation - `--cost` — Output the cost execution to stderr ## `stellar contract optimize` ⚠️ Deprecated, use `build --optimize`. Optimize a WASM file **Usage:** `stellar contract optimize [OPTIONS] --wasm ...` ###### **Options:** - `--wasm ` — Path to one or more wasm binaries - `--wasm-out ` — Path to write the optimized WASM file to (defaults to same location as --wasm with .optimized.wasm suffix) ## `stellar contract read` Print the current value of a contract-data ledger entry **Usage:** `stellar contract read [OPTIONS]` ###### **Options:** - `--output ` — Type of output to generate Default value: `string` Possible values: - `string`: String - `json`: Json - `xdr`: XDR - `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended - `--key ` — Storage key (symbols only) - `--key-xdr ` — Storage key (base64-encoded XDR) - `--wasm ` — Path to Wasm file of contract code to extend - `--wasm-hash ` — Path to Wasm file of contract code to extend - `--durability ` — Storage entry durability Default value: `persistent` Possible values: - `persistent`: Persistent - `temporary`: Temporary ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ###### **Options (RPC):** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config ## `stellar contract restore` Restore an evicted value for a contract-data legder entry. If no keys are specificed the contract itself is restored. **Usage:** `stellar contract restore [OPTIONS] --source-account ` ###### **Options:** - `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended - `--key ` — Storage key (symbols only) - `--key-xdr ` — Storage key (base64-encoded XDR) - `--wasm ` — Path to Wasm file of contract code to extend - `--wasm-hash ` — Path to Wasm file of contract code to extend - `--durability ` — Storage entry durability Default value: `persistent` Possible values: - `persistent`: Persistent - `temporary`: Temporary - `--ledgers-to-extend ` — Number of ledgers to extend the entry - `--ttl-ledger-only` — Only print the new Time To Live ledger - `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path - `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` - `--sign-with-lab` — Sign with https://lab.stellar.org - `--sign-with-ledger` — Sign with a ledger wallet - `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm - `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided - `--build-only` — Build the transaction and only write the base64 xdr to stdout ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ###### **Options (RPC):** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config - `--resource-fee ` — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee - `--instructions ` — ⚠️ Deprecated, use `--instruction-leeway` to increase instructions. Number of instructions to allocate for the transaction - `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation - `--cost` — Output the cost execution to stderr ## `stellar doctor` Diagnose and troubleshoot CLI and network issues **Usage:** `stellar doctor [OPTIONS]` ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar events` Watch the network for contract events **Usage:** `stellar events [OPTIONS]` ###### **FILTERS:** - `--id ` — A set of (up to 5) contract IDs to filter events on. This parameter can be passed multiple times, e.g. `--id C123.. --id C456..`, or passed with multiple parameters, e.g. `--id C123 C456`. Though the specification supports multiple filter objects (i.e. combinations of type, IDs, and topics), only one set can be specified on the command-line today, though that set can have multiple IDs/topics. - `--topic ` — A set of (up to 5) topic filters to filter event topics on. A single topic filter can contain 1-4 different segments, separated by commas. An asterisk (`*` character) indicates a wildcard segment. In addition to up to 4 possible topic filter segments, the "**" wildcard can also be added, and will allow for a flexible number of topics in the returned events. The "**" wildcard must be the last segment in a query. If the "\*\*" wildcard is not included, only events with the exact number of topics as the given filter will be returned. **Example:** topic filter with two segments: `--topic "AAAABQAAAAdDT1VOVEVSAA==,*"` **Example:** two topic filters with one and two segments each: `--topic "AAAABQAAAAdDT1VOVEVSAA==" --topic '*,*'` **Example:** topic filter with four segments and the "**" wildcard: --topic "AAAABQAAAAdDT1VOVEVSAA==,_,_,\*,**" Note that all of these topic filters are combined with the contract IDs into a single filter (i.e. combination of type, IDs, and topics). - `--type ` — Specifies which type of contract events to display Default value: `all` Possible values: `all`, `contract`, `system` ###### **Options:** - `--start-ledger ` — The first ledger sequence number in the range to pull events https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/ledger-headers#ledger-sequence - `--cursor ` — The cursor corresponding to the start of the event range - `--output ` — Output formatting options for event stream Default value: `pretty` Possible values: - `pretty`: Colorful, human-oriented console output - `plain`: Human-oriented console output without colors - `json`: JSON formatted console output - `-c`, `--count ` — The maximum number of events to display (defer to the server-defined limit) Default value: `10` ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ###### **Options (RPC):** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config ## `stellar env` Prints the environment variables Prints to stdout in a format that can be used as .env file. Environment variables have precedence over defaults. Pass a name to get the value of a single environment variable. If there are no environment variables in use, prints the defaults. **Usage:** `stellar env [OPTIONS] [NAME]` ###### **Arguments:** - `` — Env variable name to get the value of. E.g.: $ stellar env STELLAR_ACCOUNT ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar keys` Create and manage identities including keys and addresses **Usage:** `stellar keys ` ###### **Subcommands:** - `add` — Add a new identity (keypair, ledger, OS specific secure store) - `public-key` — Given an identity return its address (public key) - `fund` — Fund an identity on a test network - `generate` — Generate a new identity using a 24-word seed phrase The seed phrase can be stored in a config file (default) or in an OS-specific secure store - `ls` — List identities - `rm` — Remove an identity - `secret` — Output an identity's secret key - `use` — Set the default identity that will be used on all commands. This allows you to skip `--source-account` or setting a environment variable, while reusing this value in all commands that require it - `unset` — Unset the default key identity defined previously with `keys use ` ## `stellar keys add` Add a new identity (keypair, ledger, OS specific secure store) **Usage:** `stellar keys add [OPTIONS] ` ###### **Arguments:** - `` — Name of identity ###### **Options:** - `--secret-key` — ⚠️ Deprecated, use `--secure-store`. Enter secret (S) key when prompted - `--seed-phrase` — ⚠️ Deprecated, use `--secure-store`. Enter key using 12-24 word seed phrase - `--secure-store` — Save the new key in your OS's credential secure store. On Mac this uses Keychain, on Windows it is Secure Store Service, and on \*nix platforms it uses a combination of the kernel keyutils and DBus-based Secret Service. This only supports seed phrases for now. - `--public-key ` — Add a public key, ed25519, or muxed account, e.g. G1.., M2.. - `--overwrite` — Overwrite existing identity if it already exists ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar keys public-key` Given an identity return its address (public key) **Usage:** `stellar keys public-key [OPTIONS] ` **Command Alias:** `address` ###### **Arguments:** - `` — Name of identity to lookup, default test identity used if not provided ###### **Options:** - `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar keys fund` Fund an identity on a test network **Usage:** `stellar keys fund [OPTIONS] ` ###### **Arguments:** - `` — Name of identity to lookup, default test identity used if not provided ###### **Options:** - `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ###### **Options (RPC):** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config ## `stellar keys generate` Generate a new identity using a 24-word seed phrase The seed phrase can be stored in a config file (default) or in an OS-specific secure store **Usage:** `stellar keys generate [OPTIONS] ` ###### **Arguments:** - `` — Name of identity ###### **Options:** - `--seed ` — Optional seed to use when generating seed phrase. Random otherwise - `-s`, `--as-secret` — Output the generated identity as a secret key - `--secure-store` — Save the new key in your OS's credential secure store. On Mac this uses Keychain, on Windows it is Secure Store Service, and on \*nix platforms it uses a combination of the kernel keyutils and DBus-based Secret Service. - `--hd-path ` — When generating a secret key, which `hd_path` should be used from the original `seed_phrase` - `--fund` — Fund generated key pair Default value: `false` - `--overwrite` — Overwrite existing identity if it already exists ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ###### **Options (RPC):** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config ## `stellar keys ls` List identities **Usage:** `stellar keys ls [OPTIONS]` ###### **Options:** - `-l`, `--long` ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar keys rm` Remove an identity **Usage:** `stellar keys rm [OPTIONS] ` ###### **Arguments:** - `` — Identity to remove ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar keys secret` Output an identity's secret key **Usage:** `stellar keys secret [OPTIONS] ` ###### **Arguments:** - `` — Name of identity to lookup, default is test identity ###### **Options:** - `--phrase` — Output seed phrase instead of private key - `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar keys use` Set the default identity that will be used on all commands. This allows you to skip `--source-account` or setting a environment variable, while reusing this value in all commands that require it **Usage:** `stellar keys use [OPTIONS] ` ###### **Arguments:** - `` — Set the default network name ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar keys unset` Unset the default key identity defined previously with `keys use ` **Usage:** `stellar keys unset [OPTIONS]` ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar network` Configure connection to networks **Usage:** `stellar network ` ###### **Subcommands:** - `add` — Add a new network - `rm` — Remove a network - `ls` — List networks - `use` — Set the default network that will be used on all commands. This allows you to skip `--network` or setting a environment variable, while reusing this value in all commands that require it - `health` — Fetch the health of the configured RPC - `info` — Checks the health of the configured RPC - `settings` — Fetch the network's config settings - `unset` — Unset the default network defined previously with `network use ` ## `stellar network add` Add a new network **Usage:** `stellar network add [OPTIONS] --rpc-url --network-passphrase ` ###### **Arguments:** - `` — Name of network ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ###### **Options (RPC):** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — Optional header to include in requests to the RPC, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server ## `stellar network rm` Remove a network **Usage:** `stellar network rm [OPTIONS] ` ###### **Arguments:** - `` — Network to remove ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar network ls` List networks **Usage:** `stellar network ls [OPTIONS]` ###### **Options:** - `-l`, `--long` — Get more info about the networks ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar network use` Set the default network that will be used on all commands. This allows you to skip `--network` or setting a environment variable, while reusing this value in all commands that require it **Usage:** `stellar network use [OPTIONS] ` ###### **Arguments:** - `` — Set the default network name ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar network health` Fetch the health of the configured RPC **Usage:** `stellar network health [OPTIONS]` ###### **Options:** - `--output ` — Format of the output Default value: `text` Possible values: - `text`: Text output of network health status - `json`: JSON result of the RPC request - `json-formatted`: Formatted (multiline) JSON output of the RPC request ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ###### **Options (RPC):** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config ## `stellar network info` Checks the health of the configured RPC **Usage:** `stellar network info [OPTIONS]` ###### **Options:** - `--output ` — Format of the output Default value: `text` Possible values: - `text`: Text output of network info - `json`: JSON result of the RPC request - `json-formatted`: Formatted (multiline) JSON output of the RPC request ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ###### **Options (RPC):** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config ## `stellar network settings` Fetch the network's config settings **Usage:** `stellar network settings [OPTIONS]` ###### **Options:** - `--internal` — Include internal config settings that are not upgradeable and are internally maintained by the network - `--output ` — Format of the output Default value: `json` Possible values: - `xdr`: XDR (`ConfigUpgradeSet` type) - `json`: JSON, XDR-JSON of the `ConfigUpgradeSet` XDR type - `json-formatted`: JSON formatted, XDR-JSON of the `ConfigUpgradeSet` XDR type ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ###### **Options (RPC):** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config ## `stellar network unset` Unset the default network defined previously with `network use ` **Usage:** `stellar network unset [OPTIONS]` ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar container` Start local networks in containers **Usage:** `stellar container ` ###### **Subcommands:** - `logs` — Get logs from a running network container - `start` — Start a container running a Stellar node, RPC, API, and friendbot (faucet) - `stop` — Stop a network container started with `stellar container start` ## `stellar container logs` Get logs from a running network container **Usage:** `stellar container logs [OPTIONS] [NAME]` ###### **Arguments:** - `` — Container to get logs from Default value: `local` ###### **Options:** - `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock ## `stellar container start` Start a container running a Stellar node, RPC, API, and friendbot (faucet). `stellar container start NETWORK [OPTIONS]` By default, when starting a testnet container, without any optional arguments, it will run the equivalent of the following docker command: `docker run --rm -p 8000:8000 --name stellar stellar/quickstart:testing --testnet --enable rpc,horizon` **Usage:** `stellar container start [OPTIONS] [NETWORK]` ###### **Arguments:** - `` — Network to start. Default is `local` Possible values: `local`, `testnet`, `futurenet`, `pubnet` ###### **Options:** - `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock - `--name ` — Optional argument to specify the container name - `-l`, `--limits ` — Optional argument to specify the limits for the local network only - `-p`, `--ports-mapping ` — Argument to specify the `HOST_PORT:CONTAINER_PORT` mapping Default value: `8000:8000` - `-t`, `--image-tag-override ` — Optional argument to override the default docker image tag for the given network - `--protocol-version ` — Optional argument to specify the protocol version for the local network only ## `stellar container stop` Stop a network container started with `stellar container start` **Usage:** `stellar container stop [OPTIONS] [NAME]` ###### **Arguments:** - `` — Container to stop Default value: `local` ###### **Options:** - `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock ## `stellar config` Manage CLI configuration **Usage:** `stellar config ` ###### **Subcommands:** - `migrate` — Migrate the local configuration to the global directory - `dir` — Show the global configuration directory ## `stellar config migrate` Migrate the local configuration to the global directory **Usage:** `stellar config migrate [OPTIONS]` ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar config dir` Show the global configuration directory. The location will depend on how your system is configured. - It looks up for `XDG_CONFIG_HOME` environment variable. If it's set, `$XDG_CONFIG_HOME/stellar` will be used. - If not set, it defaults to `$HOME/.config`. - Can be overridden by `--config-dir` flag. **Usage:** `stellar config dir [OPTIONS]` ###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar snapshot` Download a snapshot of a ledger from an archive **Usage:** `stellar snapshot ` ###### **Subcommands:** - `create` — Create a ledger snapshot using a history archive - `merge` — Merge multiple ledger snapshots into a single snapshot file ## `stellar snapshot create` Create a ledger snapshot using a history archive. Filters (address, wasm-hash) specify what ledger entries to include. Account addresses include the account, and trustlines. Contract addresses include the related wasm, contract data. If a contract is a Stellar asset contract, it includes the asset issuer's account and trust lines, but does not include all the trust lines of other accounts holding the asset. To include them specify the addresses of relevant accounts. Any invalid contract id passed as `--address` will be ignored. **Usage:** `stellar snapshot create [OPTIONS]` ###### **Filter Options:** - `--address