# 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 --contract-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 --contract-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 - `token` — Interact with SEP-41 tokens and Stellar Asset Contracts - `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 - `skill` — Print an AI-agent skill guide for using the Stellar CLI - `plugin` — The subcommand for CLI plugins - `ledger` — Fetch ledger information - `message` — Sign and verify arbitrary messages using SEP-53 - `fee-stats` — ⚠️ Deprecated, use `fees stats` instead. Fetch network feestats - `fees` — Fetch network feestats and configure CLI fee settings ###### **Global Options:** - `--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 ` ###### **Global Options:** - `--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:** - `--asset ` — ID of the Stellar classic asset to wrap, e.g. "native", "USDC:G...5", "USDC:alias" ###### **RPC Options:** - `--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 ` ###### **Global Options:** - `--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:** - `--asset ` — ID of the Stellar classic asset to wrap, e.g. "USDC:G...5" - `--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 ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar contract alias` Utilities to manage contract aliases **Usage:** `stellar contract alias ` ###### **Subcommands:** - `rm` — Remove contract alias - `add` — Add contract alias - `show` — Show the contract id associated with a given alias - `ls` — List all aliases ## `stellar contract alias rm` Remove contract alias **Usage:** `stellar contract alias rm [OPTIONS] ` **Command Alias:** `remove` ###### **Arguments:** - `` — The contract alias that will be removed ###### **Global Options:** - `--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 ###### **RPC Options:** - `--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] --contract-id ` ###### **Arguments:** - `` — The contract alias that will be used ###### **Global Options:** - `--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:** - `--overwrite` — Overwrite the contract alias if it already exists - `--contract-id ` [alias: `id`] — The contract id that will be associated with the alias ###### **RPC Options:** - `--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 ###### **Global Options:** - `--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 ###### **RPC Options:** - `--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]` ###### **Global Options:** - `--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:** - `rust` — Generate Rust bindings - `typescript` — ⚠️ Deprecated, use the JavaScript Stellar SDK instead (https://github.com/stellar/js-stellar-sdk#cli). Generate a TypeScript / JavaScript package - `python` — Generate Python bindings (requires external plugin) - `java` — Generate Java bindings (requires external plugin) - `flutter` — Generate Flutter bindings (requires external plugin) - `swift` — Generate Swift bindings (requires external plugin) - `php` — Generate PHP bindings (requires external plugin) - `kmp` — Generate Kotlin Multiplatform bindings (requires external plugin) ## `stellar contract bindings rust` Generate Rust bindings **Usage:** `stellar contract bindings rust --wasm ` ###### **Options:** - `--wasm ` — Path to wasm binary ## `stellar contract bindings typescript` ⚠️ Deprecated, use the JavaScript Stellar SDK instead (https://github.com/stellar/js-stellar-sdk#cli). Generate a TypeScript / JavaScript package **Usage:** `stellar contract bindings typescript [OPTIONS] --output-dir <--wasm |--wasm-hash |--contract-id >` ###### **Global Options:** - `--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:** - `--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 ###### **RPC Options:** - `--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 (requires external plugin) **Usage:** `stellar contract bindings python` ## `stellar contract bindings java` Generate Java bindings (requires external plugin) **Usage:** `stellar contract bindings java` ## `stellar contract bindings flutter` Generate Flutter bindings (requires external plugin) **Usage:** `stellar contract bindings flutter` ## `stellar contract bindings swift` Generate Swift bindings (requires external plugin) **Usage:** `stellar contract bindings swift` ## `stellar contract bindings php` Generate PHP bindings (requires external plugin) **Usage:** `stellar contract bindings php` ## `stellar contract bindings kmp` Generate Kotlin Multiplatform bindings (requires external plugin) **Usage:** `stellar contract bindings kmp` ## `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] build ` ###### **Subcommands:** - `archive` — Generate (or inspect) the reproducible source archive for a contract ###### **Container Options:** - `--image ` — Build inside this container image (e.g. `docker.io/stellar/stellar-cli:latest`). When set, the build runs in the container against the bind-mounted working tree instead of locally. Any tag or digest ref is accepted. On Linux the container runs as your uid:gid so built wasm isn't root-owned; this assumes the image keeps CARGO_HOME/RUSTUP_HOME writable by non-root users, as the official image does. - `--pull` — Pull `--image` before building to refresh a moving tag. By default the build uses the image already present locally and doesn't pull (matching `docker run`), so a locally-built or digest-pinned image is used as-is. Pass `--pull` to fetch the newest image for the tag first. - `-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 - `--engine ` — Container engine to use [default: docker] Possible values: - `docker`: Docker, or any Docker-compatible CLI - `apple-container`: Apple's `container` CLI (macOS 26+, Apple silicon) - `--cpus ` — Limit the number of CPUs available to the container, e.g. `2`. A whole number: Apple's `container` engine does not accept fractional CPUs - `--memory ` — Limit the memory available to the container, e.g. `2g` or `512m` ###### **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. - `--locked` — Assert that `Cargo.lock` will remain unchanged - `--optimize ` — Optimize the generated wasm. Enabled by default; pass `--optimize=false` to disable. Requires the `additional-libs` feature Default value: `true` Possible values: `true`, `false` ###### **Other:** - `--print-commands-only` — Print commands to build without executing them ## `stellar contract build archive` Generate (or inspect) the reproducible source archive for a contract. Produces a gzipped tarball of the source tree and prints its SHA-256 (the SEP-58 `source_sha256`). Use `--dry-run` to list exactly what would be archived without writing anything — handy for confirming the contents before publishing the archive. The archive is the current working directory, honoring the project's `.gitignore` and `.ignore` files (the `.git` directory itself is always skipped). Run this from the project (or workspace) root you want archived. **Usage:** `stellar contract build archive [OPTIONS]` ###### **Options:** - `-o`, `--out-file ` — Where to write the gzipped tarball. Required unless `--dry-run` is used - `--dry-run` — List the entries that would be archived and the computed source_sha256, without writing any file ## `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 ` ###### **Global Options:** - `--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:** - `--ledgers-to-extend ` — Number of ledgers to extend the entries - `--ttl-ledger-only` — Only print the new Time To Live ledger - `--contract-id ` [alias: `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 ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar contract deploy` Deploy a wasm contract **Usage:** `stellar contract deploy [OPTIONS] --source-account [-- ...]` ###### **Arguments:** - `` — If provided, will be passed to the contract's `__constructor` function with provided arguments for that function as `--arg-name value` ###### **Build Options:** - `--package ` — Package to build when auto-building without --wasm ###### **Global Options:** - `--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 ###### **Metadata:** - `--meta ` — Add key-value to contract meta (adds the meta to the `contractmetav0` custom section) ###### **Options:** - `--wasm ` — WASM file to deploy. When neither --wasm nor --wasm-hash is provided inside a Cargo workspace, builds the project automatically. One of --wasm or --wasm-hash is required when outside a Cargo workspace - `--wasm-hash ` — Hash of the already installed/deployed WASM file - `--salt ` — Custom salt 32-byte salt for the token id - `-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 - `--optimize ` — Optimize the generated wasm. Enabled by default; pass `--optimize=false` to disable. Requires the `additional-libs` feature Default value: `true` Possible values: `true`, `false` ###### **RPC Options:** - `--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 - `--auth-mode ` — Set the authorization mode for transaction simulation. When unset, the RPC default is used: record with the root mode if no authorization entries exist, otherwise enforce the provided entries. Should only be set for `InvokeHostFunction` transactions. The `enforce` mode is for simulating transactions that already contain authorization entries Possible values: - `enforce`: Validate the authorization entries already on the transaction - `root`: Record authorization entries, requiring each to be rooted at the transaction's top-level operation - `non-root`: Record all authorization entries, including non-root entries ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar contract fetch` Fetch a contract's Wasm binary **Usage:** `stellar contract fetch [OPTIONS]` ###### **Global Options:** - `--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:** - `--contract-id ` [alias: `id`] — Contract ID to fetch - `--wasm-hash ` — Wasm to fetch - `-o`, `--out-file ` — Where to write output otherwise stdout is used ###### **RPC Options:** - `--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` — Derive the contract id for a builtin Stellar Asset Contract - `wasm` — Derive the contract id for a Wasm contract ## `stellar contract id asset` Derive the contract id for a builtin Stellar Asset Contract **Usage:** `stellar contract id asset [OPTIONS] --asset ` ###### **Global Options:** - `--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:** - `--asset ` — ID of the Stellar classic asset to wrap, e.g. "native", "USDC:G...5", "USDC:alias" ###### **RPC Options:** - `--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` Derive the contract id for a Wasm contract **Usage:** `stellar contract id wasm [OPTIONS] --salt --source-account ` ###### **Global Options:** - `--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:** - `--salt ` — ID of the Soroban contract ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `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 - `hash` — Output the SHA-256 hash of a contract's Wasm ## `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 >` ###### **Global Options:** - `--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:** - `--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 ###### **RPC Options:** - `--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 >` ###### **Global Options:** - `--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:** - `--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 ###### **RPC Options:** - `--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 >` ###### **Global Options:** - `--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:** - `--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 ###### **RPC Options:** - `--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 >` ###### **Global Options:** - `--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:** - `--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` ###### **RPC Options:** - `--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 hash` Output the SHA-256 hash of a contract's Wasm. The hash can be computed from a local .wasm file (`--wasm`) or read from a deployed contract (`--id`). The two flags are mutually exclusive. Stellar Asset Contracts have no Wasm and therefore no hash; using `--id` against a SAC will return an error. **Usage:** `stellar contract info hash [OPTIONS] <--wasm |--contract-id >` ###### **Global Options:** - `--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:** - `--wasm ` — Path to a local .wasm file - `--contract-id ` [alias: `id`] — Contract ID or alias of a deployed contract ###### **RPC Options:** - `--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 ` ###### **Global Options:** - `--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:** - `--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 ## `stellar contract upload` Install a WASM file to the ledger without creating a contract instance **Usage:** `stellar contract upload [OPTIONS] --source-account ` ###### **Build Options:** - `--package ` — Package to build when --wasm is not provided ###### **Global Options:** - `--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 ###### **Metadata:** - `--meta ` — Add key-value to contract meta (adds the meta to the `contractmetav0` custom section) ###### **Options:** - `--wasm ` — Path to wasm binary. When omitted inside a Cargo workspace, builds the project automatically. Required when outside a Cargo workspace - `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts Default value: `false` - `--optimize ` — Optimize the generated wasm. Enabled by default; pass `--optimize=false` to disable. Requires the `additional-libs` feature Default value: `true` Possible values: `true`, `false` ###### **RPC Options:** - `--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 - `--auth-mode ` — Set the authorization mode for transaction simulation. When unset, the RPC default is used: record with the root mode if no authorization entries exist, otherwise enforce the provided entries. Should only be set for `InvokeHostFunction` transactions. The `enforce` mode is for simulating transactions that already contain authorization entries Possible values: - `enforce`: Validate the authorization entries already on the transaction - `root`: Record authorization entries, requiring each to be rooted at the transaction's top-level operation - `non-root`: Record all authorization entries, including non-root entries ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `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 ` ###### **Build Options:** - `--package ` — Package to build when --wasm is not provided ###### **Global Options:** - `--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 ###### **Metadata:** - `--meta ` — Add key-value to contract meta (adds the meta to the `contractmetav0` custom section) ###### **Options:** - `--wasm ` — Path to wasm binary. When omitted inside a Cargo workspace, builds the project automatically. Required when outside a Cargo workspace - `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts Default value: `false` - `--optimize ` — Optimize the generated wasm. Enabled by default; pass `--optimize=false` to disable. Requires the `additional-libs` feature Default value: `true` Possible values: `true`, `false` ###### **RPC Options:** - `--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 - `--auth-mode ` — Set the authorization mode for transaction simulation. When unset, the RPC default is used: record with the root mode if no authorization entries exist, otherwise enforce the provided entries. Should only be set for `InvokeHostFunction` transactions. The `enforce` mode is for simulating transactions that already contain authorization entries Possible values: - `enforce`: Validate the authorization entries already on the transaction - `root`: Record authorization entries, requiring each to be rooted at the transaction's top-level operation - `non-root`: Record all authorization entries, including non-root entries ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `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] --contract-id --source-account [-- ...]` ###### **Arguments:** - `` — Function name as subcommand, then arguments for that function as `--arg-name value` ###### **Global Options:** - `--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:** - `--contract-id ` [alias: `id`] — Contract ID to invoke - `--is-view` — ⚠️ Deprecated, use `--send=no`. View the result simulating and do not sign and submit transaction - `--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 ###### **RPC Options:** - `--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 - `--auth-mode ` — Set the authorization mode for transaction simulation. When unset, the RPC default is used: record with the root mode if no authorization entries exist, otherwise enforce the provided entries. Should only be set for `InvokeHostFunction` transactions. The `enforce` mode is for simulating transactions that already contain authorization entries Possible values: - `enforce`: Validate the authorization entries already on the transaction - `root`: Record authorization entries, requiring each to be rooted at the transaction's top-level operation - `non-root`: Record all authorization entries, including non-root entries ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `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]` ###### **Global Options:** - `--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:** - `--output ` — Type of output to generate Default value: `string` Possible values: - `string`: String - `json`: Json - `xdr`: XDR - `--contract-id ` [alias: `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 ###### **RPC Options:** - `--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 ` ###### **Global Options:** - `--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:** - `--contract-id ` [alias: `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 ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar doctor` Diagnose and troubleshoot CLI and network issues **Usage:** `stellar doctor [OPTIONS]` ###### **Global Options:** - `--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` ###### **Global Options:** - `--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:** - `--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`: Human-readable output with decoded event names and parameters - `plain`: Human-readable output without colors - `json`: JSON output with decoded event names and parameters - `raw`: Raw event output without self-describing decoding - `-c`, `--count ` — The maximum number of events to display (defer to the server-defined limit) Default value: `10` ###### **RPC Options:** - `--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. By default, secret values are concealed. To display them, use `--reveal`. Pass a name to get the value of a single environment variable. Its value is printed without shell quoting (control characters are neutralized), suitable for command substitution. Concealed variables print nothing unless `--reveal` is passed. 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 ###### **Global Options:** - `--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:** - `--reveal` — Whether to reveal the value of concealed env vars. By default, concealed env vars are hidden behind a placeholder value ## `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 ###### **Global Options:** - `--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:** - `--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.. - `--ledger` — Derive the address from a connected Ledger hardware wallet at `m/44'/148'/N'`, where `N` defaults to 0 and can be set with `--hd-path`. Persists the derived public key (and `--hd-path`, when provided) so later commands work without the device - `--overwrite` — Overwrite existing identity if it already exists. When combined with --secure-store, also replaces the existing Secure Store entry - `--hd-path ` — When importing a seed phrase, which `hd_path` to derive the key at. Persisted on the identity so later commands derive the same account without re-passing the flag. Not valid with `--public-key` or a raw secret key ## `stellar keys public-key` Given an identity return its address (public key) **Usage:** `stellar keys public-key [OPTIONS] [NAME]` **Command Alias:** `address` ###### **Arguments:** - `` — Name of identity to lookup. Required unless `--ledger` is provided ###### **Global Options:** - `--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:** - `--hd-path ` — If identity is a seed phrase use this hd path, default is 0. With --ledger this is the Ledger account index (default 0) - `--ledger` — Derive the address from a connected Ledger hardware wallet at `m/44'/148'/N'`, where `N` defaults to 0 and can be set with `--hd-path` ## `stellar keys fund` Fund an identity on a test network **Usage:** `stellar keys fund [OPTIONS] [NAME]` ###### **Arguments:** - `` — Name of identity to lookup. Required unless `--ledger` is provided ###### **Global Options:** - `--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:** - `--hd-path ` — If identity is a seed phrase use this hd path, default is 0. With --ledger this is the Ledger account index (default 0) - `--ledger` — Derive the address from a connected Ledger hardware wallet at `m/44'/148'/N'`, where `N` defaults to 0 and can be set with `--hd-path` ###### **RPC Options:** - `--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 ###### **Global Options:** - `--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:** - `--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 ` — Which `hd_path` to derive the key at from the seed phrase. Honored across all storage modes: with `--as-secret` it picks which derived key is stored, with `--secure-store` or plain seed-phrase storage it is persisted on the identity so later commands derive the same account without re-passing the flag - `--fund` — Fund generated key pair Default value: `false` - `--overwrite` — Overwrite existing identity if it already exists. When combined with --secure-store, also replaces the existing Secure Store entry ###### **RPC Options:** - `--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]` ###### **Global Options:** - `--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:** - `-l`, `--long` ## `stellar keys rm` Remove an identity **Usage:** `stellar keys rm [OPTIONS] ` ###### **Arguments:** - `` — Identity to remove ###### **Global Options:** - `--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:** - `--force` — Skip confirmation prompt ## `stellar keys secret` Output an identity's secret key **Usage:** `stellar keys secret [OPTIONS] ` ###### **Arguments:** - `` — Name of identity to lookup, default is test identity ###### **Global Options:** - `--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:** - `--phrase` — Output seed phrase instead of private key - `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 ## `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 ###### **Global Options:** - `--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]` ###### **Global Options:** - `--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 ` - `root-account` — Compute the root account keypair for a network ## `stellar network add` Add a new network **Usage:** `stellar network add [OPTIONS] --rpc-url --network-passphrase ` ###### **Arguments:** - `` — Name of network ###### **Global Options:** - `--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 ###### **RPC Options:** - `--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 ###### **Global Options:** - `--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]` ###### **Global Options:** - `--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:** - `-l`, `--long` — Get more info about the networks ## `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 ###### **Global Options:** - `--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]` ###### **Global Options:** - `--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:** - `--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 ###### **RPC Options:** - `--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]` ###### **Global Options:** - `--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:** - `--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 ###### **RPC Options:** - `--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]` ###### **Global Options:** - `--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:** - `--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 ###### **RPC Options:** - `--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]` ###### **Global Options:** - `--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 root-account` Compute the root account keypair for a network **Usage:** `stellar network root-account ` ###### **Subcommands:** - `public-key` — Output a network's root account address (public key) - `secret` — Output a network's root account secret key ## `stellar network root-account public-key` Output a network's root account address (public key) **Usage:** `stellar network root-account public-key [OPTIONS]` **Command Alias:** `address` ###### **Global Options:** - `--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:** - `--network-passphrase ` — Network passphrase to derive the root account from - `-n`, `--network ` — Name of network to use from config ## `stellar network root-account secret` Output a network's root account secret key **Usage:** `stellar network root-account secret [OPTIONS]` ###### **Global Options:** - `--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:** - `--network-passphrase ` — Network passphrase to derive the root account from - `-n`, `--network ` — Name of network to use from config ## `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` - `use` — Set the default container engine used by `stellar container` commands - `unset` — Unset the default container engine defined previously with `container use ` ## `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 - `--engine ` — Container engine to use [default: docker] Possible values: - `docker`: Docker, or any Docker-compatible CLI - `apple-container`: Apple's `container` CLI (macOS 26+, Apple silicon) ## `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:latest --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 - `--engine ` — Container engine to use [default: docker] Possible values: - `docker`: Docker, or any Docker-compatible CLI - `apple-container`: Apple's `container` CLI (macOS 26+, Apple silicon) - `--cpus ` — Limit the number of CPUs available to the container, e.g. `2`. A whole number: Apple's `container` engine does not accept fractional CPUs - `--memory ` — Limit the memory available to the container, e.g. `2g` or `512m` - `--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 - `--engine ` — Container engine to use [default: docker] Possible values: - `docker`: Docker, or any Docker-compatible CLI - `apple-container`: Apple's `container` CLI (macOS 26+, Apple silicon) ## `stellar container use` Set the default container engine used by `stellar container` commands **Usage:** `stellar container use [OPTIONS] ` ###### **Arguments:** - `` — Container engine to use by default Possible values: - `docker`: Docker, or any Docker-compatible CLI - `apple-container`: Apple's `container` CLI (macOS 26+, Apple silicon) ###### **Global Options:** - `--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 unset` Unset the default container engine defined previously with `container use ` **Usage:** `stellar container unset [OPTIONS]` ###### **Global Options:** - `--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` 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]` ###### **Global Options:** - `--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]` ###### **Global Options:** - `--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]` ###### **Archive Options:** - `--archive-url ` — Archive URL ###### **Filter Options:** - `--address
` — Account or contract address/alias to include in the snapshot - `--wasm-hash ` — WASM hashes to include in the snapshot ###### **Global Options:** - `--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:** - `--ledger ` — The ledger sequence number to snapshot. Defaults to latest history archived ledger - `--output ` — Format of the out file Default value: `json` Possible values: `json` - `--out ` — Out path that the snapshot is written to Default value: `snapshot.json` ###### **RPC Options:** - `--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 snapshot merge` Merge multiple ledger snapshots into a single snapshot file. When the same ledger key appears in multiple snapshots, the entry from the last snapshot in the argument list takes precedence. Metadata (protocol_version, sequence_number, timestamp, etc.) is taken from the last snapshot. Example: stellar snapshot merge A.json B.json --out merged.json This allows combining snapshots from different contract deployments or manually edited snapshots without regenerating from scratch. **Usage:** `stellar snapshot merge [OPTIONS] ...` ###### **Arguments:** - `` — Snapshot files to merge (at least 2 required) ###### **Options:** - `-o`, `--out ` — Output path for the merged snapshot Default value: `snapshot.json` ## `stellar token` Interact with SEP-41 tokens and Stellar Asset Contracts **Usage:** `stellar token ` ###### **Subcommands:** - `transfer` — Transfer tokens from one account to another - `transfer-from` — Transfer tokens on an owner's behalf using a granted allowance - `burn` — Burn tokens from an account, destroying them - `burn-from` — Burn tokens from an owner's account using a granted allowance - `balance` — Read the token balance of an account or contract - `name` — Read the token's name (SEP-41 metadata) - `symbol` — Read the token's symbol (SEP-41 metadata) - `decimals` — Read the token's decimals (SEP-41 metadata) - `approve` — Approve an allowance for a spender to transfer on your behalf - `allowance` — Read the allowance a spender has on an owner's behalf - `mint` — Mint new tokens to an account or contract (SAC admin) - `clawback` — Claw back tokens from an account or contract (SAC admin) - `set-admin` — Transfer administration of the token to a new admin (SAC admin) - `set-authorized` — Authorize or deauthorize an account to hold the token (SAC admin) ## `stellar token transfer` Transfer tokens from one account to another **Usage:** `stellar token transfer [OPTIONS] --id --from --to --amount ` ###### **Global Options:** - `--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:** - `--id ` — The token to transfer from: a contract id or alias, `native`, or a classic asset as `CODE:ISSUER` - `--from ` — Account to transfer tokens from. Signs and authorizes the transfer, so it must be an identity or secret key you control - `--to ` — Account or contract to transfer the tokens to. Accepts a `G…`/`M…` account, a `C…` contract address, or an alias - `--amount ` — Amount to transfer, in the token's smallest unit (stroops for a Stellar Asset Contract) - `--output ` — Format of the output Default value: `text` Possible values: - `text`: Human-readable text - `json`: Compact, single-line JSON output - `json-formatted`: Formatted (multiline) JSON output ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ## `stellar token transfer-from` Transfer tokens on an owner's behalf using a granted allowance **Usage:** `stellar token transfer-from [OPTIONS] --id --spender --from --to --amount ` ###### **Global Options:** - `--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:** - `--id ` — The token to transfer from: a contract id or alias, `native`, or a classic asset as `CODE:ISSUER` - `--spender ` — Spender drawing on its allowance. Signs and authorizes the transfer, so it must be an identity or secret key you control - `--from ` — Owner whose tokens are moved. Must have granted `--spender` an allowance. Accepts a `G…`/`M…` account, a `C…` contract address, or an alias - `--to ` — Account or contract to transfer the tokens to. Accepts a `G…`/`M…` account, a `C…` contract address, or an alias - `--amount ` — Amount to transfer, in the token's smallest unit (stroops for a Stellar Asset Contract) - `--output ` — Format of the output Default value: `text` Possible values: - `text`: Human-readable text - `json`: Compact, single-line JSON output - `json-formatted`: Formatted (multiline) JSON output ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ## `stellar token burn` Burn tokens from an account, destroying them **Usage:** `stellar token burn [OPTIONS] --id --from --amount ` ###### **Global Options:** - `--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:** - `--id ` — The token to burn: a contract id or alias, `native`, or a classic asset as `CODE:ISSUER` - `--from ` — Account whose tokens are destroyed. Signs and authorizes the burn, so it must be an identity or secret key you control - `--amount ` — Amount to burn, in the token's smallest unit (stroops for a Stellar Asset Contract) - `--output ` — Format of the output Default value: `text` Possible values: - `text`: Human-readable text - `json`: Compact, single-line JSON output - `json-formatted`: Formatted (multiline) JSON output ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ## `stellar token burn-from` Burn tokens from an owner's account using a granted allowance **Usage:** `stellar token burn-from [OPTIONS] --id --spender --from --amount ` ###### **Global Options:** - `--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:** - `--id ` — The token to burn from: a contract id or alias, `native`, or a classic asset as `CODE:ISSUER` - `--spender ` — Spender drawing on its allowance. Signs and authorizes the burn, so it must be an identity or secret key you control - `--from ` — Owner whose tokens are destroyed. Must have granted `--spender` an allowance. Accepts a `G…`/`M…` account, a `C…` contract address, or an alias - `--amount ` — Amount to burn, in the token's smallest unit (stroops for a Stellar Asset Contract) - `--output ` — Format of the output Default value: `text` Possible values: - `text`: Human-readable text - `json`: Compact, single-line JSON output - `json-formatted`: Formatted (multiline) JSON output ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ## `stellar token balance` Read the token balance of an account or contract **Usage:** `stellar token balance [OPTIONS] --id --account ` ###### **Global Options:** - `--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:** - `--id ` — The token to query: a contract id or alias, `native`, or a classic asset as `CODE:ISSUER` - `--account ` — Account or contract whose balance to read - `--decimal` — Format the balance as a decimal using the token's `decimals`, instead of the raw smallest unit (stroops for a Stellar Asset Contract) - `--output ` — Format of the output Default value: `text` Possible values: - `text`: Human-readable text - `json`: Compact, single-line JSON output - `json-formatted`: Formatted (multiline) JSON output ###### **RPC Options:** - `--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 token name` Read the token's name (SEP-41 metadata) **Usage:** `stellar token name [OPTIONS] --id ` ###### **Global Options:** - `--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:** - `--id ` — The token to query: a contract id or alias, `native`, or a classic asset as `CODE:ISSUER` - `--output ` — Format of the output Default value: `text` Possible values: - `text`: Human-readable text - `json`: Compact, single-line JSON output - `json-formatted`: Formatted (multiline) JSON output ###### **RPC Options:** - `--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 token symbol` Read the token's symbol (SEP-41 metadata) **Usage:** `stellar token symbol [OPTIONS] --id ` ###### **Global Options:** - `--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:** - `--id ` — The token to query: a contract id or alias, `native`, or a classic asset as `CODE:ISSUER` - `--output ` — Format of the output Default value: `text` Possible values: - `text`: Human-readable text - `json`: Compact, single-line JSON output - `json-formatted`: Formatted (multiline) JSON output ###### **RPC Options:** - `--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 token decimals` Read the token's decimals (SEP-41 metadata) **Usage:** `stellar token decimals [OPTIONS] --id ` ###### **Global Options:** - `--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:** - `--id ` — The token to query: a contract id or alias, `native`, or a classic asset as `CODE:ISSUER` - `--output ` — Format of the output Default value: `text` Possible values: - `text`: Human-readable text - `json`: Compact, single-line JSON output - `json-formatted`: Formatted (multiline) JSON output ###### **RPC Options:** - `--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 token approve` Approve an allowance for a spender to transfer on your behalf **Usage:** `stellar token approve [OPTIONS] --id --from --spender --amount --expiration-ledger ` ###### **Global Options:** - `--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:** - `--id ` — The token to approve an allowance on: a contract id or alias, `native`, or a classic asset as `CODE:ISSUER` - `--from ` — Account granting the allowance. Signs and authorizes the approval, so it must be an identity or secret key you control - `--spender ` — Account or contract allowed to spend on `--from`'s behalf. Accepts a `G…`/`M…` account, a `C…` contract address, or an alias - `--amount ` — Allowance to grant, in the token's smallest unit (stroops for a Stellar Asset Contract). Replaces any existing allowance - `--expiration-ledger ` — Ledger sequence after which the allowance expires. Must be at or beyond the current ledger when the amount is positive - `--output ` — Format of the output Default value: `text` Possible values: - `text`: Human-readable text - `json`: Compact, single-line JSON output - `json-formatted`: Formatted (multiline) JSON output ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ## `stellar token allowance` Read the allowance a spender has on an owner's behalf **Usage:** `stellar token allowance [OPTIONS] --id --from --spender ` ###### **Global Options:** - `--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:** - `--id ` — The token to query: a contract id or alias, `native`, or a classic asset as `CODE:ISSUER` - `--from ` — Account or contract that granted the allowance (the owner of the funds) - `--spender ` — Account or contract allowed to spend on `--from`'s behalf - `--decimal` — Format the allowance as a decimal using the token's `decimals`, instead of the raw smallest unit (stroops for a Stellar Asset Contract) - `--output ` — Format of the output Default value: `text` Possible values: - `text`: Human-readable text - `json`: Compact, single-line JSON output - `json-formatted`: Formatted (multiline) JSON output ###### **RPC Options:** - `--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 token mint` Mint new tokens to an account or contract (SAC admin) Calls the token's Stellar Asset Contract `mint` function. A non-SAC contract with a same-named function that takes different arguments will fail or misbehave — use `stellar contract invoke` for those. **Usage:** `stellar token mint [OPTIONS] --id --to --amount --source-account ` ###### **Global Options:** - `--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:** - `--id ` — The token to mint: a contract id or alias, or a classic asset as `CODE:ISSUER` - `--to ` — Account or contract to mint the tokens to. Accepts a `G…` account, a `C…` contract address, or an alias - `--amount ` — Amount to mint, in the token's smallest unit (stroops for a Stellar Asset Contract) - `--output ` — Format of the output Default value: `text` Possible values: - `text`: Human-readable text - `json`: Compact, single-line JSON output - `json-formatted`: Formatted (multiline) JSON output ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar token clawback` Claw back tokens from an account or contract (SAC admin) Calls the token's Stellar Asset Contract `clawback` function. A non-SAC contract with a same-named function that takes different arguments will fail or misbehave — use `stellar contract invoke` for those. **Usage:** `stellar token clawback [OPTIONS] --id --from --amount --source-account ` ###### **Global Options:** - `--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:** - `--id ` — The token to claw back: a contract id or alias, or a classic asset as `CODE:ISSUER` - `--from ` — Account or contract to claw the tokens back from. Accepts a `G…` account, a `C…` contract address, or an alias - `--amount ` — Amount to claw back, in the token's smallest unit (stroops for a Stellar Asset Contract) - `--output ` — Format of the output Default value: `text` Possible values: - `text`: Human-readable text - `json`: Compact, single-line JSON output - `json-formatted`: Formatted (multiline) JSON output ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar token set-admin` Transfer administration of the token to a new admin (SAC admin) Calls the token's Stellar Asset Contract `set_admin` function. A non-SAC contract with a same-named function that takes different arguments will fail or misbehave — use `stellar contract invoke` for those. **Usage:** `stellar token set-admin [OPTIONS] --id --new-admin --source-account ` ###### **Global Options:** - `--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:** - `--id ` — The token to re-administer: a contract id or alias, or a classic asset as `CODE:ISSUER` - `--new-admin ` — The new administrator to hand control to. Accepts a `G…` account, a `C…` contract address, or an alias - `--output ` — Format of the output Default value: `text` Possible values: - `text`: Human-readable text - `json`: Compact, single-line JSON output - `json-formatted`: Formatted (multiline) JSON output ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar token set-authorized` Authorize or deauthorize an account to hold the token (SAC admin) Calls the token's Stellar Asset Contract `set_authorized` function. A non-SAC contract with a same-named function that takes different arguments will fail or misbehave — use `stellar contract invoke` for those. **Usage:** `stellar token set-authorized [OPTIONS] --id --account --authorize --source-account ` ###### **Global Options:** - `--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:** - `--id ` — The token whose authorization to set: a contract id or alias, or a classic asset as `CODE:ISSUER` - `--account ` — Account or contract whose authorization to set. Accepts a `G…` account, a `C…` contract address, or an alias - `--authorize ` — Whether the account is authorized (`true`) to hold and transact the token, or deauthorized/frozen (`false`) Possible values: `true`, `false` - `--output ` — Format of the output Default value: `text` Possible values: - `text`: Human-readable text - `json`: Compact, single-line JSON output - `json-formatted`: Formatted (multiline) JSON output ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx` Sign, Simulate, and Send transactions **Usage:** `stellar tx ` ###### **Subcommands:** - `update` — Update the transaction - `edit` — Edit a transaction envelope from stdin. This command respects the environment variables `STELLAR_EDITOR`, `EDITOR` and `VISUAL`, in that order - `hash` — Calculate the hash of a transaction envelope - `new` — Create a new transaction - `operation` — Manipulate the operations in a transaction, including adding new operations - `send` — Send a transaction envelope to the network - `sign` — Sign a transaction envelope appending the signature to the envelope - `simulate` — Simulate a transaction envelope from stdin - `fetch` — Fetch a transaction from the network by hash If no subcommand is passed in, the transaction envelope will be returned - `decode` — Decode a transaction envelope from XDR to JSON - `encode` — Encode a transaction envelope from JSON to XDR ## `stellar tx update` Update the transaction **Usage:** `stellar tx update ` ###### **Subcommands:** - `sequence-number` — Edit the sequence number on a transaction ## `stellar tx update sequence-number` Edit the sequence number on a transaction **Usage:** `stellar tx update sequence-number ` **Command Alias:** `seq-num` ###### **Subcommands:** - `next` — Fetch the source account's seq-num and increment for the given tx ## `stellar tx update sequence-number next` Fetch the source account's seq-num and increment for the given tx **Usage:** `stellar tx update sequence-number next [OPTIONS]` ###### **Global Options:** - `--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 ###### **RPC Options:** - `--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 tx edit` Edit a transaction envelope from stdin. This command respects the environment variables `STELLAR_EDITOR`, `EDITOR` and `VISUAL`, in that order. Example: Start a new edit session $ stellar tx edit Example: Pipe an XDR transaction envelope $ stellar tx new manage-data --data-name hello --build-only | stellar tx edit **Usage:** `stellar tx edit` ## `stellar tx hash` Calculate the hash of a transaction envelope **Usage:** `stellar tx hash [OPTIONS] [TX_XDR]` ###### **Arguments:** - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **RPC Options:** - `--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 tx new` Create a new transaction **Usage:** `stellar tx new ` ###### **Subcommands:** - `account-merge` — Transfer XLM balance to another account and remove source account - `begin-sponsoring-future-reserves` — Begin sponsoring future reserves for another account - `bump-sequence` — Bump sequence number to invalidate older transactions - `change-trust` — Create, update, or delete a trustline - `claim-claimable-balance` — Claim a claimable balance by its balance ID - `clawback` — Clawback an asset from an account - `clawback-claimable-balance` — Clawback a claimable balance by its balance ID - `create-account` — Create and fund a new account - `create-claimable-balance` — Create a claimable balance that can be claimed by specified accounts - `create-passive-sell-offer` — Create a passive sell offer on the Stellar DEX - `end-sponsoring-future-reserves` — End sponsoring future reserves - `liquidity-pool-deposit` — Deposit assets into a liquidity pool - `liquidity-pool-withdraw` — Withdraw assets from a liquidity pool - `manage-buy-offer` — Create, update, or delete a buy offer - `manage-data` — Set, modify, or delete account data entries - `manage-sell-offer` — Create, update, or delete a sell offer - `path-payment-strict-send` — Send a payment with a different asset using path finding, specifying the send amount - `path-payment-strict-receive` — Send a payment with a different asset using path finding, specifying the receive amount - `payment` — Send asset to destination account - `revoke-sponsorship` — Revoke sponsorship of a ledger entry or signer - `set-options` — Set account options like flags, signers, and home domain - `set-trustline-flags` — Configure authorization and trustline flags for an asset ## `stellar tx new account-merge` Transfer XLM balance to another account and remove source account **Usage:** `stellar tx new account-merge [OPTIONS] --source-account --account ` ###### **Global Options:** - `--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:** - `--account ` — Muxed Account to merge with, e.g. `GBX...`, 'MBX...' ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx new begin-sponsoring-future-reserves` Begin sponsoring future reserves for another account **Usage:** `stellar tx new begin-sponsoring-future-reserves [OPTIONS] --source-account --sponsored-id ` ###### **Global Options:** - `--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:** - `--sponsored-id ` — Account that will be sponsored ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx new bump-sequence` Bump sequence number to invalidate older transactions **Usage:** `stellar tx new bump-sequence [OPTIONS] --source-account --bump-to ` ###### **Global Options:** - `--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:** - `--bump-to ` — Sequence number to bump to ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx new change-trust` Create, update, or delete a trustline **Usage:** `stellar tx new change-trust [OPTIONS] --source-account --line ` ###### **Global Options:** - `--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:** - `--line ` - `--limit ` — Limit for the trust line, 0 to remove the trust line Default value: `9223372036854775807` ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx new claim-claimable-balance` Claim a claimable balance by its balance ID **Usage:** `stellar tx new claim-claimable-balance [OPTIONS] --source-account --balance-id ` ###### **Global Options:** - `--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:** - `--balance-id ` — Balance ID of the claimable balance to claim (64-character hex string) ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx new clawback` Clawback an asset from an account **Usage:** `stellar tx new clawback [OPTIONS] --source-account --from --asset --amount ` ###### **Global Options:** - `--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:** - `--from ` — Account to clawback assets from, e.g. `GBX...` - `--asset ` — Asset to clawback - `--amount ` — Amount of the asset to clawback, in stroops. 1 stroop = 0.0000001 of the asset ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx new clawback-claimable-balance` Clawback a claimable balance by its balance ID **Usage:** `stellar tx new clawback-claimable-balance [OPTIONS] --source-account --balance-id ` ###### **Global Options:** - `--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:** - `--balance-id ` — Balance ID of the claimable balance to clawback. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx new create-account` Create and fund a new account **Usage:** `stellar tx new create-account [OPTIONS] --source-account --destination ` ###### **Global Options:** - `--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:** - `--destination ` — Account Id to create, e.g. `GBX...` - `--starting-balance ` — Initial balance in stroops of the account, default 1 XLM Default value: `10_000_000` ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx new create-claimable-balance` Create a claimable balance that can be claimed by specified accounts **Usage:** `stellar tx new create-claimable-balance [OPTIONS] --source-account --amount ` ###### **Global Options:** - `--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:** - `--asset ` — Asset to be held in the ClaimableBalanceEntry Default value: `native` - `--amount ` — Amount of asset to store in the entry, in stroops. 1 stroop = 0.0000001 of the asset - `--claimant ` — Claimants of the claimable balance. Format: account_id or account_id:predicate_json Can be specified multiple times for multiple claimants. Examples: - `--claimant alice (unconditional)` - `--claimant 'bob:{"before_absolute_time":"1735689599"}'` - `--claimant 'charlie:{"and":[{"before_absolute_time":"1735689599"},{"before_relative_time":"3600"}]}'` ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx new create-passive-sell-offer` Create a passive sell offer on the Stellar DEX **Usage:** `stellar tx new create-passive-sell-offer [OPTIONS] --source-account --selling --buying --amount --price ` ###### **Global Options:** - `--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:** - `--selling ` — Asset to sell - `--buying ` — Asset to buy - `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) - `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx new end-sponsoring-future-reserves` End sponsoring future reserves **Usage:** `stellar tx new end-sponsoring-future-reserves [OPTIONS] --source-account ` ###### **Global Options:** - `--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 ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx new liquidity-pool-deposit` Deposit assets into a liquidity pool **Usage:** `stellar tx new liquidity-pool-deposit [OPTIONS] --source-account --liquidity-pool-id --max-amount-a --max-amount-b ` ###### **Global Options:** - `--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:** - `--liquidity-pool-id ` — Liquidity pool ID to deposit to - `--max-amount-a ` — Maximum amount of the first asset to deposit, in stroops - `--max-amount-b ` — Maximum amount of the second asset to deposit, in stroops - `--min-price ` — Minimum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) Default value: `1:1` - `--max-price ` — Maximum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) Default value: `1:1` ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx new liquidity-pool-withdraw` Withdraw assets from a liquidity pool **Usage:** `stellar tx new liquidity-pool-withdraw [OPTIONS] --source-account --liquidity-pool-id --amount --min-amount-a --min-amount-b ` ###### **Global Options:** - `--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:** - `--liquidity-pool-id ` — Liquidity pool ID to withdraw from - `--amount ` — Amount of pool shares to withdraw, in stroops - `--min-amount-a ` — Minimum amount of the first asset to receive, in stroops - `--min-amount-b ` — Minimum amount of the second asset to receive, in stroops ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx new manage-buy-offer` Create, update, or delete a buy offer **Usage:** `stellar tx new manage-buy-offer [OPTIONS] --source-account --selling --buying --amount --price ` ###### **Global Options:** - `--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:** - `--selling ` — Asset to sell - `--buying ` — Asset to buy - `--amount ` — Amount of buying asset to purchase, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer - `--price ` — Price of 1 unit of buying asset in terms of selling asset as "numerator:denominator" (e.g., "1:2" means 0.5) - `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer Default value: `0` ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx new manage-data` Set, modify, or delete account data entries **Usage:** `stellar tx new manage-data [OPTIONS] --source-account --data-name ` ###### **Global Options:** - `--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:** - `--data-name ` — String up to 64 bytes long. If this is a new Name it will add the given name/value pair to the account. If this Name is already present then the associated value will be modified - `--data-value ` — Up to 64 bytes long hex string If not present then the existing Name will be deleted. If present then this value will be set in the `DataEntry` ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx new manage-sell-offer` Create, update, or delete a sell offer **Usage:** `stellar tx new manage-sell-offer [OPTIONS] --source-account --selling --buying --amount --price ` ###### **Global Options:** - `--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:** - `--selling ` — Asset to sell - `--buying ` — Asset to buy - `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer - `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) - `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer Default value: `0` ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx new path-payment-strict-send` Send a payment with a different asset using path finding, specifying the send amount **Usage:** `stellar tx new path-payment-strict-send [OPTIONS] --source-account --send-asset --send-amount --destination --dest-asset --dest-min ` ###### **Global Options:** - `--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:** - `--send-asset ` — Asset to send (pay with) - `--send-amount ` — Amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) - `--destination ` — Account that receives the payment - `--dest-asset ` — Asset that the destination will receive - `--dest-min ` — Minimum amount of destination asset that the destination account can receive. The operation will fail if this amount cannot be met - `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx new path-payment-strict-receive` Send a payment with a different asset using path finding, specifying the receive amount **Usage:** `stellar tx new path-payment-strict-receive [OPTIONS] --source-account --send-asset --send-max --destination --dest-asset --dest-amount ` ###### **Global Options:** - `--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:** - `--send-asset ` — Asset to send (pay with) - `--send-max ` — Maximum amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) - `--destination ` — Account that receives the payment - `--dest-asset ` — Asset that the destination will receive - `--dest-amount ` — Exact amount of destination asset that the destination account will receive, in stroops. 1 stroop = 0.0000001 of the asset - `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx new payment` Send asset to destination account **Usage:** `stellar tx new payment [OPTIONS] --source-account --destination --amount ` ###### **Global Options:** - `--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:** - `--destination ` — Account to send to, e.g. `GBX...` - `--asset ` — Asset to send, default native, e.i. XLM Default value: `native` - `--amount ` — Amount of the aforementioned asset to send, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx new revoke-sponsorship` Revoke sponsorship of a ledger entry or signer **Usage:** `stellar tx new revoke-sponsorship [OPTIONS] --source-account --account-id ` ###### **Global Options:** - `--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:** - `--account-id ` — Account ID (required for all sponsorship types) - `--asset ` — Asset for trustline sponsorship (format: CODE:ISSUER) - `--data-name ` — Data name for data entry sponsorship - `--offer-id ` — Offer ID for offer sponsorship - `--liquidity-pool-id ` — Pool ID for liquidity pool sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): LAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA - `--claimable-balance-id ` — Claimable balance ID for claimable balance sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA - `--signer-key ` — Signer key for signer sponsorship ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx new set-options` Set account options like flags, signers, and home domain **Usage:** `stellar tx new set-options [OPTIONS] --source-account ` ###### **Global Options:** - `--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:** - `--inflation-dest ` — Account of the inflation destination - `--master-weight ` — A number from 0-255 (inclusive) representing the weight of the master key. If the weight of the master key is updated to 0, it is effectively disabled - `--low-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a low threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig - `--med-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a medium threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig - `--high-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a high threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig - `--home-domain ` — Sets the home domain of an account. See https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/federation - `--signer ` — Add, update, or remove a signer from an account - `--signer-weight ` — Signer weight is a number from 0-255 (inclusive). The signer is deleted if the weight is 0 - `--set-required` — When enabled, an issuer must approve an account before that account can hold its asset. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-required-0x1 - `--set-revocable` — When enabled, an issuer can revoke an existing trustline's authorization, thereby freezing the asset held by an account. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-revocable-0x2 - `--set-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. https://developers.stellar.org/docs/tokens/control-asset-access#clawback-enabled-0x8 - `--set-immutable` — With this setting, none of the other authorization flags (`AUTH_REQUIRED_FLAG`, `AUTH_REVOCABLE_FLAG`) can be set, and the issuing account can't be merged. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-immutable-0x4 - `--clear-required` - `--clear-revocable` - `--clear-immutable` - `--clear-clawback-enabled` ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx new set-trustline-flags` Configure authorization and trustline flags for an asset **Usage:** `stellar tx new set-trustline-flags [OPTIONS] --source-account --trustor --asset ` ###### **Global Options:** - `--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:** - `--trustor ` — Account to set trustline flags for, e.g. `GBX...`, or alias, or muxed account, `M123...`` - `--asset ` — Asset to set trustline flags for - `--set-authorize` — Signifies complete authorization allowing an account to transact freely with the asset to make and receive payments and place orders - `--set-authorize-to-maintain-liabilities` — Denotes limited authorization that allows an account to maintain current orders but not to otherwise transact with the asset - `--set-trustline-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. See our section on Clawbacks: https://developers.stellar.org/docs/learn/encyclopedia/transactions-specialized/clawbacks - `--clear-authorize` - `--clear-authorize-to-maintain-liabilities` - `--clear-trustline-clawback-enabled` ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx operation` Manipulate the operations in a transaction, including adding new operations **Usage:** `stellar tx operation ` **Command Alias:** `op` ###### **Subcommands:** - `add` — Add Operation to a transaction ## `stellar tx operation add` Add Operation to a transaction **Usage:** `stellar tx operation add ` ###### **Subcommands:** - `account-merge` — Transfer XLM balance to another account and remove source account - `begin-sponsoring-future-reserves` — Begin sponsoring future reserves for another account - `bump-sequence` — Bump sequence number to invalidate older transactions - `change-trust` — Create, update, or delete a trustline - `claim-claimable-balance` — Claim a claimable balance by its balance ID - `clawback` — Clawback an asset from an account - `clawback-claimable-balance` — Clawback a claimable balance by its balance ID - `create-account` — Create and fund a new account - `create-claimable-balance` — Create a claimable balance that can be claimed by specified accounts - `create-passive-sell-offer` — Create a passive sell offer on the Stellar DEX - `end-sponsoring-future-reserves` — End sponsoring future reserves - `liquidity-pool-deposit` — Deposit assets into a liquidity pool - `liquidity-pool-withdraw` — Withdraw assets from a liquidity pool - `manage-buy-offer` — Create, update, or delete a buy offer - `manage-data` — Set, modify, or delete account data entries - `manage-sell-offer` — Create, update, or delete a sell offer - `path-payment-strict-receive` — Send a payment with a different asset using path finding, specifying the receive amount - `path-payment-strict-send` — Send a payment with a different asset using path finding, specifying the send amount - `payment` — Send asset to destination account - `revoke-sponsorship` — Revoke sponsorship of a ledger entry or signer - `set-options` — Set account options like flags, signers, and home domain - `set-trustline-flags` — Configure authorization and trustline flags for an asset ## `stellar tx operation add account-merge` Transfer XLM balance to another account and remove source account **Usage:** `stellar tx operation add account-merge [OPTIONS] --source-account --account [TX_XDR]` ###### **Arguments:** - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** - `--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:** - `--operation-source-account ` [alias: `op-source`] — Source account used for the operation - `--account ` — Muxed Account to merge with, e.g. `GBX...`, 'MBX...' ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx operation add begin-sponsoring-future-reserves` Begin sponsoring future reserves for another account **Usage:** `stellar tx operation add begin-sponsoring-future-reserves [OPTIONS] --source-account --sponsored-id [TX_XDR]` ###### **Arguments:** - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** - `--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:** - `--operation-source-account ` [alias: `op-source`] — Source account used for the operation - `--sponsored-id ` — Account that will be sponsored ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx operation add bump-sequence` Bump sequence number to invalidate older transactions **Usage:** `stellar tx operation add bump-sequence [OPTIONS] --source-account --bump-to [TX_XDR]` ###### **Arguments:** - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** - `--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:** - `--operation-source-account ` [alias: `op-source`] — Source account used for the operation - `--bump-to ` — Sequence number to bump to ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx operation add change-trust` Create, update, or delete a trustline **Usage:** `stellar tx operation add change-trust [OPTIONS] --source-account --line [TX_XDR]` ###### **Arguments:** - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** - `--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:** - `--operation-source-account ` [alias: `op-source`] — Source account used for the operation - `--line ` - `--limit ` — Limit for the trust line, 0 to remove the trust line Default value: `9223372036854775807` ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx operation add claim-claimable-balance` Claim a claimable balance by its balance ID **Usage:** `stellar tx operation add claim-claimable-balance [OPTIONS] --source-account --balance-id [TX_XDR]` ###### **Arguments:** - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** - `--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:** - `--operation-source-account ` [alias: `op-source`] — Source account used for the operation - `--balance-id ` — Balance ID of the claimable balance to claim (64-character hex string) ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx operation add clawback` Clawback an asset from an account **Usage:** `stellar tx operation add clawback [OPTIONS] --source-account --from --asset --amount [TX_XDR]` ###### **Arguments:** - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** - `--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:** - `--operation-source-account ` [alias: `op-source`] — Source account used for the operation - `--from ` — Account to clawback assets from, e.g. `GBX...` - `--asset ` — Asset to clawback - `--amount ` — Amount of the asset to clawback, in stroops. 1 stroop = 0.0000001 of the asset ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx operation add clawback-claimable-balance` Clawback a claimable balance by its balance ID **Usage:** `stellar tx operation add clawback-claimable-balance [OPTIONS] --source-account --balance-id [TX_XDR]` ###### **Arguments:** - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** - `--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:** - `--operation-source-account ` [alias: `op-source`] — Source account used for the operation - `--balance-id ` — Balance ID of the claimable balance to clawback. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx operation add create-account` Create and fund a new account **Usage:** `stellar tx operation add create-account [OPTIONS] --source-account --destination [TX_XDR]` ###### **Arguments:** - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** - `--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:** - `--operation-source-account ` [alias: `op-source`] — Source account used for the operation - `--destination ` — Account Id to create, e.g. `GBX...` - `--starting-balance ` — Initial balance in stroops of the account, default 1 XLM Default value: `10_000_000` ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx operation add create-claimable-balance` Create a claimable balance that can be claimed by specified accounts **Usage:** `stellar tx operation add create-claimable-balance [OPTIONS] --source-account --amount [TX_XDR]` ###### **Arguments:** - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** - `--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:** - `--operation-source-account ` [alias: `op-source`] — Source account used for the operation - `--asset ` — Asset to be held in the ClaimableBalanceEntry Default value: `native` - `--amount ` — Amount of asset to store in the entry, in stroops. 1 stroop = 0.0000001 of the asset - `--claimant ` — Claimants of the claimable balance. Format: account_id or account_id:predicate_json Can be specified multiple times for multiple claimants. Examples: - `--claimant alice (unconditional)` - `--claimant 'bob:{"before_absolute_time":"1735689599"}'` - `--claimant 'charlie:{"and":[{"before_absolute_time":"1735689599"},{"before_relative_time":"3600"}]}'` ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx operation add create-passive-sell-offer` Create a passive sell offer on the Stellar DEX **Usage:** `stellar tx operation add create-passive-sell-offer [OPTIONS] --source-account --selling --buying --amount --price [TX_XDR]` ###### **Arguments:** - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** - `--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:** - `--operation-source-account ` [alias: `op-source`] — Source account used for the operation - `--selling ` — Asset to sell - `--buying ` — Asset to buy - `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) - `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx operation add end-sponsoring-future-reserves` End sponsoring future reserves **Usage:** `stellar tx operation add end-sponsoring-future-reserves [OPTIONS] --source-account [TX_XDR]` ###### **Arguments:** - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** - `--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:** - `--operation-source-account ` [alias: `op-source`] — Source account used for the operation ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx operation add liquidity-pool-deposit` Deposit assets into a liquidity pool **Usage:** `stellar tx operation add liquidity-pool-deposit [OPTIONS] --source-account --liquidity-pool-id --max-amount-a --max-amount-b [TX_XDR]` ###### **Arguments:** - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** - `--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:** - `--operation-source-account ` [alias: `op-source`] — Source account used for the operation - `--liquidity-pool-id ` — Liquidity pool ID to deposit to - `--max-amount-a ` — Maximum amount of the first asset to deposit, in stroops - `--max-amount-b ` — Maximum amount of the second asset to deposit, in stroops - `--min-price ` — Minimum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) Default value: `1:1` - `--max-price ` — Maximum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) Default value: `1:1` ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx operation add liquidity-pool-withdraw` Withdraw assets from a liquidity pool **Usage:** `stellar tx operation add liquidity-pool-withdraw [OPTIONS] --source-account --liquidity-pool-id --amount --min-amount-a --min-amount-b [TX_XDR]` ###### **Arguments:** - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** - `--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:** - `--operation-source-account ` [alias: `op-source`] — Source account used for the operation - `--liquidity-pool-id ` — Liquidity pool ID to withdraw from - `--amount ` — Amount of pool shares to withdraw, in stroops - `--min-amount-a ` — Minimum amount of the first asset to receive, in stroops - `--min-amount-b ` — Minimum amount of the second asset to receive, in stroops ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx operation add manage-buy-offer` Create, update, or delete a buy offer **Usage:** `stellar tx operation add manage-buy-offer [OPTIONS] --source-account --selling --buying --amount --price [TX_XDR]` ###### **Arguments:** - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** - `--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:** - `--operation-source-account ` [alias: `op-source`] — Source account used for the operation - `--selling ` — Asset to sell - `--buying ` — Asset to buy - `--amount ` — Amount of buying asset to purchase, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer - `--price ` — Price of 1 unit of buying asset in terms of selling asset as "numerator:denominator" (e.g., "1:2" means 0.5) - `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer Default value: `0` ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx operation add manage-data` Set, modify, or delete account data entries **Usage:** `stellar tx operation add manage-data [OPTIONS] --source-account --data-name [TX_XDR]` ###### **Arguments:** - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** - `--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:** - `--operation-source-account ` [alias: `op-source`] — Source account used for the operation - `--data-name ` — String up to 64 bytes long. If this is a new Name it will add the given name/value pair to the account. If this Name is already present then the associated value will be modified - `--data-value ` — Up to 64 bytes long hex string If not present then the existing Name will be deleted. If present then this value will be set in the `DataEntry` ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx operation add manage-sell-offer` Create, update, or delete a sell offer **Usage:** `stellar tx operation add manage-sell-offer [OPTIONS] --source-account --selling --buying --amount --price [TX_XDR]` ###### **Arguments:** - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** - `--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:** - `--operation-source-account ` [alias: `op-source`] — Source account used for the operation - `--selling ` — Asset to sell - `--buying ` — Asset to buy - `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer - `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) - `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer Default value: `0` ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx operation add path-payment-strict-receive` Send a payment with a different asset using path finding, specifying the receive amount **Usage:** `stellar tx operation add path-payment-strict-receive [OPTIONS] --source-account --send-asset --send-max --destination --dest-asset --dest-amount [TX_XDR]` ###### **Arguments:** - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** - `--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:** - `--operation-source-account ` [alias: `op-source`] — Source account used for the operation - `--send-asset ` — Asset to send (pay with) - `--send-max ` — Maximum amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) - `--destination ` — Account that receives the payment - `--dest-asset ` — Asset that the destination will receive - `--dest-amount ` — Exact amount of destination asset that the destination account will receive, in stroops. 1 stroop = 0.0000001 of the asset - `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx operation add path-payment-strict-send` Send a payment with a different asset using path finding, specifying the send amount **Usage:** `stellar tx operation add path-payment-strict-send [OPTIONS] --source-account --send-asset --send-amount --destination --dest-asset --dest-min [TX_XDR]` ###### **Arguments:** - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** - `--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:** - `--operation-source-account ` [alias: `op-source`] — Source account used for the operation - `--send-asset ` — Asset to send (pay with) - `--send-amount ` — Amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) - `--destination ` — Account that receives the payment - `--dest-asset ` — Asset that the destination will receive - `--dest-min ` — Minimum amount of destination asset that the destination account can receive. The operation will fail if this amount cannot be met - `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx operation add payment` Send asset to destination account **Usage:** `stellar tx operation add payment [OPTIONS] --source-account --destination --amount [TX_XDR]` ###### **Arguments:** - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** - `--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:** - `--operation-source-account ` [alias: `op-source`] — Source account used for the operation - `--destination ` — Account to send to, e.g. `GBX...` - `--asset ` — Asset to send, default native, e.i. XLM Default value: `native` - `--amount ` — Amount of the aforementioned asset to send, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx operation add revoke-sponsorship` Revoke sponsorship of a ledger entry or signer **Usage:** `stellar tx operation add revoke-sponsorship [OPTIONS] --source-account --account-id [TX_XDR]` ###### **Arguments:** - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** - `--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:** - `--operation-source-account ` [alias: `op-source`] — Source account used for the operation - `--account-id ` — Account ID (required for all sponsorship types) - `--asset ` — Asset for trustline sponsorship (format: CODE:ISSUER) - `--data-name ` — Data name for data entry sponsorship - `--offer-id ` — Offer ID for offer sponsorship - `--liquidity-pool-id ` — Pool ID for liquidity pool sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): LAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA - `--claimable-balance-id ` — Claimable balance ID for claimable balance sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA - `--signer-key ` — Signer key for signer sponsorship ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx operation add set-options` Set account options like flags, signers, and home domain **Usage:** `stellar tx operation add set-options [OPTIONS] --source-account [TX_XDR]` ###### **Arguments:** - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** - `--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:** - `--operation-source-account ` [alias: `op-source`] — Source account used for the operation - `--inflation-dest ` — Account of the inflation destination - `--master-weight ` — A number from 0-255 (inclusive) representing the weight of the master key. If the weight of the master key is updated to 0, it is effectively disabled - `--low-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a low threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig - `--med-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a medium threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig - `--high-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a high threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig - `--home-domain ` — Sets the home domain of an account. See https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/federation - `--signer ` — Add, update, or remove a signer from an account - `--signer-weight ` — Signer weight is a number from 0-255 (inclusive). The signer is deleted if the weight is 0 - `--set-required` — When enabled, an issuer must approve an account before that account can hold its asset. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-required-0x1 - `--set-revocable` — When enabled, an issuer can revoke an existing trustline's authorization, thereby freezing the asset held by an account. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-revocable-0x2 - `--set-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. https://developers.stellar.org/docs/tokens/control-asset-access#clawback-enabled-0x8 - `--set-immutable` — With this setting, none of the other authorization flags (`AUTH_REQUIRED_FLAG`, `AUTH_REVOCABLE_FLAG`) can be set, and the issuing account can't be merged. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-immutable-0x4 - `--clear-required` - `--clear-revocable` - `--clear-immutable` - `--clear-clawback-enabled` ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx operation add set-trustline-flags` Configure authorization and trustline flags for an asset **Usage:** `stellar tx operation add set-trustline-flags [OPTIONS] --source-account --trustor --asset [TX_XDR]` ###### **Arguments:** - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** - `--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:** - `--operation-source-account ` [alias: `op-source`] — Source account used for the operation - `--trustor ` — Account to set trustline flags for, e.g. `GBX...`, or alias, or muxed account, `M123...`` - `--asset ` — Asset to set trustline flags for - `--set-authorize` — Signifies complete authorization allowing an account to transact freely with the asset to make and receive payments and place orders - `--set-authorize-to-maintain-liabilities` — Denotes limited authorization that allows an account to maintain current orders but not to otherwise transact with the asset - `--set-trustline-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. See our section on Clawbacks: https://developers.stellar.org/docs/learn/encyclopedia/transactions-specialized/clawbacks - `--clear-authorize` - `--clear-authorize-to-maintain-liabilities` - `--clear-trustline-clawback-enabled` ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx send` Send a transaction envelope to the network **Usage:** `stellar tx send [OPTIONS] [TX_XDR]` ###### **Arguments:** - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** - `--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 ###### **RPC Options:** - `--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 tx sign` Sign a transaction envelope appending the signature to the envelope **Usage:** `stellar tx sign [OPTIONS] [TX_XDR]` ###### **Arguments:** - `` — Base-64 transaction envelope XDR, or file containing XDR to decode, or stdin if empty ###### **Global Options:** - `--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 ###### **RPC Options:** - `--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 ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ## `stellar tx simulate` Simulate a transaction envelope from stdin **Usage:** `stellar tx simulate [OPTIONS] --source-account [TX_XDR]` ###### **Arguments:** - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** - `--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:** - `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation ###### **RPC Options:** - `--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 - `--auth-mode ` — Set the authorization mode for transaction simulation. When unset, the RPC default is used: record with the root mode if no authorization entries exist, otherwise enforce the provided entries. Should only be set for `InvokeHostFunction` transactions. The `enforce` mode is for simulating transactions that already contain authorization entries Possible values: - `enforce`: Validate the authorization entries already on the transaction - `root`: Record authorization entries, requiring each to be rooted at the transaction's top-level operation - `non-root`: Record all authorization entries, including non-root entries ###### **Signing Options:** - `--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 - `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction 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 - `--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 ## `stellar tx fetch` Fetch a transaction from the network by hash If no subcommand is passed in, the transaction envelope will be returned **Usage:** `stellar tx fetch [OPTIONS] fetch ` ###### **Subcommands:** - `result` — Fetch the transaction result - `meta` — Fetch the transaction meta - `fee` — Fetch the transaction fee information - `events` — Fetch the transaction events ###### **Options:** - `--hash ` — Hash of transaction to fetch - `--output ` — Format of the output Default value: `json` Possible values: - `json`: JSON output with parsed XDRs (one line, not formatted) - `json-formatted`: Formatted (multiline) JSON output with parsed XDRs - `xdr`: Original RPC output (containing XDRs) ###### **RPC Options:** - `--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 tx fetch result` Fetch the transaction result **Usage:** `stellar tx fetch result [OPTIONS] --hash ` ###### **Options:** - `--hash ` — Transaction hash to fetch - `--output ` — Format of the output Default value: `json` Possible values: - `json`: JSON output with parsed XDRs (one line, not formatted) - `json-formatted`: Formatted (multiline) JSON output with parsed XDRs - `xdr`: Original RPC output (containing XDRs) ###### **RPC Options:** - `--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 tx fetch meta` Fetch the transaction meta **Usage:** `stellar tx fetch meta [OPTIONS] --hash ` ###### **Options:** - `--hash ` — Transaction hash to fetch - `--output ` — Format of the output Default value: `json` Possible values: - `json`: JSON output with parsed XDRs (one line, not formatted) - `json-formatted`: Formatted (multiline) JSON output with parsed XDRs - `xdr`: Original RPC output (containing XDRs) ###### **RPC Options:** - `--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 tx fetch fee` Fetch the transaction fee information **Usage:** `stellar tx fetch fee [OPTIONS] --hash ` ###### **Options:** - `--hash ` — Transaction hash to fetch - `--output ` — Output format for fee command Default value: `table` Possible values: - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - `table`: Formatted in a table comparing fee types ###### **RPC Options:** - `--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 tx fetch events` Fetch the transaction events **Usage:** `stellar tx fetch events [OPTIONS] --hash ` ###### **Options:** - `--hash ` — Transaction hash to fetch - `--output ` — Format of the output Default value: `json` Possible values: - `json`: JSON output of the events with parsed XDRs (one line, not formatted) - `json-formatted`: Formatted (multiline) JSON output of events with parsed XDRs - `text`: Human readable event output with parsed XDRs ###### **RPC Options:** - `--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 tx decode` Decode a transaction envelope from XDR to JSON **Usage:** `stellar tx decode [OPTIONS] [INPUT]...` ###### **Arguments:** - `` — XDR or files containing XDR to decode, or stdin if empty ###### **Options:** - `--input ` Default value: `single-base64` Possible values: `single-base64`, `single` - `--output ` Default value: `json` Possible values: `json`, `json-formatted` ## `stellar tx encode` Encode a transaction envelope from JSON to XDR **Usage:** `stellar tx encode [OPTIONS] [INPUT]...` ###### **Arguments:** - `` — XDR or files containing XDR to decode, or stdin if empty ###### **Options:** - `--input ` Default value: `json` Possible values: `json` - `--output ` Default value: `single-base64` Possible values: `single-base64`, `single` ## `stellar xdr` Decode and encode XDR **Usage:** `stellar xdr ` ###### **Subcommands:** - `types` — View information about types - `guess` — Guess the XDR type - `decode` — Decode XDR - `encode` — Encode XDR - `compare` — Compare two XDR values with each other - `generate` — Generate XDR values - `xfile` — Preprocess XDR .x files - `version` — Print version information ## `stellar xdr types` View information about types **Usage:** `stellar xdr types ` ###### **Subcommands:** - `list` — - `schema` — - `schema-files` — Generate JSON schema files for the XDR types, writing a file for each type to the out directory ## `stellar xdr types list` **Usage:** `stellar xdr types list [OPTIONS]` ###### **Options:** - `--output ` Default value: `plain` Possible values: `plain`, `json`, `json-formatted` ## `stellar xdr types schema` **Usage:** `stellar xdr types schema [OPTIONS] --type ` ###### **Options:** - `--type ` — XDR type to generate schema for - `--output ` Default value: `json-schema-draft201909` Possible values: `json-schema-draft201909` ## `stellar xdr types schema-files` Generate JSON schema files for the XDR types, writing a file for each type to the out directory **Usage:** `stellar xdr types schema-files [OPTIONS] --out-dir ` ###### **Options:** - `--out-dir ` - `--output ` Default value: `json-schema-draft201909` Possible values: `json-schema-draft201909` ## `stellar xdr guess` Guess the XDR type. Prints a list of types that the XDR values can be decoded into. **Usage:** `stellar xdr guess [OPTIONS] [INPUT]` ###### **Arguments:** - `` — XDR or file containing XDR to decode, or stdin if empty ###### **Options:** - `--input ` Default value: `single-base64` Possible values: `single`, `single-base64`, `stream`, `stream-base64`, `stream-framed` - `--output ` Default value: `list` Possible values: `list` - `--certainty ` — Certainty as an arbitrary value Default value: `2` ## `stellar xdr decode` Decode XDR **Usage:** `stellar xdr decode [OPTIONS] --type [INPUT]...` ###### **Arguments:** - `` — XDR or files containing XDR to decode, or stdin if empty ###### **Options:** - `--type ` — XDR type to decode - `--input ` Default value: `stream-base64` Possible values: `single`, `single-base64`, `stream`, `stream-base64`, `stream-framed` - `--output ` Default value: `json` Possible values: `json`, `json-formatted`, `text`, `rust-debug`, `rust-debug-formatted` ## `stellar xdr encode` Encode XDR **Usage:** `stellar xdr encode [OPTIONS] --type [INPUT]...` ###### **Arguments:** - `` — XDR or files containing XDR to decode, or stdin if empty ###### **Options:** - `--type ` — XDR type to encode - `--input ` Default value: `json` Possible values: `json` - `--output ` Default value: `single-base64` Possible values: `single`, `single-base64`, `stream` ## `stellar xdr compare` Compare two XDR values with each other Outputs: `-1` when the left XDR value is less than the right XDR value, `0` when the left XDR value is equal to the right XDR value, `1` when the left XDR value is greater than the right XDR value **Usage:** `stellar xdr compare [OPTIONS] --type ` ###### **Arguments:** - `` — XDR file to decode and compare with the right value - `` — XDR file to decode and compare with the left value ###### **Options:** - `--type ` — XDR type of both inputs - `--input ` Default value: `single-base64` Possible values: `single`, `single-base64` ## `stellar xdr generate` Generate XDR values **Usage:** `stellar xdr generate ` ###### **Subcommands:** - `default` — Generate default XDR values - `arbitrary` — Generate arbitrary XDR values ## `stellar xdr generate default` Generate default XDR values **Usage:** `stellar xdr generate default [OPTIONS] --type ` ###### **Options:** - `--type ` — XDR type to generate - `--output ` Default value: `single-base64` Possible values: `single`, `single-base64`, `json`, `json-formatted`, `text` ## `stellar xdr generate arbitrary` Generate arbitrary XDR values **Usage:** `stellar xdr generate arbitrary [OPTIONS] --type ` ###### **Options:** - `--type ` — XDR type to generate - `--output ` Default value: `single-base64` Possible values: `single`, `single-base64`, `json`, `json-formatted`, `text` - `--hint ` — Keep generating values until the value's JSON representation contains this string. Useful for hinting toward a particular union/enum variant or sub-value. Repeat the flag to require several substrings; all of them must be present in the same value - `--hint-attempts ` — Maximum number of generation attempts when --hint is set before giving up Default value: `20000` ## `stellar xdr xfile` Preprocess XDR .x files **Usage:** `stellar xdr xfile ` ###### **Subcommands:** - `preprocess` — Preprocess XDR .x files by evaluating #ifdef/#ifndef/#elif/#else/#endif directives ## `stellar xdr xfile preprocess` Preprocess XDR .x files by evaluating #ifdef/#ifndef/#elif/#else/#endif directives **Usage:** `stellar xdr xfile preprocess [OPTIONS] [INPUT]` ###### **Arguments:** - `` — XDR .x file to preprocess, or stdin if omitted ###### **Options:** - `--features ` — Features/symbols to define - `--all-features` — Enable all features/symbols found in the input ## `stellar xdr version` Print version information **Usage:** `stellar xdr version` ## `stellar strkey` Decode and encode strkey **Usage:** `stellar strkey ` ###### **Subcommands:** - `decode` — Decode strkey - `encode` — Encode strkey - `zero` — Generate the zero strkey - `version` — Print version information ## `stellar strkey decode` Decode strkey **Usage:** `stellar strkey decode [STRKEY]` ###### **Arguments:** - `` — Strkey to decode, or stdin if empty ## `stellar strkey encode` Encode strkey **Usage:** `stellar strkey encode [JSON]` ###### **Arguments:** - `` — JSON for Strkey to encode, or stdin if empty ## `stellar strkey zero` Generate the zero strkey **Usage:** `stellar strkey zero [OPTIONS] ` ###### **Arguments:** - `` — Strkey type to generate the zero value for Possible values: `public_key_ed25519`, `pre_auth_tx`, `hash_x`, `muxed_account_ed25519`, `signed_payload_ed25519`, `contract`, `liquidity_pool`, `claimable_balance_v0` ###### **Options:** - `--output ` — Output format Default value: `strkey` Possible values: `strkey`, `json` ## `stellar strkey version` Print version information **Usage:** `stellar strkey version` ## `stellar completion` Print shell completion code for the specified shell Ensure the completion package for your shell is installed, e.g. bash-completion for bash. To enable autocomplete in the current bash shell, run: `source <(stellar completion --shell bash)` To enable autocomplete permanently, run: `echo "source <(stellar completion --shell bash)" >> ~/.bashrc` **Usage:** `stellar completion --shell ` ###### **Options:** - `--shell ` — The shell type Possible values: `bash`, `elvish`, `fish`, `powershell`, `zsh` ## `stellar cache` Cache for transactions and contract specs **Usage:** `stellar cache ` ###### **Subcommands:** - `clean` — Delete the cache - `path` — Show the location of the cache - `actionlog` — Access details about cached actions like transactions, and simulations. (Experimental. May see breaking changes at any time.) ## `stellar cache clean` Delete the cache **Usage:** `stellar cache clean` ## `stellar cache path` Show the location of the cache **Usage:** `stellar cache path` ## `stellar cache actionlog` Access details about cached actions like transactions, and simulations. (Experimental. May see breaking changes at any time.) **Usage:** `stellar cache actionlog ` ###### **Subcommands:** - `ls` — List cached actions (transactions, simulations) - `read` — Read cached action ## `stellar cache actionlog ls` List cached actions (transactions, simulations) **Usage:** `stellar cache actionlog ls [OPTIONS]` ###### **Global Options:** - `--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:** - `-l`, `--long` ## `stellar cache actionlog read` Read cached action **Usage:** `stellar cache actionlog read --id ` ###### **Options:** - `--id ` — ID of the cache entry ## `stellar version` Print version information **Usage:** `stellar version [OPTIONS]` ###### **Options:** - `--only-version` — Print only the version - `--only-version-major` — Print only the major version - `--only-commit` — Print only the commit sha ## `stellar skill` Print an AI-agent skill guide for using the Stellar CLI Outputs a Markdown document describing how to use the Stellar CLI idiomatically. It is meant to be read by AI coding agents (or pasted into their instructions) so they follow the CLI's conventions: using named networks, identities, and contract aliases instead of raw RPC URLs, secret keys, and hard-coded contract ids. **Usage:** `stellar skill` ## `stellar plugin` The subcommand for CLI plugins **Usage:** `stellar plugin ` ###### **Subcommands:** - `search` — Search for CLI plugins using GitHub - `ls` — List installed plugins ## `stellar plugin search` Search for CLI plugins using GitHub **Usage:** `stellar plugin search` ## `stellar plugin ls` List installed plugins **Usage:** `stellar plugin ls` ## `stellar ledger` Fetch ledger information **Usage:** `stellar ledger ` ###### **Subcommands:** - `entry` — Work with ledger entries - `latest` — Get the latest ledger sequence and information from the network - `fetch` — ## `stellar ledger entry` Work with ledger entries **Usage:** `stellar ledger entry ` ###### **Subcommands:** - `fetch` — Fetch ledger entries. This command supports all types of ledger entries supported by the RPC. Read more about the RPC command here: [https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys](https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys) ## `stellar ledger entry fetch` Fetch ledger entries. This command supports all types of ledger entries supported by the RPC. Read more about the RPC command here: [https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys](https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys) **Usage:** `stellar ledger entry fetch ` ###### **Subcommands:** - `account` — Fetch account entry by public key or alias - `contract-data` — Fetch contract ledger entry by address or alias and storage key - `claimable-balance` — Fetch a claimable balance ledger entry by id - `liquidity-pool` — Fetch a liquidity pool ledger entry by id - `contract-code` — Fetch a Contract's WASM bytecode by WASM hash - `trustline` — Fetch a trustline by account and asset - `data` — Fetch key-value data entries attached to an account (see manageDataOp) - `offer` — Fetch an offer by account and offer id ## `stellar ledger entry fetch account` Fetch account entry by public key or alias **Usage:** `stellar ledger entry fetch account [OPTIONS] --account ` ###### **Global Options:** - `--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:** - `--account ` — Account alias or address to lookup - `--output ` — Format of the output Default value: `json` Possible values: - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - `xdr`: Original RPC output (containing XDRs) - `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 ###### **RPC Options:** - `--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 ledger entry fetch contract-data` Fetch contract ledger entry by address or alias and storage key **Usage:** `stellar ledger entry fetch contract-data [OPTIONS] --contract ` ###### **Global Options:** - `--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:** - `--contract ` — Contract alias or address to fetch - `--output ` — Format of the output Default value: `json` Possible values: - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - `xdr`: Original RPC output (containing XDRs) - `--durability ` — Storage entry durability Default value: `persistent` Possible values: - `persistent`: Persistent - `temporary`: Temporary - `--key ` — Storage key (symbols only) - `--key-xdr ` — Storage key (base64-encoded XDR) - `--instance` — If the contract instance ledger entry should be included in the output ###### **RPC Options:** - `--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 ledger entry fetch claimable-balance` Fetch a claimable balance ledger entry by id **Usage:** `stellar ledger entry fetch claimable-balance [OPTIONS]` ###### **Global Options:** - `--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:** - `--id ` — Claimable Balance Ids to fetch an entry for - `--output ` — Format of the output Default value: `json` Possible values: - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - `xdr`: Original RPC output (containing XDRs) ###### **RPC Options:** - `--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 ledger entry fetch liquidity-pool` Fetch a liquidity pool ledger entry by id **Usage:** `stellar ledger entry fetch liquidity-pool [OPTIONS]` ###### **Global Options:** - `--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:** - `--id ` — Liquidity pool ids - `--output ` — Format of the output Default value: `json` Possible values: - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - `xdr`: Original RPC output (containing XDRs) ###### **RPC Options:** - `--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 ledger entry fetch contract-code` Fetch a Contract's WASM bytecode by WASM hash **Usage:** `stellar ledger entry fetch contract-code [OPTIONS]` ###### **Global Options:** - `--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:** - `--wasm-hash ` — Get WASM bytecode by hash - `--output ` — Format of the output Default value: `json` Possible values: - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - `xdr`: Original RPC output (containing XDRs) ###### **RPC Options:** - `--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 ledger entry fetch trustline` Fetch a trustline by account and asset **Usage:** `stellar ledger entry fetch trustline [OPTIONS] --account --asset ` ###### **Global Options:** - `--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:** - `--output ` — Format of the output Default value: `json` Possible values: - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - `xdr`: Original RPC output (containing XDRs) - `--account ` — Account alias or address to lookup - `--asset ` — Assets to get trustline info for - `--hd-path ` — If account is a seed phrase use this hd path, default is 0 ###### **RPC Options:** - `--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 ledger entry fetch data` Fetch key-value data entries attached to an account (see manageDataOp) **Usage:** `stellar ledger entry fetch data [OPTIONS] --account --data-name ` ###### **Global Options:** - `--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:** - `--output ` — Format of the output Default value: `json` Possible values: - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - `xdr`: Original RPC output (containing XDRs) - `--account ` — Account alias or address to lookup - `--data-name ` — Fetch key-value data entries attached to an account (see manageDataOp) - `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 ###### **RPC Options:** - `--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 ledger entry fetch offer` Fetch an offer by account and offer id **Usage:** `stellar ledger entry fetch offer [OPTIONS] --account --offer ` ###### **Global Options:** - `--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:** - `--output ` — Format of the output Default value: `json` Possible values: - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - `xdr`: Original RPC output (containing XDRs) - `--account ` — Account alias or address to lookup - `--offer ` — ID of an offer made on the Stellar DEX - `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 ###### **RPC Options:** - `--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 ledger latest` Get the latest ledger sequence and information from the network **Usage:** `stellar ledger latest [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 ###### **RPC Options:** - `--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 ledger fetch` **Usage:** `stellar ledger fetch [OPTIONS] ` ###### **Arguments:** - `` — Ledger Sequence to start fetch (inclusive) ###### **Options:** - `--limit ` — Number of ledgers to fetch Default value: `1` - `--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 - `--xdr-format ` — Format of the xdr in the output Default value: `json` Possible values: - `json`: XDR fields will be fetched as json and accessible via the headerJson and metadataJson fields - `xdr`: XDR fields will be fetched as xdr and accessible via the headerXdr and metadataXdr fields ###### **RPC Options:** - `--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 message` Sign and verify arbitrary messages using SEP-53 **Usage:** `stellar message ` ###### **Subcommands:** - `sign` — Sign an arbitrary message using SEP-53 - `verify` — Verify a SEP-53 signed message ## `stellar message sign` Sign an arbitrary message using SEP-53 Signs a message following the SEP-53 specification for arbitrary message signing. The provided message will get prefixed with "Stellar Signed Message:\n", hashed with SHA-256, and signed with the ed25519 private key. Example: stellar message sign "Hello, World!" --sign-with-key alice **Usage:** `stellar message sign [OPTIONS] --sign-with-key [MESSAGE]` ###### **Arguments:** - `` — The message to sign. If not provided, reads from stdin. This should **not** include the SEP-53 prefix "Stellar Signed Message:\n", as it will be added automatically ###### **Global Options:** - `--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:** - `--base64` — Treat the message as base64-encoded binary data ###### **Signing Options:** - `--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` ## `stellar message verify` Verify a SEP-53 signed message Verifies that a signature was produced by the holder of the private key corresponding to the given account public key, following the SEP-53 specification. The provided message will get prefixed with "Stellar Signed Message:\n" before verification. Example: stellar message verify "Hello, World!" --signature BASE64_SIG --public-key GABC... **Usage:** `stellar message verify [OPTIONS] --signature --public-key [MESSAGE]` ###### **Arguments:** - `` — The message to verify. If not provided, reads from stdin. This should **not** include the SEP-53 prefix "Stellar Signed Message:\n", as it will be added automatically ###### **Global Options:** - `--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:** - `--base64` — Treat the message as base64-encoded binary data - `-s`, `--signature ` — The base64-encoded signature to verify - `-p`, `--public-key ` — The public key to verify the signature against. Can be an identity (--public-key alice), a public key (--public-key GDKW...) - `--hd-path ` — If public key identity is a seed phrase use this hd path, default is 0 ## `stellar fee-stats` ⚠️ Deprecated, use `fees stats` instead. Fetch network feestats **Usage:** `stellar fee-stats [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 ###### **RPC Options:** - `--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 fees` Fetch network feestats and configure CLI fee settings **Usage:** `stellar fees ` ###### **Subcommands:** - `stats` — Fetch the feestats from the network - `use` — Set the default inclusion fee settings for the CLI - `unset` — Remove the default inclusion fee settings for the CLI ## `stellar fees stats` Fetch the feestats from the network **Usage:** `stellar fees stats [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 ###### **RPC Options:** - `--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 fees use` Set the default inclusion fee settings for the CLI **Usage:** `stellar fees use [OPTIONS] <--amount |--fee-metric >` ###### **Global Options:** - `--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:** - `--amount ` — Set the default inclusion fee amount, in stroops. 1 stroop = 0.0000001 xlm - `--fee-metric ` — Set the default inclusion fee based on a metric from the network's fee stats Possible values: `max`, `min`, `mode`, `p10`, `p20`, `p30`, `p40`, `p50`, `p60`, `p70`, `p80`, `p90`, `p95`, `p99` ###### **RPC Options:** - `--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 fees unset` Remove the default inclusion fee settings for the CLI **Usage:** `stellar fees unset [OPTIONS]` ###### **Global Options:** - `--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