You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+19-16
Original file line number
Diff line number
Diff line change
@@ -26,39 +26,42 @@ You can run commands without installation: `npx zksync-cli`. For example: `npx z
26
26
## 💻 Commands
27
27
28
28
### Local development commands
29
-
`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.
29
+
`npx 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.
30
30
31
31
**General:**
32
-
-`zksync-cli dev start` - start local development environment (will ask to configure if starting for the first time)
33
-
-`zksync-cli dev clean` - clean data for configured modules
34
-
-`zksync-cli dev config` - select modules to run in local development environment
32
+
-`npx zksync-cli dev start` - start local development environment (will ask to configure if starting for the first time)
33
+
-`npx zksync-cli dev clean` - clean data for configured modules
34
+
-`npx zksync-cli dev config` - select modules to run in local development environment
35
35
36
36
**Modules:**
37
37
38
38
In addition to default modules, you can install custom modules from NPM.
39
39
40
-
-`zksync-cli dev install [module-name]` - install module with NPM (e.g. `zksync-cli dev i zkcli-dummy-module`)
41
-
-`zksync-cli dev modules` - displays list of installed modules
40
+
-`npx zksync-cli dev install [module-name]` - install module with NPM (e.g. `npx zksync-cli dev i zkcli-dummy-module`)
41
+
-`npx zksync-cli dev modules` - displays list of installed modules
42
42
43
-
Run `zksync-cli dev` to see the full list of commands.
43
+
Run `npx zksync-cli dev` to see the full list of commands.
44
44
45
45
### Bridge commands
46
-
-`zksync-cli bridge deposit`: deposits funds from Ethereum (L1) to zkSync (L2)
47
-
-`zksync-cli bridge withdraw`: withdraws funds from zkSync (L2) to Ethereum (L1)
48
-
-`zksync-cli bridge withdraw-finalize`: finalizes withdrawal of funds from zkSync (L2) to Ethereum (L1)
46
+
-`npx zksync-cli bridge deposit`: deposits funds from Ethereum (L1) to zkSync (L2)
47
+
-`npx zksync-cli bridge withdraw`: withdraws funds from zkSync (L2) to Ethereum (L1)
48
+
-`npx zksync-cli bridge withdraw-finalize`: finalizes withdrawal of funds from zkSync (L2) to Ethereum (L1)
49
49
50
-
### Create project commands
51
-
-`zksync-cli create project {FOLDER_NAME}`: creates project from template in the specified folder
50
+
### Create Project commands
51
+
-`npx zksync-cli create`: Create a project using updated templates.
52
+
-**Frontend**: Rapid UI development with templates for Vue, React, Next.js, Nuxt, Vite, etc. Options include viem, ethers, web3modal, rainbowkit. [More Info](https://github.com/matter-labs/zksync-frontend-templates#readme)
53
+
-**Contracts**: Quick contract deployment and testing with Hardhat + Solidity or Hardhat + Vyper. [Solidity Template](https://github.com/matter-labs/zksync-hardhat-template#readme), [Vyper Template](https://github.com/matter-labs/zksync-hardhat-vyper-template#readme)
54
+
-**Scripting**: Automated interactions and advanced zkSync operations using Node.js, with examples of wallet or contract interactions using viem or ethers. [Scripting Templates](https://github.com/matter-labs/zksync-scripting-templates#readme)
52
55
53
56
### Other commands
54
-
-`zksync-cli help`: Provides information about all supported commands
55
-
-`zksync-cli help <command>`: Provides detailed information about how to use a specific command. Replace <command> with the name of the command you want help with (e.g., `create`, `dev config`, `bridge withdraw-finalize`)
56
-
-`zksync-cli --version`: Returns the current version
57
+
-`npx zksync-cli help`: Provides information about all supported commands
58
+
-`npx zksync-cli help <command>`: Provides detailed information about how to use a specific command. Replace <command> with the name of the command you want help with (e.g., `create`, `dev config`, `bridge withdraw-finalize`)
59
+
-`npx zksync-cli --version`: Returns the current version
57
60
58
61
59
62
### 🔗 Supported bridge chains
60
63
61
-
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://...`
64
+
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: `npx zksync-cli deposit --l2-rpc=http://... --l1-rpc=http://...`
62
65
63
66
If you're using [local setup (dockerized testing node)](https://github.com/matter-labs/local-setup) with default L1 and L2 RPC URLs, you can select `Local Dockerized node` option in the CLI or provide option `--chain local-dockerized`.
0 commit comments