zksync-cli dev - ZKsync Docs

Prerequisites

You will need Docker to setup ZKsync nodes on your local machine. Download and install Docker which will install the necessary tools for the dev command to work.

Once installed, ensure that the Docker program is running on your machine, otherwise the dev command may error. Check to make sure that the Docker Desktop is running anytime you restart your machine.

zksync-cli dev [sub-command] [options]

`config`

zksync-cli dev config [options]

An interactive command to select the default modules to run in local development environment.

`start`

zksync-cli dev start [options]

Start local ZKsync CLI dev modules.

`stop`

zksync-cli dev stop [options]

Stop currently running local ZKsync CLI dev modules.

`restart`

zksync-cli dev restart [module] [options]

Restart running local ZKsync CLI dev modules. Pass a module name to restart only that module.

`logs`

zksync-cli dev logs [module] [options]

Displays truncated list of logs for configured ZKsync CLI dev modules.

`clean`

zksync-cli dev clean [module] [options]

Removes data for all configured ZKsync CLI dev modules.

`install`

zksync-cli dev install [module] [options]
zksync-cli dev i [module] [options]

Install a ZKsync CLI dev module with NPM.

--link

boolean

Use 'npm link' instead of 'npm install' (useful during module development).

`update`

zksync-cli dev update [module] [options]

Update a ZKsync CLI dev module version.

--force

boolean

Force upddate the module (skip version check).

--package

boolean

Update the NPM package instead of module.

`uninstall`

zksync-cli dev uninstall [module] [options]

--unlink

boolean

Use 'npm unlink' instead of 'npm uninstall' (useful during module development).

`modules`

zksync-cli dev modules [module] [options]

Lists currently installed ZKsync CLI dev modules.

zksync-cli create

ZKsync CLI create command reference

zksync-cli transaction

Interact with transaction information using zksync-cli.