‣ zkSync CLI

This CLI tool simplifies the process of developing applications and interacting with zkSync.

Documentation | Report a bug | Request a feature

🛠 Prerequisites

• Node.js v18 or higher
• Git
• Docker (for zksync-cli dev commands)
• Yarn (for zksync-cli create commands)

📥 Usage

You can run commands without installation: npx zksync-cli. For example: npx zksync-cli dev start.

💻 Commands

Local development commands

zksync-cli dev - Manage local zkSync development environment. It allows to easily start zkSync stack locally, for example: local Ethereum and zkSync nodes, Block Explorer, Wallet and Bridge.

General:

• zksync-cli dev start - start local development environment (will ask to configure if starting for the first time)
• zksync-cli dev clean - clean data for configured modules
• zksync-cli dev config - select modules to run in local development environment

Modules:

In addition to default modules, you can install custom modules from NPM.

• zksync-cli dev install [module-name] - install module with NPM (e.g. zksync-cli dev i zkcli-dummy-module)
• zksync-cli dev modules - displays list of installed modules

Run zksync-cli dev to see the full list of commands.

Bridge commands

• zksync-cli bridge deposit: deposits funds from Ethereum (L1) to zkSync (L2)
• zksync-cli bridge withdraw: withdraws funds from zkSync (L2) to Ethereum (L1)
• zksync-cli bridge withdraw-finalize: finalizes withdrawal of funds from zkSync (L2) to Ethereum (L1)

Create project commands

• zksync-cli create project {FOLDER_NAME}: creates project from template in the specified folder

Other commands

• zksync-cli help: Provides information about all supported commands
• zksync-cli help <command>: Provides detailed information about how to use a specific command. Replace with the name of the command you want help with (e.g., create, dev config, bridge withdraw-finalize)
• zksync-cli --version: Returns the current version

🔗 Supported bridge chains

By default zkSync CLI bridge commands support Era Testnet and Era Mainnet. You can also use other networks by overwriting L1 and L2 RPC URLs. For example: zksync-cli deposit --l2-rpc=http://... --l1-rpc=http://...

If you're using local setup (dockerized testing node) with default L1 and L2 RPC URLs, you can select Local Dockerized node option in the CLI or provide option --chain local-dockerized.

👩‍💻 Developing new features

Run in development mode

1. Install all dependencies with npm i.
2. To use CLI in development mode run npm run dev -- [command] [options] (eg. npm run dev -- bridge deposit --chain=era-testnet).

Building for production

1. Install all dependencies with npm i.
2. This project was build with Typescript. Run npm run build to compile the code into /bin.
3. You can run your local build with node ./bin

Testing

At the moment, we don't have any tests, but we are working on it. In the meantime, you can test the code manually by running the code in development mode.

🌍 Official Links

• Website
• GitHub
• Twitter
• Twitter for Devs
• Discord

📜 License

This project is licensed under MIT.