mud deploy

mud deploy

This command deploys a MUD app to a blockchain.

Using the command

Before you run mud deploy you need to specify the private key of the deploying account. There are several ways to do this:

  • Export an environment variable.

    export PRIVATE_KEY=0x<key goes here>
  • Edit .env to specify the PRIVATE_KEY value.

    # This .env file is for demonstration purposes only.
    # This should usually be excluded via .gitignore and the env vars attached to
    # your deployment environment, but we're including this here for ease of local
    # development. Please do not commit changes to this file!
    # Anvil default private key:

You also need to specify a URL to the blockchain. Again, there are several ways to do this:

These are the command line options you can specify on mud deploy:

OptionMeaningTypeDefault value
--configPathPath to the config filestringmud.config.ts
--printConfigPrint the resolved configbooleanfalse
--saveDeploymentSave the deployment info to a filebooleantrue
--profileThe foundry profile to usestringlocal
--rpc1The RPC URL to usestringRPC url from foundry.toml
--rpcBatchEnable batch processing of RPC requestsbooleanfalse
--worldAddressDeploy to an existing World at the given addressstringEmpty, deploy new World
--srcDirSource directorystringFoundry src directory
--skipBuildSkip rebuilding the contracts before deployingbooleanfalse
--alwaysRunPostDeployRun PostDeploy.s.sol after each deploybooleanfalse (run the script only when deploying a new World)
--helpShow helpbooleanfalse
--versionShow version numberbooleanfalse

(1) The hostname localhost may not work. If that is the case, use instead.


If you want to verify the contracts that make up the World, do it right after deployment. Verification only works with the original source code, compiler options, and compiled artifacts. Otherwise, the generated bytecode is different and therefore verification fails.


New World

To create a new World you can use this command line:

pnpm mud deploy --rpc <url>

This command also writes the World's address to worlds.json.

Upgrading a World

To upgrade a World's Systems and tables, you can use this command line:

pnpm mud deploy --rpc <url> --worldAddress <address>

If properly configured, there is also a way to upgrade the core MUD contracts.


To generate debug messages, use this command:

export DEBUG=mud:cli:deploy