Stellar CLI Manual

​

stellar

• Generate and manage keys and accounts
• Build, deploy, and interact with contracts
• Deploy asset contracts
• Stream events
• Start local testnets
• Decode, encode XDR
• More!

• 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

stellar keys generate alice

stellar contract --help

stellar contract invoke --contract-id CCR6QKTWZQYW6YUJ7UP7XXZRLWQPFRV6SWBLQS4ZQOSAF4BOUD77OTE2 --source alice --network testnet -- --help

stellar contract invoke --contract-id CCR6QKTWZQYW6YUJ7UP7XXZRLWQPFRV6SWBLQS4ZQOSAF4BOUD77OTE2 --source alice --network testnet -- hello --to world

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 <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> — 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

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

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

Global Options:

• --config-dir <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> — ID of the Stellar classic asset to wrap, e.g. “native”, “USDC:G…5”, “USDC:alias”

RPC Options:

• --rpc-url <RPC_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

​

stellar contract asset deploy

Global Options:

• --config-dir <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> — ID of the Stellar classic asset to wrap, e.g. “USDC:G…5”
• --alias <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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config
• --resource-fee <RESOURCE_FEE> — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee
• --instructions <INSTRUCTIONS> — ⚠️ Deprecated, use --instruction-leeway to increase instructions. Number of instructions to allocate for the transaction
• --instruction-leeway <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_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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

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

Arguments:

• <ALIAS> — The contract alias that will be removed

Global Options:

• --config-dir <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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

​

stellar contract alias add

Arguments:

• <ALIAS> — The contract alias that will be used

Global Options:

• --config-dir <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 <CONTRACT_ID> [alias: id] — The contract id that will be associated with the alias

RPC Options:

• --rpc-url <RPC_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

​

stellar contract alias show

Arguments:

• <ALIAS> — The contract alias that will be displayed

Global Options:

• --config-dir <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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

​

stellar contract alias ls

Global Options:

• --config-dir <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

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
• java — Generate Java bindings
• flutter — Generate Flutter bindings
• swift — Generate Swift bindings
• php — Generate PHP bindings
• kmp — Generate Kotlin Multiplatform bindings

​

stellar contract bindings rust

Options:

• --wasm <WASM> — Path to wasm binary

​

stellar contract bindings typescript

Global Options:

• --config-dir <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> — Wasm file path on local filesystem. Provide this OR --wasm-hash OR --contract-id
• --wasm-hash <WASM_HASH> — Hash of Wasm blob on a network. Provide this OR --wasm OR --contract-id
• --contract-id <CONTRACT_ID> [alias: id] — Contract ID/alias on a network. Provide this OR --wasm-hash OR --wasm
• --output-dir <OUTPUT_DIR> — Where to place generated project
• --overwrite — Whether to overwrite output directory if it already exists

RPC Options:

• --rpc-url <RPC_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

​

stellar contract bindings python

​

stellar contract bindings java

​

stellar contract bindings flutter

​

stellar contract bindings swift

​

stellar contract bindings php

​

stellar contract bindings kmp

​

stellar contract build

Subcommands:

• archive — Generate (or inspect) the reproducible source archive for a contract

Container Options:

• --image <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 <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 <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 <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 <MEMORY> — Limit the memory available to the container, e.g. 2g or 512m

Features:

• --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 <META> — Add key-value to contract meta (adds the meta to the contractmetav0 custom section)

Options:

• --manifest-path <MANIFEST_PATH> — Path to Cargo.toml
• --package <PACKAGE> — Package to build If omitted, all packages that build for crate-type cdylib are built.
• --profile <PROFILE> — Build with the specified profile Default value: release
• --out-dir <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> — 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

Options:

• -o, --out-file <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

Global Options:

• --config-dir <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 <LEDGERS_TO_EXTEND> — Number of ledgers to extend the entries
• --ttl-ledger-only — Only print the new Time To Live ledger
• --contract-id <CONTRACT_ID> [alias: id] — Contract ID to which owns the data entries. If no keys provided the Contract’s instance will be extended
• --key <KEY> — Storage key (symbols only)
• --key-xdr <KEY_XDR> — Storage key (base64-encoded XDR)
• --wasm <WASM> — Path to Wasm file of contract code to extend
• --wasm-hash <WASM_HASH> — Path to Wasm file of contract code to extend
• --durability <DURABILITY> — Storage entry durability Default value: persistent Possible values:
  • persistent: Persistent
  • temporary: Temporary

RPC Options:

• --rpc-url <RPC_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config
• --resource-fee <RESOURCE_FEE> — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee
• --instructions <INSTRUCTIONS> — ⚠️ Deprecated, use --instruction-leeway to increase instructions. Number of instructions to allocate for the transaction
• --instruction-leeway <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_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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Arguments:

• <CONTRACT_CONSTRUCTOR_ARGS> — 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> — Package to build when auto-building without —wasm

Global Options:

• --config-dir <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 <META> — Add key-value to contract meta (adds the meta to the contractmetav0 custom section)

Options:

• --wasm <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 <WASM_HASH> — Hash of the already installed/deployed WASM file
• --salt <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 <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> — 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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config
• --resource-fee <RESOURCE_FEE> — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee
• --instructions <INSTRUCTIONS> — ⚠️ Deprecated, use --instruction-leeway to increase instructions. Number of instructions to allocate for the transaction
• --instruction-leeway <INSTRUCTION_LEEWAY> — Allow this many extra instructions when budgeting resources with transaction simulation
• --cost — Output the cost execution to stderr
• --auth-mode <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_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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Global Options:

• --config-dir <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 <CONTRACT_ID> [alias: id] — Contract ID to fetch
• --wasm-hash <WASM_HASH> — Wasm to fetch
• -o, --out-file <OUT_FILE> — Where to write output otherwise stdout is used

RPC Options:

• --rpc-url <RPC_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

​

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

Global Options:

• --config-dir <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> — ID of the Stellar classic asset to wrap, e.g. “native”, “USDC:G…5”, “USDC:alias”

RPC Options:

• --rpc-url <RPC_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

​

stellar contract id wasm

Global Options:

• --config-dir <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 <SALT> — ID of the Soroban contract

RPC Options:

• --rpc-url <RPC_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

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

Global Options:

• --config-dir <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> — Wasm file path on local filesystem. Provide this OR --wasm-hash OR --contract-id
• --wasm-hash <WASM_HASH> — Hash of Wasm blob on a network. Provide this OR --wasm OR --contract-id
• --contract-id <CONTRACT_ID> [alias: id] — Contract ID/alias on a network. Provide this OR --wasm-hash OR --wasm
• --output <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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

​

stellar contract info meta

Global Options:

• --config-dir <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> — Wasm file path on local filesystem. Provide this OR --wasm-hash OR --contract-id
• --wasm-hash <WASM_HASH> — Hash of Wasm blob on a network. Provide this OR --wasm OR --contract-id
• --contract-id <CONTRACT_ID> [alias: id] — Contract ID/alias on a network. Provide this OR --wasm-hash OR --wasm
• --output <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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

​

stellar contract info env-meta

Global Options:

• --config-dir <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> — Wasm file path on local filesystem. Provide this OR --wasm-hash OR --contract-id
• --wasm-hash <WASM_HASH> — Hash of Wasm blob on a network. Provide this OR --wasm OR --contract-id
• --contract-id <CONTRACT_ID> [alias: id] — Contract ID/alias on a network. Provide this OR --wasm-hash OR --wasm
• --output <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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

​

stellar contract info build

Global Options:

• --config-dir <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> — Wasm file path on local filesystem. Provide this OR --wasm-hash OR --contract-id
• --wasm-hash <WASM_HASH> — Hash of Wasm blob on a network. Provide this OR --wasm OR --contract-id
• --contract-id <CONTRACT_ID> [alias: id] — Contract ID/alias on a network. Provide this OR --wasm-hash OR --wasm

RPC Options:

• --rpc-url <RPC_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

​

stellar contract info hash

Global Options:

• --config-dir <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> — Path to a local .wasm file
• --contract-id <CONTRACT_ID> [alias: id] — Contract ID or alias of a deployed contract

RPC Options:

• --rpc-url <RPC_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

​

stellar contract init

Arguments:

• <PROJECT_PATH>

Options:

• --name <NAME> — An optional flag to specify a new contract’s name. Default value: hello-world
• --overwrite — Overwrite all existing files.

​

stellar contract inspect

Global Options:

• --config-dir <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> — Path to wasm binary
• --output <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

Build Options:

• --package <PACKAGE> — Package to build when —wasm is not provided

Global Options:

• --config-dir <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 <META> — Add key-value to contract meta (adds the meta to the contractmetav0 custom section)

Options:

• --wasm <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> — 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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config
• --resource-fee <RESOURCE_FEE> — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee
• --instructions <INSTRUCTIONS> — ⚠️ Deprecated, use --instruction-leeway to increase instructions. Number of instructions to allocate for the transaction
• --instruction-leeway <INSTRUCTION_LEEWAY> — Allow this many extra instructions when budgeting resources with transaction simulation
• --cost — Output the cost execution to stderr
• --auth-mode <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_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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Build Options:

• --package <PACKAGE> — Package to build when —wasm is not provided

Global Options:

• --config-dir <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 <META> — Add key-value to contract meta (adds the meta to the contractmetav0 custom section)

Options:

• --wasm <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> — 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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config
• --resource-fee <RESOURCE_FEE> — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee
• --instructions <INSTRUCTIONS> — ⚠️ Deprecated, use --instruction-leeway to increase instructions. Number of instructions to allocate for the transaction
• --instruction-leeway <INSTRUCTION_LEEWAY> — Allow this many extra instructions when budgeting resources with transaction simulation
• --cost — Output the cost execution to stderr
• --auth-mode <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_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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Arguments:

• <CONTRACT_FN_AND_ARGS> — Function name as subcommand, then arguments for that function as --arg-name value

Global Options:

• --config-dir <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 <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 <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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config
• --resource-fee <RESOURCE_FEE> — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee
• --instructions <INSTRUCTIONS> — ⚠️ Deprecated, use --instruction-leeway to increase instructions. Number of instructions to allocate for the transaction
• --instruction-leeway <INSTRUCTION_LEEWAY> — Allow this many extra instructions when budgeting resources with transaction simulation
• --cost — Output the cost execution to stderr
• --auth-mode <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_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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Options:

• --wasm <WASM> — Path to one or more wasm binaries
• --wasm-out <WASM_OUT> — Path to write the optimized WASM file to (defaults to same location as —wasm with .optimized.wasm suffix)

​

stellar contract read

Global Options:

• --config-dir <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 <OUTPUT> — Type of output to generate Default value: string Possible values:
  • string: String
  • json: Json
  • xdr: XDR
• --contract-id <CONTRACT_ID> [alias: id] — Contract ID to which owns the data entries. If no keys provided the Contract’s instance will be extended
• --key <KEY> — Storage key (symbols only)
• --key-xdr <KEY_XDR> — Storage key (base64-encoded XDR)
• --wasm <WASM> — Path to Wasm file of contract code to extend
• --wasm-hash <WASM_HASH> — Path to Wasm file of contract code to extend
• --durability <DURABILITY> — Storage entry durability Default value: persistent Possible values:
  • persistent: Persistent
  • temporary: Temporary

RPC Options:

• --rpc-url <RPC_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

​

stellar contract restore

Global Options:

• --config-dir <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 <CONTRACT_ID> [alias: id] — Contract ID to which owns the data entries. If no keys provided the Contract’s instance will be extended
• --key <KEY> — Storage key (symbols only)
• --key-xdr <KEY_XDR> — Storage key (base64-encoded XDR)
• --wasm <WASM> — Path to Wasm file of contract code to extend
• --wasm-hash <WASM_HASH> — Path to Wasm file of contract code to extend
• --durability <DURABILITY> — Storage entry durability Default value: persistent Possible values:
  • persistent: Persistent
  • temporary: Temporary
• --ledgers-to-extend <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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config
• --resource-fee <RESOURCE_FEE> — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee
• --instructions <INSTRUCTIONS> — ⚠️ Deprecated, use --instruction-leeway to increase instructions. Number of instructions to allocate for the transaction
• --instruction-leeway <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_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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Global Options:

• --config-dir <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

​

FILTERS:

• --id <CONTRACT_IDS> — 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 <TOPIC_FILTERS> — 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 <EVENT_TYPE> — Specifies which type of contract events to display Default value: all Possible values: all, contract, system

Global Options:

• --config-dir <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 <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 <CURSOR> — The cursor corresponding to the start of the event range
• --output <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 <COUNT> — The maximum number of events to display (defer to the server-defined limit) Default value: 10

RPC Options:

• --rpc-url <RPC_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

​

stellar env

Arguments:

• <NAME> — Env variable name to get the value of. E.g.: $ stellar env STELLAR_ACCOUNT

Global Options:

• --config-dir <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

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 <identity>

​

stellar keys add

Arguments:

• <NAME> — Name of identity

Global Options:

• --config-dir <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 <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 <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

Arguments:

• <NAME> — Name of identity to lookup. Required unless --ledger is provided

Global Options:

• --config-dir <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 <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

Arguments:

• <NAME> — Name of identity to lookup. Required unless --ledger is provided

Global Options:

• --config-dir <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 <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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

​

stellar keys generate

Arguments:

• <NAME> — Name of identity

Global Options:

• --config-dir <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 <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 <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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

​

stellar keys ls

Global Options:

• --config-dir <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

Arguments:

• <NAME> — Identity to remove

Global Options:

• --config-dir <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

Arguments:

• <NAME> — Name of identity to lookup, default is test identity

Global Options:

• --config-dir <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 <HD_PATH> — If identity is a seed phrase use this hd path, default is 0

​

stellar keys use

Arguments:

• <NAME> — Set the default network name

Global Options:

• --config-dir <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

Global Options:

• --config-dir <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

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 <network>
• root-account — Compute the root account keypair for a network

​

stellar network add

Arguments:

• <NAME> — Name of network

Global Options:

• --config-dir <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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server

​

stellar network rm

Arguments:

• <NAME> — Network to remove

Global Options:

• --config-dir <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

Global Options:

• --config-dir <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

Arguments:

• <NAME> — Set the default network name

Global Options:

• --config-dir <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

Global Options:

• --config-dir <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 <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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

​

stellar network info

Global Options:

• --config-dir <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 <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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

​

stellar network settings

Global Options:

• --config-dir <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 <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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

​

stellar network unset

Global Options:

• --config-dir <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

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

Global Options:

• --config-dir <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> — Network passphrase to derive the root account from
• -n, --network <NETWORK> — Name of network to use from config

​

stellar network root-account secret

Global Options:

• --config-dir <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> — Network passphrase to derive the root account from
• -n, --network <NETWORK> — Name of network to use from config

​

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 <engine>

​

stellar container logs

Arguments:

• <NAME> — Container to get logs from Default value: local

Options:

• -d, --docker-host <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 <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

Arguments:

• <NETWORK> — Network to start. Default is local Possible values: local, testnet, futurenet, pubnet

Options:

• -d, --docker-host <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 <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 <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 <MEMORY> — Limit the memory available to the container, e.g. 2g or 512m
• --name <NAME> — Optional argument to specify the container name
• -l, --limits <LIMITS> — Optional argument to specify the limits for the local network only
• -p, --ports-mapping <PORTS_MAPPING> — Argument to specify the HOST_PORT:CONTAINER_PORT mapping Default value: 8000:8000
• -t, --image-tag-override <IMAGE_TAG_OVERRIDE> — Optional argument to override the default docker image tag for the given network
• --protocol-version <PROTOCOL_VERSION> — Optional argument to specify the protocol version for the local network only

​

stellar container stop

Arguments:

• <NAME> — Container to stop Default value: local

Options:

• -d, --docker-host <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 <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

Arguments:

• <ENGINE> — 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 <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

Global Options:

• --config-dir <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

Subcommands:

• migrate — Migrate the local configuration to the global directory
• dir — Show the global configuration directory

​

stellar config migrate

Global Options:

• --config-dir <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

• 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.

Global Options:

• --config-dir <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

Subcommands:

• create — Create a ledger snapshot using a history archive
• merge — Merge multiple ledger snapshots into a single snapshot file

​

stellar snapshot create

​

Archive Options:

• --archive-url <ARCHIVE_URL> — Archive URL

​

Filter Options:

• --address <ADDRESS> — Account or contract address/alias to include in the snapshot
• --wasm-hash <WASM_HASHES> — WASM hashes to include in the snapshot

Global Options:

• --config-dir <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 <LEDGER> — The ledger sequence number to snapshot. Defaults to latest history archived ledger
• --output <OUTPUT> — Format of the out file Default value: json Possible values: json
• --out <OUT> — Out path that the snapshot is written to Default value: snapshot.json

RPC Options:

• --rpc-url <RPC_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

​

stellar snapshot merge

Arguments:

• <SNAPSHOTS> — Snapshot files to merge (at least 2 required)

Options:

• -o, --out <OUT> — Output path for the merged snapshot Default value: snapshot.json

​

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

​

stellar token transfer

Global Options:

• --config-dir <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 <ID> — The token to transfer from: a contract id or alias, native, or a classic asset as CODE:ISSUER
• --from <FROM> — Account to transfer tokens from. Signs and authorizes the transfer, so it must be an identity or secret key you control
• --to <TO> — Account or contract to transfer the tokens to. Accepts a G…/M… account, a C… contract address, or an alias
• --amount <AMOUNT> — Amount to transfer, in the token’s smallest unit (stroops for a Stellar Asset Contract)
• --output <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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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

Global Options:

• --config-dir <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 <ID> — The token to transfer from: a contract id or alias, native, or a classic asset as CODE:ISSUER
• --spender <SPENDER> — Spender drawing on its allowance. Signs and authorizes the transfer, so it must be an identity or secret key you control
• --from <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 <TO> — Account or contract to transfer the tokens to. Accepts a G…/M… account, a C… contract address, or an alias
• --amount <AMOUNT> — Amount to transfer, in the token’s smallest unit (stroops for a Stellar Asset Contract)
• --output <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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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

Global Options:

• --config-dir <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 <ID> — The token to burn: a contract id or alias, native, or a classic asset as CODE:ISSUER
• --from <FROM> — Account whose tokens are destroyed. Signs and authorizes the burn, so it must be an identity or secret key you control
• --amount <AMOUNT> — Amount to burn, in the token’s smallest unit (stroops for a Stellar Asset Contract)
• --output <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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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

Global Options:

• --config-dir <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 <ID> — The token to burn from: a contract id or alias, native, or a classic asset as CODE:ISSUER
• --spender <SPENDER> — Spender drawing on its allowance. Signs and authorizes the burn, so it must be an identity or secret key you control
• --from <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> — Amount to burn, in the token’s smallest unit (stroops for a Stellar Asset Contract)
• --output <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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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

Global Options:

• --config-dir <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 <ID> — The token to query: a contract id or alias, native, or a classic asset as CODE:ISSUER
• --account <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 <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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

​

stellar token name

Global Options:

• --config-dir <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 <ID> — The token to query: a contract id or alias, native, or a classic asset as CODE:ISSUER
• --output <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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

​

stellar token symbol

Global Options:

• --config-dir <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 <ID> — The token to query: a contract id or alias, native, or a classic asset as CODE:ISSUER
• --output <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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

​

stellar token decimals

Global Options:

• --config-dir <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 <ID> — The token to query: a contract id or alias, native, or a classic asset as CODE:ISSUER
• --output <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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

​

stellar token approve

Global Options:

• --config-dir <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 <ID> — The token to approve an allowance on: a contract id or alias, native, or a classic asset as CODE:ISSUER
• --from <FROM> — Account granting the allowance. Signs and authorizes the approval, so it must be an identity or secret key you control
• --spender <SPENDER> — Account or contract allowed to spend on --from’s behalf. Accepts a G…/M… account, a C… contract address, or an alias
• --amount <AMOUNT> — Allowance to grant, in the token’s smallest unit (stroops for a Stellar Asset Contract). Replaces any existing allowance
• --expiration-ledger <EXPIRATION_LEDGER> — Ledger sequence after which the allowance expires. Must be at or beyond the current ledger when the amount is positive
• --output <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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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

Global Options:

• --config-dir <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 <ID> — The token to query: a contract id or alias, native, or a classic asset as CODE:ISSUER
• --from <FROM> — Account or contract that granted the allowance (the owner of the funds)
• --spender <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 <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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

​

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

Subcommands:

• sequence-number — Edit the sequence number on a transaction

​

stellar tx update sequence-number

Subcommands:

• next — Fetch the source account’s seq-num and increment for the given tx

​

stellar tx update sequence-number next

Global Options:

• --config-dir <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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

​

stellar tx edit

​

stellar tx hash

Arguments:

• <TX_XDR> — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty

RPC Options:

• --rpc-url <RPC_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

​

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

Global Options:

• --config-dir <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> — Muxed Account to merge with, e.g. GBX..., ‘MBX…’

RPC Options:

• --rpc-url <RPC_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Global Options:

• --config-dir <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 <SPONSORED_ID> — Account that will be sponsored

RPC Options:

• --rpc-url <RPC_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Global Options:

• --config-dir <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 <BUMP_TO> — Sequence number to bump to

RPC Options:

• --rpc-url <RPC_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Global Options:

• --config-dir <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 <LINE>
• --limit <LIMIT> — Limit for the trust line, 0 to remove the trust line Default value: 9223372036854775807

RPC Options:

• --rpc-url <RPC_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Global Options:

• --config-dir <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> — Balance ID of the claimable balance to claim (64-character hex string)

RPC Options:

• --rpc-url <RPC_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Global Options:

• --config-dir <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 <FROM> — Account to clawback assets from, e.g. GBX...
• --asset <ASSET> — Asset to clawback
• --amount <AMOUNT> — Amount of the asset to clawback, in stroops. 1 stroop = 0.0000001 of the asset

RPC Options:

• --rpc-url <RPC_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Global Options:

• --config-dir <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> — 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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Global Options:

• --config-dir <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 <DESTINATION> — Account Id to create, e.g. GBX...
• --starting-balance <STARTING_BALANCE> — Initial balance in stroops of the account, default 1 XLM Default value: 10_000_000

RPC Options:

• --rpc-url <RPC_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Global Options:

• --config-dir <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> — Asset to be held in the ClaimableBalanceEntry Default value: native
• --amount <AMOUNT> — Amount of asset to store in the entry, in stroops. 1 stroop = 0.0000001 of the asset
• --claimant <CLAIMANTS> — 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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Global Options:

• --config-dir <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 <SELLING> — Asset to sell
• --buying <BUYING> — Asset to buy
• --amount <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> — 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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Global Options:

• --config-dir <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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Global Options:

• --config-dir <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> — Liquidity pool ID to deposit to
• --max-amount-a <MAX_AMOUNT_A> — Maximum amount of the first asset to deposit, in stroops
• --max-amount-b <MAX_AMOUNT_B> — Maximum amount of the second asset to deposit, in stroops
• --min-price <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 <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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Global Options:

• --config-dir <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> — Liquidity pool ID to withdraw from
• --amount <AMOUNT> — Amount of pool shares to withdraw, in stroops
• --min-amount-a <MIN_AMOUNT_A> — Minimum amount of the first asset to receive, in stroops
• --min-amount-b <MIN_AMOUNT_B> — Minimum amount of the second asset to receive, in stroops

RPC Options:

• --rpc-url <RPC_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Global Options:

• --config-dir <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 <SELLING> — Asset to sell
• --buying <BUYING> — Asset to buy
• --amount <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> — 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> — Offer ID. If 0, will create new offer. Otherwise, will update existing offer Default value: 0

RPC Options:

• --rpc-url <RPC_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Global Options:

• --config-dir <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 <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 <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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Global Options:

• --config-dir <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 <SELLING> — Asset to sell
• --buying <BUYING> — Asset to buy
• --amount <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> — 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> — Offer ID. If 0, will create new offer. Otherwise, will update existing offer Default value: 0

RPC Options:

• --rpc-url <RPC_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Global Options:

• --config-dir <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 <SEND_ASSET> — Asset to send (pay with)
• --send-amount <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 <DESTINATION> — Account that receives the payment
• --dest-asset <DEST_ASSET> — Asset that the destination will receive
• --dest-min <DEST_MIN> — Minimum amount of destination asset that the destination account can receive. The operation will fail if this amount cannot be met
• --path <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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Global Options:

• --config-dir <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 <SEND_ASSET> — Asset to send (pay with)
• --send-max <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 <DESTINATION> — Account that receives the payment
• --dest-asset <DEST_ASSET> — Asset that the destination will receive
• --dest-amount <DEST_AMOUNT> — Exact amount of destination asset that the destination account will receive, in stroops. 1 stroop = 0.0000001 of the asset
• --path <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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Global Options:

• --config-dir <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 <DESTINATION> — Account to send to, e.g. GBX...
• --asset <ASSET> — Asset to send, default native, e.i. XLM Default value: native
• --amount <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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Global Options:

• --config-dir <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> — Account ID (required for all sponsorship types)
• --asset <ASSET> — Asset for trustline sponsorship (format: CODE:ISSUER)
• --data-name <DATA_NAME> — Data name for data entry sponsorship
• --offer-id <OFFER_ID> — Offer ID for offer sponsorship
• --liquidity-pool-id <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> — 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> — Signer key for signer sponsorship

RPC Options:

• --rpc-url <RPC_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Global Options:

• --config-dir <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 <INFLATION_DEST> — Account of the inflation destination
• --master-weight <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 <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 <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 <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 <HOME_DOMAIN> — Sets the home domain of an account. See https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/federation
• --signer <SIGNER> — Add, update, or remove a signer from an account
• --signer-weight <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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Global Options:

• --config-dir <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 <TRUSTOR> — Account to set trustline flags for, e.g. GBX..., or alias, or muxed account, `M123…“
• --asset <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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Subcommands:

• add — Add Operation to a transaction

​

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

Arguments:

• <TX_XDR> — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty

Global Options:

• --config-dir <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 <OPERATION_SOURCE_ACCOUNT> [alias: op-source] — Source account used for the operation
• --account <ACCOUNT> — Muxed Account to merge with, e.g. GBX..., ‘MBX…’

RPC Options:

• --rpc-url <RPC_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Arguments:

• <TX_XDR> — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty

Global Options:

• --config-dir <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 <OPERATION_SOURCE_ACCOUNT> [alias: op-source] — Source account used for the operation
• --sponsored-id <SPONSORED_ID> — Account that will be sponsored

RPC Options:

• --rpc-url <RPC_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Arguments:

• <TX_XDR> — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty

Global Options:

• --config-dir <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 <OPERATION_SOURCE_ACCOUNT> [alias: op-source] — Source account used for the operation
• --bump-to <BUMP_TO> — Sequence number to bump to

RPC Options:

• --rpc-url <RPC_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Arguments:

• <TX_XDR> — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty

Global Options:

• --config-dir <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 <OPERATION_SOURCE_ACCOUNT> [alias: op-source] — Source account used for the operation
• --line <LINE>
• --limit <LIMIT> — Limit for the trust line, 0 to remove the trust line Default value: 9223372036854775807

RPC Options:

• --rpc-url <RPC_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Arguments:

• <TX_XDR> — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty

Global Options:

• --config-dir <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 <OPERATION_SOURCE_ACCOUNT> [alias: op-source] — Source account used for the operation
• --balance-id <BALANCE_ID> — Balance ID of the claimable balance to claim (64-character hex string)

RPC Options:

• --rpc-url <RPC_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Arguments:

• <TX_XDR> — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty

Global Options:

• --config-dir <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 <OPERATION_SOURCE_ACCOUNT> [alias: op-source] — Source account used for the operation
• --from <FROM> — Account to clawback assets from, e.g. GBX...
• --asset <ASSET> — Asset to clawback
• --amount <AMOUNT> — Amount of the asset to clawback, in stroops. 1 stroop = 0.0000001 of the asset

RPC Options:

• --rpc-url <RPC_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Arguments:

• <TX_XDR> — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty

Global Options:

• --config-dir <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 <OPERATION_SOURCE_ACCOUNT> [alias: op-source] — Source account used for the operation
• --balance-id <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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Arguments:

• <TX_XDR> — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty

Global Options:

• --config-dir <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 <OPERATION_SOURCE_ACCOUNT> [alias: op-source] — Source account used for the operation
• --destination <DESTINATION> — Account Id to create, e.g. GBX...
• --starting-balance <STARTING_BALANCE> — Initial balance in stroops of the account, default 1 XLM Default value: 10_000_000

RPC Options:

• --rpc-url <RPC_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Arguments:

• <TX_XDR> — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty

Global Options:

• --config-dir <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 <OPERATION_SOURCE_ACCOUNT> [alias: op-source] — Source account used for the operation
• --asset <ASSET> — Asset to be held in the ClaimableBalanceEntry Default value: native
• --amount <AMOUNT> — Amount of asset to store in the entry, in stroops. 1 stroop = 0.0000001 of the asset
• --claimant <CLAIMANTS> — 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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Arguments:

• <TX_XDR> — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty

Global Options:

• --config-dir <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 <OPERATION_SOURCE_ACCOUNT> [alias: op-source] — Source account used for the operation
• --selling <SELLING> — Asset to sell
• --buying <BUYING> — Asset to buy
• --amount <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> — 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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Arguments:

• <TX_XDR> — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty

Global Options:

• --config-dir <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 <OPERATION_SOURCE_ACCOUNT> [alias: op-source] — Source account used for the operation

RPC Options:

• --rpc-url <RPC_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Arguments:

• <TX_XDR> — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty

Global Options:

• --config-dir <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 <OPERATION_SOURCE_ACCOUNT> [alias: op-source] — Source account used for the operation
• --liquidity-pool-id <LIQUIDITY_POOL_ID> — Liquidity pool ID to deposit to
• --max-amount-a <MAX_AMOUNT_A> — Maximum amount of the first asset to deposit, in stroops
• --max-amount-b <MAX_AMOUNT_B> — Maximum amount of the second asset to deposit, in stroops
• --min-price <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 <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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Arguments:

• <TX_XDR> — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty

Global Options:

• --config-dir <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 <OPERATION_SOURCE_ACCOUNT> [alias: op-source] — Source account used for the operation
• --liquidity-pool-id <LIQUIDITY_POOL_ID> — Liquidity pool ID to withdraw from
• --amount <AMOUNT> — Amount of pool shares to withdraw, in stroops
• --min-amount-a <MIN_AMOUNT_A> — Minimum amount of the first asset to receive, in stroops
• --min-amount-b <MIN_AMOUNT_B> — Minimum amount of the second asset to receive, in stroops

RPC Options:

• --rpc-url <RPC_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Arguments:

• <TX_XDR> — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty

Global Options:

• --config-dir <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 <OPERATION_SOURCE_ACCOUNT> [alias: op-source] — Source account used for the operation
• --selling <SELLING> — Asset to sell
• --buying <BUYING> — Asset to buy
• --amount <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> — 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> — Offer ID. If 0, will create new offer. Otherwise, will update existing offer Default value: 0

RPC Options:

• --rpc-url <RPC_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Arguments:

• <TX_XDR> — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty

Global Options:

• --config-dir <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 <OPERATION_SOURCE_ACCOUNT> [alias: op-source] — Source account used for the operation
• --data-name <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 <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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Arguments:

• <TX_XDR> — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty

Global Options:

• --config-dir <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 <OPERATION_SOURCE_ACCOUNT> [alias: op-source] — Source account used for the operation
• --selling <SELLING> — Asset to sell
• --buying <BUYING> — Asset to buy
• --amount <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> — 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> — Offer ID. If 0, will create new offer. Otherwise, will update existing offer Default value: 0

RPC Options:

• --rpc-url <RPC_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Arguments:

• <TX_XDR> — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty

Global Options:

• --config-dir <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 <OPERATION_SOURCE_ACCOUNT> [alias: op-source] — Source account used for the operation
• --send-asset <SEND_ASSET> — Asset to send (pay with)
• --send-max <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 <DESTINATION> — Account that receives the payment
• --dest-asset <DEST_ASSET> — Asset that the destination will receive
• --dest-amount <DEST_AMOUNT> — Exact amount of destination asset that the destination account will receive, in stroops. 1 stroop = 0.0000001 of the asset
• --path <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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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 <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 <FEE> — ⚠️ Deprecated, use --inclusion-fee. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
• --inclusion-fee <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

Arguments:

• <TX_XDR> — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty

Global Options:

• --config-dir <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 <OPERATION_SOURCE_ACCOUNT> [alias: op-source] — Source account used for the operation
• --send-asset <SEND_ASSET> — Asset to send (pay with)
• --send-amount <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 <DESTINATION> — Account that receives the payment
• --dest-asset <DEST_ASSET> — Asset that the destination will receive
• --dest-min <DEST_MIN> — Minimum amount of destination asset that the destination account can receive. The operation will fail if this amount cannot be met
• --path <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_URL> — RPC server endpoint
• --rpc-header <RPC_HEADERS> — 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> — Network passphrase to sign the transaction sent to the rpc server
• -n, --network <NETWORK> — Name of network to use from config

Signing Options:

• --sign-with-key <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 <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: