diff --git a/cmd/soroban-cli/src/commands/config/locator.rs b/cmd/soroban-cli/src/commands/config/locator.rs index 2ec449231..2688b043f 100644 --- a/cmd/soroban-cli/src/commands/config/locator.rs +++ b/cmd/soroban-cli/src/commands/config/locator.rs @@ -69,6 +69,7 @@ pub struct Args { #[arg(long)] pub global: bool, + /// Location of config directory, default is "." #[arg(long, help_heading = "TESTING_OPTIONS")] pub config_dir: Option, } diff --git a/docs/soroban-cli-full-docs.md b/docs/soroban-cli-full-docs.md index 0e65fd630..3546594c6 100644 --- a/docs/soroban-cli-full-docs.md +++ b/docs/soroban-cli-full-docs.md @@ -109,7 +109,7 @@ Full CLI reference: https://github.com/stellar/soroban-tools/tree/main/docs/soro ###### **Options:** * `--global` — Use global config -* `--config-dir ` +* `--config-dir ` — Location of config directory, default is "." * `-f`, `--filter-logs ` — Filter logs output. To turn on "soroban_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 @@ -184,7 +184,7 @@ Add a new network * `--rpc-url ` — RPC server endpoint * `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server * `--global` — Use global config -* `--config-dir ` +* `--config-dir ` — Location of config directory, default is "." @@ -201,7 +201,7 @@ Remove a network ###### **Options:** * `--global` — Use global config -* `--config-dir ` +* `--config-dir ` — Location of config directory, default is "." @@ -214,7 +214,7 @@ List networks ###### **Options:** * `--global` — Use global config -* `--config-dir ` +* `--config-dir ` — Location of config directory, default is "." * `-l`, `--long` — Get more info about the networks @@ -252,7 +252,7 @@ Add a new identity (keypair, ledger, macOS keychain) * `--secret-key` — Add using secret_key Can provide with SOROBAN_SECRET_KEY * `--seed-phrase` — Add using 12 word seed phrase to generate secret_key * `--global` — Use global config -* `--config-dir ` +* `--config-dir ` — Location of config directory, default is "." @@ -270,7 +270,7 @@ Given an identity return its address (public key) * `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 * `--global` — Use global config -* `--config-dir ` +* `--config-dir ` — Location of config directory, default is "." @@ -291,7 +291,7 @@ Fund an identity on a test network * `--network ` — Name of network to use from config * `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 * `--global` — Use global config -* `--config-dir ` +* `--config-dir ` — Location of config directory, default is "." @@ -311,7 +311,7 @@ Generate a new identity with a seed phrase, currently 12 words * `--seed ` — Optional seed to use when generating seed phrase. Random otherwise * `-s`, `--as-secret` — Output the generated identity as a secret key * `--global` — Use global config -* `--config-dir ` +* `--config-dir ` — Location of config directory, default is "." * `--hd-path ` — When generating a secret key, which hd_path should be used from the original seed_phrase * `-d`, `--default-seed` — Generate the default seed phrase. Useful for testing. Equivalent to --seed 0000000000000000 * `--rpc-url ` — RPC server endpoint @@ -329,7 +329,7 @@ List identities ###### **Options:** * `--global` — Use global config -* `--config-dir ` +* `--config-dir ` — Location of config directory, default is "." * `-l`, `--long` @@ -347,7 +347,7 @@ Remove an identity ###### **Options:** * `--global` — Use global config -* `--config-dir ` +* `--config-dir ` — Location of config directory, default is "." @@ -365,7 +365,7 @@ Given an identity return its private key * `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 * `--global` — Use global config -* `--config-dir ` +* `--config-dir ` — Location of config directory, default is "." @@ -421,7 +421,7 @@ Get Id of builtin Soroban Asset Contract. Deprecated, use `soroban contract id a * `--source-account ` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). Default: `identity generate --default-seed` * `--hd-path ` — If using a seed phrase, which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` * `--global` — Use global config -* `--config-dir ` +* `--config-dir ` — Location of config directory, default is "." @@ -440,7 +440,7 @@ Deploy builtin Soroban Asset Contract * `--source-account ` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). Default: `identity generate --default-seed` * `--hd-path ` — If using a seed phrase, which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` * `--global` — Use global config -* `--config-dir ` +* `--config-dir ` — Location of config directory, default is "." * `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` @@ -498,7 +498,7 @@ Generate a TypeScript / JavaScript package * `--overwrite` — Whether to overwrite output directory if it already exists * `--contract-id ` — The contract ID/address on the network * `--global` — Use global config -* `--config-dir ` +* `--config-dir ` — Location of config directory, default is "." * `--rpc-url ` — RPC server endpoint * `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server * `--network ` — Name of network to use from config @@ -563,7 +563,7 @@ If no keys are specified the contract itself is extended. * `--source-account ` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). Default: `identity generate --default-seed` * `--hd-path ` — If using a seed phrase, which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` * `--global` — Use global config -* `--config-dir ` +* `--config-dir ` — Location of config directory, default is "." * `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` @@ -587,7 +587,7 @@ Deploy a wasm contract * `--source-account ` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). Default: `identity generate --default-seed` * `--hd-path ` — If using a seed phrase, which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` * `--global` — Use global config -* `--config-dir ` +* `--config-dir ` — Location of config directory, default is "." * `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` @@ -608,7 +608,7 @@ Fetch a contract's Wasm binary * `--id ` — Contract ID to fetch * `-o`, `--out-file ` — Where to write output otherwise stdout is used * `--global` — Use global config -* `--config-dir ` +* `--config-dir ` — Location of config directory, default is "." * `--rpc-url ` — RPC server endpoint * `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server * `--network ` — Name of network to use from config @@ -643,7 +643,7 @@ Deploy builtin Soroban Asset Contract * `--source-account ` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). Default: `identity generate --default-seed` * `--hd-path ` — If using a seed phrase, which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` * `--global` — Use global config -* `--config-dir ` +* `--config-dir ` — Location of config directory, default is "." @@ -662,7 +662,7 @@ Deploy normal Wasm Contract * `--source-account ` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). Default: `identity generate --default-seed` * `--hd-path ` — If using a seed phrase, which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` * `--global` — Use global config -* `--config-dir ` +* `--config-dir ` — Location of config directory, default is "." @@ -688,7 +688,7 @@ Inspect a WASM file listing contract functions, meta, etc Pretty print of contract spec entries * `--global` — Use global config -* `--config-dir ` +* `--config-dir ` — Location of config directory, default is "." @@ -706,7 +706,7 @@ Install a WASM file to the ledger without creating a contract instance * `--source-account ` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). Default: `identity generate --default-seed` * `--hd-path ` — If using a seed phrase, which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` * `--global` — Use global config -* `--config-dir ` +* `--config-dir ` — Location of config directory, default is "." * `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` @@ -741,7 +741,7 @@ soroban contract invoke ... -- --help * `--source-account ` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). Default: `identity generate --default-seed` * `--hd-path ` — If using a seed phrase, which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` * `--global` — Use global config -* `--config-dir ` +* `--config-dir ` — Location of config directory, default is "." * `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` @@ -800,7 +800,7 @@ Print the current value of a contract-data ledger entry * `--source-account ` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). Default: `identity generate --default-seed` * `--hd-path ` — If using a seed phrase, which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` * `--global` — Use global config -* `--config-dir ` +* `--config-dir ` — Location of config directory, default is "." @@ -835,7 +835,7 @@ If no keys are specificed the contract itself is restored. * `--source-account ` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). Default: `identity generate --default-seed` * `--hd-path ` — If using a seed phrase, which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` * `--global` — Use global config -* `--config-dir ` +* `--config-dir ` — Location of config directory, default is "." * `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` @@ -876,7 +876,7 @@ Watch the network for contract events Possible values: `all`, `contract`, `system` * `--global` — Use global config -* `--config-dir ` +* `--config-dir ` — Location of config directory, default is "." * `--rpc-url ` — RPC server endpoint * `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server * `--network ` — Name of network to use from config @@ -916,7 +916,7 @@ Add a new identity (keypair, ledger, macOS keychain) * `--secret-key` — Add using secret_key Can provide with SOROBAN_SECRET_KEY * `--seed-phrase` — Add using 12 word seed phrase to generate secret_key * `--global` — Use global config -* `--config-dir ` +* `--config-dir ` — Location of config directory, default is "." @@ -934,7 +934,7 @@ Given an identity return its address (public key) * `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 * `--global` — Use global config -* `--config-dir ` +* `--config-dir ` — Location of config directory, default is "." @@ -955,7 +955,7 @@ Fund an identity on a test network * `--network ` — Name of network to use from config * `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 * `--global` — Use global config -* `--config-dir ` +* `--config-dir ` — Location of config directory, default is "." @@ -975,7 +975,7 @@ Generate a new identity with a seed phrase, currently 12 words * `--seed ` — Optional seed to use when generating seed phrase. Random otherwise * `-s`, `--as-secret` — Output the generated identity as a secret key * `--global` — Use global config -* `--config-dir ` +* `--config-dir ` — Location of config directory, default is "." * `--hd-path ` — When generating a secret key, which hd_path should be used from the original seed_phrase * `-d`, `--default-seed` — Generate the default seed phrase. Useful for testing. Equivalent to --seed 0000000000000000 * `--rpc-url ` — RPC server endpoint @@ -993,7 +993,7 @@ List identities ###### **Options:** * `--global` — Use global config -* `--config-dir ` +* `--config-dir ` — Location of config directory, default is "." * `-l`, `--long` @@ -1011,7 +1011,7 @@ Remove an identity ###### **Options:** * `--global` — Use global config -* `--config-dir ` +* `--config-dir ` — Location of config directory, default is "." @@ -1029,7 +1029,7 @@ Given an identity return its private key * `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 * `--global` — Use global config -* `--config-dir ` +* `--config-dir ` — Location of config directory, default is "." @@ -1074,7 +1074,7 @@ Deploy a token contract to wrap an existing Stellar classic asset for smart cont * `--source-account ` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). Default: `identity generate --default-seed` * `--hd-path ` — If using a seed phrase, which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` * `--global` — Use global config -* `--config-dir ` +* `--config-dir ` — Location of config directory, default is "." * `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` @@ -1096,7 +1096,7 @@ Compute the expected contract id for the given asset Deprecated, use `soroban co * `--source-account ` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). Default: `identity generate --default-seed` * `--hd-path ` — If using a seed phrase, which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` * `--global` — Use global config -* `--config-dir ` +* `--config-dir ` — Location of config directory, default is "." @@ -1275,7 +1275,7 @@ Add a new network * `--rpc-url ` — RPC server endpoint * `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server * `--global` — Use global config -* `--config-dir ` +* `--config-dir ` — Location of config directory, default is "." @@ -1292,7 +1292,7 @@ Remove a network ###### **Options:** * `--global` — Use global config -* `--config-dir ` +* `--config-dir ` — Location of config directory, default is "." @@ -1305,7 +1305,7 @@ List networks ###### **Options:** * `--global` — Use global config -* `--config-dir ` +* `--config-dir ` — Location of config directory, default is "." * `-l`, `--long` — Get more info about the networks