OpenViSTAI · Agents · Blockchain · Crypto
Submit a project
Menu
Developer Tools

Zksync CLI

Zksync CLI is a TypeScript command-line tool for developing applications for and interacting with the ZKsync ecosystem. It provides project templates, local development environment management, and commands for contract interaction, transaction details, wallet tasks and bridging.

Explore the practical guide ↓

Independent OpenViST project profile, based on linked sources.

Zksync CLI — OpenViST project profile in Developer Tools.
OpenViST project illustration. See the linked sources for product details.
Understand the project

Practical overview

When it fits

Use it when a ZKsync development or interaction task fits its documented command groups, especially project scaffolding, local setup, contract operations, wallet tasks or bridging.

Who it is for

  • Developers creating frontend, smart-contract or scripting projects for ZKsync.
  • Developers who want command-line access to contract, wallet, transaction or bridge operations.
  • Teams setting up the CLI's local ZKsync development environment.

Documented uses

  • Generate a frontend, contract or scripting project from a template.
  • Start, configure or clean a local development environment.
  • Read from or write to contracts and encode contract calldata.
  • Inspect transaction information, check a token balance or transfer L2 funds.
  • Deposit from Ethereum to ZKsync, withdraw to Ethereum, or finalize a withdrawal.
Before you choose

Requirements & limits

The README shows commands run through npx without installing the CLI separately. Node.js v18 or higher and Git are listed prerequisites; Docker is additionally required for dev commands.

  • Bridge commands support ZKsync Sepolia Testnet and ZKsync Mainnet by default.
  • Custom chains can be added or used with L1 and L2 RPC URLs, but the README warns that custom ZK Chains may currently have interaction issues.
  • Local development can include nodes, a block explorer, wallet and bridge, with modules selected through CLI configuration.
  • The repository lists TypeScript as its primary language and MIT as its license.

Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.

Source-based practical guide

Start a local ZKsync development environment

Use the CLI to start and configure its local development environment.

Before you start

  • Node.js v18 or higher
  • Git
  • Docker for the CLI's dev commands

Steps

  1. Run the command below.

    Documented command
    npx zksync-cli dev start

  2. Respond to the first-run configuration prompt if it appears.

  3. Use the command below to select which modules to run.

    Documented command
    npx zksync-cli dev config

Expected outcome

A configured local development environment that can include local Ethereum and ZKsync nodes, a block explorer, wallet and bridge.

Guide limitations

  • Docker is required for dev commands.
Documentation 1 ↗
Source-based practical guide

Create a ZKsync project from a template

Generate a frontend, contract or scripting project using the CLI's templates.

Before you start

  • Node.js v18 or higher
  • Git

Steps

  1. Run the command below.

    Documented command
    npx zksync-cli create

  2. Choose a project type: frontend, contracts or scripting.

  3. Use the available template options for the selected type.

Expected outcome

A project scaffold based on a CLI template; options include frontend frameworks, Solidity or Vyper contract templates, and Node.js scripting examples.

Documentation 1 ↗
Evidence and transparency

Sources & review

Official repository ↗
Source record details
Source availability
Active
Sources checked
12 October 2026
Original website title
matter-labs/zksync-cli · Official homepage title · retained in its source language
How we review sourcesSuggest a correction