diff --git a/CLI.md b/CLI.md index 34f009ab..a7bbb5fe 100644 --- a/CLI.md +++ b/CLI.md @@ -90,7 +90,7 @@ Create a new Smart Contract project based on a template. positional arguments: name -optional arguments: +options: -h, --help show this help message and exit --template TEMPLATE the template to use --directory DIRECTORY 🗀 the parent directory of the project (default: current directory) @@ -105,7 +105,7 @@ usage: mxpy contract templates [-h] ... List the available Smart Contract templates. -optional arguments: +options: -h, --help show this help message and exit ``` @@ -121,7 +121,7 @@ Build a Smart Contract project using the appropriate buildchain. positional arguments: project 🗀 the project directory (default: current directory) -optional arguments: +options: -h, --help show this help message and exit -r, --recursive locate projects recursively --debug set debug flag (default: False) @@ -147,7 +147,7 @@ Clean a Smart Contract project. positional arguments: project 🗀 the project directory (default: current directory) -optional arguments: +options: -h, --help show this help message and exit -r, --recursive locate projects recursively @@ -189,9 +189,8 @@ Output example: } } -optional arguments: +options: -h, --help show this help message and exit - --project PROJECT 🗀 the project directory (default: current directory) --bytecode BYTECODE the file containing the WASM bytecode --metadata-not-upgradeable ‼ mark the contract as NOT upgradeable (default: upgradeable) --metadata-not-readable ‼ mark the contract as NOT readable (default: readable) @@ -280,7 +279,7 @@ Output example: positional arguments: contract 🖄 the address of the Smart Contract -optional arguments: +options: -h, --help show this help message and exit --outfile OUTFILE where to save the output (default: stdout) --pem PEM 🔑 the PEM file, if keyfile not provided @@ -367,10 +366,9 @@ Output example: positional arguments: contract 🖄 the address of the Smart Contract -optional arguments: +options: -h, --help show this help message and exit --outfile OUTFILE where to save the output (default: stdout) - --project PROJECT 🗀 the project directory (default: current directory) --bytecode BYTECODE the file containing the WASM bytecode --metadata-not-upgradeable ‼ mark the contract as NOT upgradeable (default: upgradeable) --metadata-not-readable ‼ mark the contract as NOT readable (default: readable) @@ -430,7 +428,7 @@ Query a Smart Contract (call a pure function) positional arguments: contract 🖄 the address of the Smart Contract -optional arguments: +options: -h, --help show this help message and exit --proxy PROXY 🔗 the URL of the proxy (default: https://testnet-gateway.multiversx.com) --function FUNCTION the function to call @@ -451,7 +449,7 @@ Print a detailed report of the smart contracts. positional arguments: project 🗀 the project directory (default: current directory) -optional arguments: +options: -h, --help show this help message and exit --skip-build skips the step of building of the wasm contracts --skip-twiggy skips the steps of building the debug wasm files and running twiggy @@ -519,7 +517,7 @@ Output example: "emittedTransactionHash": "the transaction hash" } -optional arguments: +options: -h, --help show this help message and exit --pem PEM 🔑 the PEM file, if keyfile not provided --pem-index PEM_INDEX 🔑 the index in the PEM file (default: 0) @@ -588,7 +586,7 @@ Output example: "emittedTransactionHash": "the transaction hash" } -optional arguments: +options: -h, --help show this help message and exit --infile INFILE input file (a previously saved transaction) --outfile OUTFILE where to save the output (the hash) (default: stdout) @@ -615,7 +613,7 @@ Output example: } } -optional arguments: +options: -h, --help show this help message and exit --hash HASH the hash --sender SENDER the sender address @@ -649,7 +647,7 @@ usage: mxpy hyperblock get [-h] ... Get hyperblock -optional arguments: +options: -h, --help show this help message and exit --proxy PROXY 🔗 the URL of the proxy (default: https://testnet-gateway.multiversx.com) --key KEY the hash or the nonce of the hyperblock @@ -696,7 +694,7 @@ usage: mxpy validator stake [-h] ... Stake value into the Network -optional arguments: +options: -h, --help show this help message and exit --proxy PROXY 🔗 the URL of the proxy (default: https://testnet- gateway.multiversx.com) @@ -747,7 +745,7 @@ usage: mxpy validator unstake [-h] ... Unstake value -optional arguments: +options: -h, --help show this help message and exit --proxy PROXY 🔗 the URL of the proxy (default: https://testnet- gateway.multiversx.com) @@ -796,7 +794,7 @@ usage: mxpy validator unjail [-h] ... Unjail a Validator Node -optional arguments: +options: -h, --help show this help message and exit --proxy PROXY 🔗 the URL of the proxy (default: https://testnet- gateway.multiversx.com) @@ -845,7 +843,7 @@ usage: mxpy validator unbond [-h] ... Unbond tokens for a bls key -optional arguments: +options: -h, --help show this help message and exit --proxy PROXY 🔗 the URL of the proxy (default: https://testnet- gateway.multiversx.com) @@ -894,7 +892,7 @@ usage: mxpy validator change-reward-address [-h] ... Change the reward address -optional arguments: +options: -h, --help show this help message and exit --proxy PROXY 🔗 the URL of the proxy (default: https://testnet- gateway.multiversx.com) @@ -943,7 +941,7 @@ usage: mxpy validator claim [-h] ... Claim rewards -optional arguments: +options: -h, --help show this help message and exit --proxy PROXY 🔗 the URL of the proxy (default: https://testnet- gateway.multiversx.com) @@ -1012,7 +1010,7 @@ usage: mxpy account get [-h] ... Query account details (nonce, balance etc.) -optional arguments: +options: -h, --help show this help message and exit --proxy PROXY 🔗 the URL of the proxy (default: https://testnet-gateway.multiversx.com) --address ADDRESS 🖄 the address to query @@ -1056,7 +1054,7 @@ usage: mxpy wallet new [-h] ... Create a new wallet and print its mnemonic; optionally save as password-protected JSON (recommended) or PEM (not recommended) -optional arguments: +options: -h, --help show this help message and exit --format {raw-mnemonic,keystore-mnemonic,keystore-secret-key,pem} the format of the generated wallet file (default: None) @@ -1075,7 +1073,7 @@ usage: mxpy wallet convert [-h] ... Convert a wallet from one format to another -optional arguments: +options: -h, --help show this help message and exit --infile INFILE path to the input file --outfile OUTFILE path to the output file @@ -1102,7 +1100,7 @@ Helper for encoding and decoding bech32 addresses positional arguments: value the value to encode or decode -optional arguments: +options: -h, --help show this help message and exit --encode whether to encode --decode whether to decode @@ -1133,7 +1131,7 @@ usage: mxpy localnet setup [-h] ... Set up a localnet (runs 'prerequisites', 'build' and 'config' in one go) -optional arguments: +options: -h, --help show this help message and exit --configfile CONFIGFILE An optional configuration file describing the localnet @@ -1147,7 +1145,7 @@ usage: mxpy localnet new [-h] ... Create a new localnet configuration -optional arguments: +options: -h, --help show this help message and exit --configfile CONFIGFILE An optional configuration file describing the localnet @@ -1161,7 +1159,7 @@ usage: mxpy localnet prerequisites [-h] ... Download and verify the prerequisites for running a localnet -optional arguments: +options: -h, --help show this help message and exit --configfile CONFIGFILE An optional configuration file describing the localnet @@ -1175,7 +1173,7 @@ usage: mxpy localnet build [-h] ... Build necessary software for running a localnet -optional arguments: +options: -h, --help show this help message and exit --configfile CONFIGFILE An optional configuration file describing the localnet --software {node,seednode,proxy} [{node,seednode,proxy} ...] @@ -1191,7 +1189,7 @@ usage: mxpy localnet config [-h] ... Configure a localnet (required before starting it the first time or after clean) -optional arguments: +options: -h, --help show this help message and exit --configfile CONFIGFILE An optional configuration file describing the localnet @@ -1205,7 +1203,7 @@ usage: mxpy localnet start [-h] ... Start a localnet -optional arguments: +options: -h, --help show this help message and exit --configfile CONFIGFILE An optional configuration file describing the localnet --stop-after-seconds STOP_AFTER_SECONDS Stop the localnet after a given number of seconds (default: 31536000) @@ -1220,7 +1218,7 @@ usage: mxpy localnet clean [-h] ... Erase the currently configured localnet (must be already stopped) -optional arguments: +options: -h, --help show this help message and exit --configfile CONFIGFILE An optional configuration file describing the localnet @@ -1257,7 +1255,7 @@ usage: mxpy network num-shards [-h] ... Get the number of shards. -optional arguments: +options: -h, --help show this help message and exit --proxy PROXY 🔗 the URL of the proxy (default: https://testnet-gateway.multiversx.com) @@ -1271,7 +1269,7 @@ usage: mxpy network block-nonce [-h] ... Get the latest block nonce, by shard. -optional arguments: +options: -h, --help show this help message and exit --proxy PROXY 🔗 the URL of the proxy (default: https://testnet-gateway.multiversx.com) --shard SHARD the shard ID (use 4294967295 for metachain) @@ -1286,7 +1284,7 @@ usage: mxpy network chain [-h] ... Get the chain identifier. -optional arguments: +options: -h, --help show this help message and exit --proxy PROXY 🔗 the URL of the proxy (default: https://testnet-gateway.multiversx.com) @@ -1326,7 +1324,7 @@ positional arguments: {all,llvm,clang,cpp,rust,golang,vmtools,mx_chain_go,mx_chain_proxy_go,wasm-opt,twiggy,testwallets} the dependency to install -optional arguments: +options: -h, --help show this help message and exit --overwrite whether to overwrite an existing installation --tag TAG the tag or version to install @@ -1345,7 +1343,7 @@ positional arguments: {all,llvm,clang,cpp,rust,golang,vmtools,mx_chain_go,mx_chain_proxy_go,wasm-opt,twiggy,testwallets} the dependency to check -optional arguments: +options: -h, --help show this help message and exit --tag TAG the tag or version to check @@ -1386,7 +1384,7 @@ usage: mxpy config dump [-h] ... Dumps configuration. -optional arguments: +options: -h, --help show this help message and exit --defaults dump defaults instead of local config @@ -1403,7 +1401,7 @@ Gets a configuration value. positional arguments: name the name of the configuration entry -optional arguments: +options: -h, --help show this help message and exit ``` @@ -1420,7 +1418,7 @@ positional arguments: name the name of the configuration entry value the new value -optional arguments: +options: -h, --help show this help message and exit ``` @@ -1436,7 +1434,7 @@ Creates a new configuration. positional arguments: name the name of the configuration entry -optional arguments: +options: -h, --help show this help message and exit --template TEMPLATE template from which to create the new config @@ -1453,7 +1451,7 @@ Switch to a different config positional arguments: name the name of the configuration entry -optional arguments: +options: -h, --help show this help message and exit ``` @@ -1466,7 +1464,7 @@ usage: mxpy config list [-h] ... List available configs -optional arguments: +options: -h, --help show this help message and exit ``` @@ -1502,7 +1500,7 @@ usage: mxpy data parse [-h] ... Parses values from a given file -optional arguments: +options: -h, --help show this help message and exit --file FILE path of the file to parse --expression EXPRESSION the Python-Dictionary expression to evaluate in order to extract the data @@ -1517,7 +1515,7 @@ usage: mxpy data store [-h] ... Stores a key-value pair within a partition -optional arguments: +options: -h, --help show this help message and exit --key KEY the key --value VALUE the value to save @@ -1534,7 +1532,7 @@ usage: mxpy data load [-h] ... Loads a key-value pair from a storage partition -optional arguments: +options: -h, --help show this help message and exit --key KEY the key --partition PARTITION the storage partition (default: *)