OpenZeppelin SDK Command-Line Interface (@openzeppelin/cli)
Command-line interface for the OpenZeppelin smart contract platform.
OpenZeppelin SDK is a platform to develop, deploy and operate smart contract projects on Ethereum and every other EVM and eWASM-powered blockchain.
This is the repository for the OpenZeppelin commmand-line interface, the recommended way to use the OpenZeppelin SDK.
Install
First, install Node.js and npm. Then, install the OpenZeppelin SDK running:
npm install --global @openzeppelin/cliUsage
To start, create a directory for the project and access it:
mkdir my-project
cd my-projectUse npm to create a package.json file:
npm initAnd initialize the OpenZeppelin SDK project:
openzeppelin init my-projectNow it is possible to add contracts to the project with the openzeppelin add command,
push these contracts to a blockchain network with openzeppelin push, use
openzeppelin deploy to create instances for these contracts that later can be
upgraded, and many more things.
Run openzeppelin --help for more details about this and all the other functions of
the OpenZeppelin CLI.
The
OpenZeppelin SDK documentation
explains how to use the openzeppelin command-line interface to build a project, to
upgrade contracts and to share packages for other projects to reuse. It also
explains how to operate the project with the OpenZeppelin JavaScript libraries
instead of this openzeppelin command.
Security
If you find a security issue, please contact us at security@openzeppelin.com. We give rewards for reported issues, according to impact and severity.
Maintainers
Contribute
To contribute, join our community channel on Telegram where you can talk to all the OpenZeppelin developers, contributors, partners and users.
You can also follow the recent developments of the project in our blog and Twitter account.
License
MIT © OpenZeppelin