CLI.md.sh

#!/usr/bin/env bash

export PYTHONPATH=.

CLI="python3 -m multiversx_sdk_cli.cli"
CLI_ALIAS="mxpy"

code() {
    printf "\n\`\`\`\n" >> CLI.md
}

group() {
    printf "## Group **$1**\n\n" >> CLI.md

    code
    printf "$ ${CLI_ALIAS} $2 --help\n" >> CLI.md
    ${CLI} ${2} --help >> CLI.md
    code
}

command() {
    printf "### $1\n\n" >> CLI.md

    code
    printf "$ ${CLI_ALIAS} $2 --help\n" >> CLI.md
    ${CLI} ${2} --help >> CLI.md
    code
}

generate() {
    echo -n > CLI.md
    printf "# Command Line Interface\n\n" >> CLI.md

    printf "## Overview\n\n" >> CLI.md
    printf "**${CLI_ALIAS}** exposes a number of CLI **commands**, organized within **groups**.\n\n" >> CLI.md

    code
    printf "$ ${CLI_ALIAS} --help\n" >> CLI.md
    ${CLI} --help >> CLI.md
    code

    group "Contract" "contract"
    command "Contract.Deploy" "contract deploy"
    command "Contract.Call" "contract call"
    command "Contract.Upgrade" "contract upgrade"
    command "Contract.Query" "contract query"
    command "Contract.Verify" "contract verify"
    command "Contract.Unverify" "contract unverify"
    command "Contract.ReproducibleBuild" "contract reproducible-build"

    group "Transactions" "tx"
    command "Transactions.New" "tx new"
    command "Transactions.Send" "tx send"
    command "Transactions.Sign" "tx sign"
    command "Transactions.Relay" "tx relay"

    group "Validator" "validator"
    command "Validator.Stake" "validator stake"
    command "Validator.Unstake" "validator unstake"
    command "Validator.Unjail" "validator unjail"
    command "Validator.Unbond" "validator unbond"
    command "Validator.ChangeRewardAddress" "validator change-reward-address"
    command "Validator.Claim" "validator claim"
    command "Validator.UnstakeNodes" "validator unstake-nodes"
    command "Validator.UnstakeTokens" "validator unstake-tokens"
    command "Validator.UnbondNodes" "validator unbond-nodes"
    command "Validator.UnbondTokens" "validator unbond-tokens"
    command "Validator.CleanRegisteredData" "validator clean-registered-data"
    command "Validator.RestakeUnstakedNodes" "validator restake-unstaked-nodes"

    group "StakingProvider" "staking-provider"
    command "StakingProvider.CreateNewDelegationContract" "staking-provider create-new-delegation-contract"
    command "StakingProvider.GetContractAddress" "staking-provider get-contract-address"
    command "StakingProvider.AddNodes" "staking-provider add-nodes"
    command "StakingProvider.RemoveNodes" "staking-provider remove-nodes"
    command "StakingProvider.StakeNodes" "staking-provider stake-nodes"
    command "StakingProvider.UnbondNodes" "staking-provider unbond-nodes"
    command "StakingProvider.UnstakeNodes" "staking-provider unstake-nodes"
    command "StakingProvider.UnjailNodes" "staking-provider unjail-nodes"
    command "StakingProvider.Delegate" "staking-provider delegate"
    command "StakingProvider.ClaimRewards" "staking-provider claim-rewards"
    command "StakingProvider.RedelegateRewards" "staking-provider redelegate-rewards"
    command "StakingProvider.Undelegate" "staking-provider undelegate"
    command "StakingProvider.Withdraw" "staking-provider withdraw"
    command "StakingProvider.ChangeServiceFee" "staking-provider change-service-fee"
    command "StakingProvider.ModifyDelegationCap" "staking-provider modify-delegation-cap"
    command "StakingProvider.AutomaticActivation" "staking-provider automatic-activation"
    command "StakingProvider.RedelegateCap" "staking-provider redelegate-cap"
    command "StakingProvider.SetMetadata" "staking-provider set-metadata"
    command "StakingProvider.MakeDelegationContractFromValidator" "staking-provider make-delegation-contract-from-validator"

    group "Wallet" "wallet"
    command "Wallet.New" "wallet new"
    command "Wallet.Convert" "wallet convert"
    command "Wallet.Bech32" "wallet bech32"
    command "Wallet.SignMessage" "wallet sign-message"
    command "Wallet.VerifyMessage" "wallet verify-message"

    group "ValidatorWallet" "validator-wallet"
    command "Wallet.New" "validator-wallet new"
    command "Wallet.Convert" "validator-wallet convert"
    command "Wallet.SignMessage" "validator-wallet sign-message"
    command "Wallet.VerifyMessage" "validator-wallet verify-message-signature"

    group "Localnet" "localnet"
    command "Localnet.Setup" "localnet setup"
    command "Localnet.New" "localnet new"
    command "Localnet.Prerequisites" "localnet prerequisites"
    command "Localnet.Build" "localnet build"
    command "Localnet.Config" "localnet config"
    command "Localnet.Start" "localnet start"
    command "Localnet.Clean" "localnet clean"

    group "Dependencies" "deps"
    command "Dependencies.Install" "deps install"
    command "Dependencies.Check" "deps check"

    group "Configuration" "config"
    command "Configuration.Dump" "config dump"
    command "Configuration.Get" "config get"
    command "Configuration.Set" "config set"
    command "Configuration.New" "config new"
    command "Configuration.Switch" "config switch"
    command "Configuration.List" "config list"
    command "Configuration.Reset" "config reset"

    group "Data" "data"
    command "Data.Dump" "data parse"
    command "Data.Store" "data store"
    command "Data.Load" "data load"

    group "Faucet" "faucet"
    command "Faucet.Request" "faucet request"

    group "Multisig" "multisig"
    command "Multisig.Deploy" "multisig deploy"
    command "Multisig.Deposit" "multisig deposit"
    command "Multisig.DiscardAction" "multisig discard-action"
    command "Multisig.DiscardBatch" "multisig discard-batch"
    command "Multisig.AddBoardMember" "multisig add-board-member"
    command "Multisig.AddProposer" "multisig add-proposer"
    command "Multisig.RemoveUser" "multisig remove-user"
    command "Multisig.ChangeQuorum" "multisig change-quorum"
    command "Multisig.TransferAndExecute" "multisig transfer-and-execute"
    command "Multisig.TransferAndExecuteEsdt" "multisig transfer-and-execute-esdt"
    command "Multisig.AsyncCall" "multisig async-call"
    command "Multisig.DeployFromSource" "multisig deploy-from-source"
    command "Multisig.UpgradeFromSource" "multisig upgrade-from-source"
    command "Multisig.SignAction" "multisig sign-action"
    command "Multisig.SignBatch" "multisig sign-batch"
    command "Multisig.SignAndPerform" "multisig sign-and-perform"
    command "Multisig.SignBatchAndPerform" "multisig sign-batch-and-perform"
    command "Multisig.UnsignAction" "multisig unsign-action"
    command "Multisig.UnsignBatch" "multisig unsign-batch"
    command "Multisig.UnsignForOutdatedMembers" "multisig unsign-for-outdated-members"
    command "Multisig.PerformAction" "multisig perform-action"
    command "Multisig.PerformBatch" "multisig perform-batch"
    command "Multisig.GetQuorum" "multisig get-quorum"
    command "Multisig.GetNumBoardMembers" "multisig get-num-board-members"
    command "Multisig.GetNumGroups" "multisig get-num-groups"
    command "Multisig.GetNumProposers" "multisig get-num-proposers"
    command "Multisig.GetActionGroup" "multisig get-action-group"
    command "Multisig.GetLastActionGroupId" "multisig get-last-action-group-id"
    command "Multisig.GetLastActionLastIndex" "multisig get-action-last-index"
    command "Multisig.IsSignedBy" "multisig is-signed-by"
    command "Multisig.IsQuorumReached" "multisig is-quorum-reached"
    command "Multisig.GetPendingActions" "multisig get-pending-actions"
    command "Multisig.GetUserRole" "multisig get-user-role"
    command "Multisig.GetBoardMemebers" "multisig get-board-members"
    command "Multisig.GetProposers" "multisig get-proposers"
    command "Multisig.GetActionData" "multisig get-action-data"
    command "Multisig.GetActionSigners" "multisig get-action-signers"
    command "Multisig.GetActionSignersCount" "multisig get-action-signers-count"
    command "Multisig.GetActionValidSignersCount" "multisig get-action-valid-signers-count"
    command "Multisig.ParseProposeAction" "multisig parse-propose-action"

    group "Governance" "governance"
    command "Governance.Propose" "governance propose"
    command "Governance.Vote" "governance vote"
    command "Governance.CloseProposal" "governance close-proposal"
    command "Governance.ClearEndedProposals" "governance clear-ended-proposals"
    command "Governance.ClaimAccumulatedFees" "governance claim-accumulated-fees"
    command "Governance.ChangeConfig" "governance change-config"
    command "Governance.GetVotingPower" "governance get-voting-power"
    command "Governance.GetConfig" "governance get-config"
    command "Governance.GetDelegatedVoteInfo" "governance get-delegated-vote-info"

    group "ConfigEnv" "config-env"
    command "ConfigEnv.New" "config-env new"
    command "ConfigEnv.Set" "config-env set"
    command "ConfigEnv.Get" "config-env get"
    command "ConfigEnv.Dump" "config-env dump"
    command "ConfigEnv.Switch" "config-env switch"
    command "ConfigEnv.List" "config-env list"
    command "ConfigEnv.Remove" "config-env remove"
    command "ConfigEnv.Reset" "config-env reset"

    group "ConfigWallet" "config-wallet"
    command "ConfigWallet.New" "config-wallet new"
    command "ConfigWallet.List" "config-wallet list"
    command "ConfigWallet.Dump" "config-wallet dump"
    command "ConfigWallet.Get" "config-wallet get"
    command "ConfigWallet.Set" "config-wallet set"
    command "ConfigWallet.Switch" "config-wallet switch"
    command "ConfigWallet.Delete" "config-wallet delete"
    command "ConfigWallet.Remove" "config-wallet remove"
    command "ConfigWallet.Reset" "config-wallet reset"

    group "Get" "get"
    command "Get.Account" "get account"
    command "Get.Storage" "get storage"
    command "Get.StorageEntry" "get storage-entry"
    command "Get.Token" "get token"
    command "Get.Transaction" "get transaction"

    group "Token" "token"
    command "Token.IssueFungbile" "token issue-fungible"
    command "Token.IssueNonFungbile" "token issue-non-fungible"
    command "Token.RegisterMetaEsdt" "token register-meta-esdt"
    command "Token.RegisterAndSetAllRoles" "token register-and-set-all-roles"
    command "Token.SetBurnRoleGlobally" "token set-burn-role-globally"
    command "Token.UnsetBurnRoleGlobally" "token unset-burn-role-globally"
    command "Token.SetSpecialRoleFungible" "token set-special-role-fungible"
    command "Token.UnsetSpecialRoleFungible" "token unset-special-role-fungible"
    command "Token.SetSpecialRoleSemiFungible" "token set-special-role-semi-fungible"
    command "Token.UnsetSpecialRoleSemiFungible" "token unset-special-role-semi-fungible"
    command "Token.SetSpecialRoleMetaEsdt" "token set-special-role-meta-esdt"
    command "Token.UnsetSpecialRoleMetaEsdt" "token unset-special-role-meta-esdt"
    command "Token.SetSpecialRoleNft" "token set-special-role-nft"
    command "Token.UnsetSpecialRoleNft" "token unset-special-role-nft"
    command "Token.CreateNft" "token create-nft"
    command "Token.Pause" "token pause"
    command "Token.Unpause" "token unpause"
    command "Token.Freeze" "token freeze"
    command "Token.Unfreeze" "token unfreeze"
    command "Token.Wipe" "token wipe"
    command "Token.LocalMint" "token local-mint"
    command "Token.LocalBurn" "token local-burn"
    command "Token.UpdateAttributes" "token update-attributes"
    command "Token.AddQuantity" "token add-quantity"
    command "Token.BurnQuantity" "token burn-quantity"
    command "Token.ModifyRolaties" "token modify-royalties"
    command "Token.SetNewUris" "token set-new-uris"
    command "Token.ModifyCreator" "token modify-creator"
    command "Token.UpdateMetadata" "token update-metadata"
    command "Token.NftMetadataRecreate" "token nft-metadata-recreate"
    command "Token.ChangeToDynamic" "token change-to-dynamic"
    command "Token.UpdateTokenId" "token update-token-id"
    command "Token.RegisterDynamic" "token register-dynamic"
    command "Token.RegisterDynamicAndSetAllRoles" "token register-dynamic-and-set-all-roles"
    command "Token.TransferOwnership" "token transfer-ownership"
    command "Token.FreezeSingleNft" "token freeze-single-nft"
    command "Token.UnfreezeSingleNft" "token unfreeze-single-nft"
    command "Token.ChangeSftToMetaEsdt" "token change-sft-to-meta-esdt"
    command "Token.TransferNftCreateRole" "token transfer-nft-create-role"
    command "Token.StopNftCreation" "token stop-nft-creation"
    command "Token.WipeSingleNft" "token wipe-single-nft"
    command "Token.AddUris" "token add-uris"
}

generate