Publishes the Modules in a Move Package to the Aptos Blockchain


movement aptos move publish [OPTIONS]


  • --override-size-check Whether to override the check for maximal size of published data.

  • --included-artifacts <INCLUDED_ARTIFACTS> Artifacts to be generated when building the package. Which artifacts to include in the package. This can be one of none, sparse, and all. none is the most compact form and does not allow to reconstruct a source package from chain; sparse is the minimal set of artifacts needed to reconstruct a source package; all includes all available artifacts. The choice of included artifacts heavily influences the size and therefore gas cost of publishing. [default: sparse] [possible values: none, sparse, all]

  • --dev Enables dev mode, which uses all dev-addresses and dev-dependencies. Dev mode allows for changing dependencies and addresses to the preset [dev-addresses] and [dev-dependencies] fields. Currently, it also additionally pulls in all test compilation artifacts.

  • --package-dir <PACKAGE_DIR> Path to a move package (the folder with a Move.toml file).

  • --output-dir <OUTPUT_DIR> Path to save the compiled move package. Defaults to <package_dir>/build.

  • --named-addresses <NAMED_ADDRESSES> Named addresses for the move binary. Example: alice=0x1234, bob=0x5678. [default: ]

  • --skip-fetch-latest-git-deps Skip pulling the latest git dependencies. This will allow overriding this for local development.

  • --bytecode-version <BYTECODE_VERSION> Specify the version of the bytecode the compiler is going to emit.

  • --sender-account <SENDER_ACCOUNT> Sender account address. This allows you to override the account address from the derived account address in the event that the authentication key was rotated or for a resource account.

  • --private-key-file <PRIVATE_KEY_FILE> Signing Ed25519 private key file path. Encoded with type from --encoding. Mutually exclusive with --private-key.

  • --private-key <PRIVATE_KEY> Signing Ed25519 private key. Encoded with type from --encoding. Mutually exclusive with --private-key-file.

  • --encoding <ENCODING> Encoding of data as one of [base64, bcs, hex]. [default: hex] Possible values:

    • bcs: Binary Canonical Serialization

    • hex: Hex encoded e.g. 0xABCDE12345

    • base64: Base 64 encoded

  • --profile <PROFILE> Profile to use from the CLI config. This will be used to override associated settings such as the REST URL, the Faucet URL, and the private key arguments. Defaults to "default".

  • --url <URL> URL to a fullnode on the network. Defaults to the URL in the `default’ profile.

  • --connection-timeout-secs <CONNECTION_TIMEOUT_SECS> Connection timeout in seconds, used for the REST endpoint of the fullnode. [default: 30]

  • --gas-unit-price <GAS_UNIT_PRICE> Gas multiplier per unit of gas. The amount of Octas (10^-8 APT) used for a transaction is equal to (gas unit price * gas used). Without a value, it will determine the price based on the current estimated price.

  • --max-gas <MAX_GAS> Maximum amount of gas units to be used to send this transaction. For example, if I wanted to pay a maximum of 100 Octas, I may have the max gas set to 100 if the gas unit price is 1. Without a value, it will determine the price based on simulating the current transaction.

  • --expiration-secs <EXPIRATION_SECS> Number of seconds to expire the transaction. [default: 30]

  • --assume-yes Assume yes for all yes/no prompts.

  • --assume-no Assume no for all yes/no prompts.

  • --profile-gas If this option is set, simulate the transaction locally using the debugger and generate flamegraphs that reflect the gas usage.

Last updated