Getting Started with zkSync CLI
Getting Started with zkSync CLI
Welcome to the zkSync CLI documentation! The zkSync Command Line Interface (CLI) is a powerful tool designed to simplify the development and interaction with zkSync. It provides developers with an easy-to-use set of commands to manage local development environment, interact with contracts, manage tokens, and much more.
📥 Usage
You can run commands without installation: npx zksync-cli
. For example: npx zksync-cli dev start
.
Available Commands
- Start Local Node: Start a local development environment with zkSync and Ethereum nodes.
- Project Creation: Scaffold new projects using templates for frontend, contracts, and scripting.
- Contract Interactions: Read and write data to zkSync contracts without building UI.
- Transaction Information: Fetch and display detailed information about a specific transaction.
- Wallet Operations: Manage zkSync wallet assets, including transfers and balance checks.
- Bridge Operations: Perform deposits and withdrawals between Ethereum and zkSync.
- Custom Chains: Add or edit custom chains for flexible testing and development.
Troubleshooting
Encountering issues? Our Troubleshooting guide covers common problems and their solutions, helping you resolve any hiccups quickly.
Further Assistance
Need more help? Join our GitHub Discussions to ask questions, share your experiences, and connect with the zkSync community.
Thank you for choosing zkSync CLI for your development journey. We're excited to support your projects and innovations on the zkSync platform.
Source Code
The zkSync CLI is open-source and available on GitHub under MIT License. Feel free to contribute, report issues, or suggest new features to help us improve the tool for everyone.