Skip to content

Commit c303548

Browse files
authored
feat: improve templating (#76)
1 parent 2249e3c commit c303548

16 files changed

+1073
-173
lines changed

README.md

+19-16
Original file line numberDiff line numberDiff line change
@@ -26,39 +26,42 @@ You can run commands without installation: `npx zksync-cli`. For example: `npx z
2626
## 💻 Commands
2727

2828
### 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.
3030

3131
**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
3535

3636
**Modules:**
3737

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

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
4242

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.
4444

4545
### 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)
4949

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)
5255

5356
### 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
5760

5861

5962
### 🔗 Supported bridge chains
6063

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://...`
6265

6366
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`.
6467

0 commit comments

Comments
 (0)