Skip to content
Branch: master
Find file History
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
contracts/mocks Rename ZeppelinOS/zos references, ZosConfig object and cli/lib packag… Jul 12, 2019
docs Merge docs setup updates (#1154) Jul 24, 2019
migrations Merge branch 'feature/contracts-models' into bootstrap Jul 31, 2018
mocks Change some zosversion to manifestVersion Jun 26, 2019
scripts Merge docs setup updates (#1154) Jul 24, 2019
solc Compile command (#914) Jun 5, 2019
src
test Update contribution guide (#1225) Sep 13, 2019
.eslintignore Feature/add tests prettier (#1233) Sep 12, 2019
.eslintrc.js New documentation setup (#1118) Jul 18, 2019
.gitattributes Add solidity syntax highlighting Jul 31, 2018
.gitignore Rename Project, Network, Sesion and Lock files (#1040) Jun 27, 2019
.prettierrc.js Add ESLint and Prettier configs; Apply linting; (#920) May 31, 2019
AUTHORS Update AUTHORS (#1167) Jul 30, 2019
LICENSE
README.md Rename ZeppelinOS/zos references, ZosConfig object and cli/lib packag… Jul 12, 2019
changelog.md Update changelogs Aug 18, 2019
package-lock.json Bump web3 version (#1192) Aug 16, 2019
package.json v2.5.3 Aug 18, 2019
truffle.js Fix CI if only is present on tests (#807) Apr 9, 2019
tsconfig.docs.json New documentation setup (#1118) Jul 18, 2019
tsconfig.json Add ZosConfig file (networks.js) (#918) Jun 4, 2019
tsconfig.test.json Wraps up the porting of cli, phases 1 and 2 (#532) Dec 21, 2018

README.md

OpenZeppelin SDK Command-Line Interface (@openzeppelin/cli)

standard-readme compliant NPM Package CircleCI

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/cli

Usage

To start, create a directory for the project and access it:

mkdir my-project
cd my-project

Use npm to create a package.json file:

npm init

And initialize the OpenZeppelin SDK project:

openzeppelin init my-project

Now 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 create 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

You can’t perform that action at this time.