ZeppelinOS multi-package repository
Branch: master
Clone or download
frangio and mergify Fix link to ProxyAdmin in docs (#699)
* fix link to ProxyAdmin in docs

* Fix link to ProxyAdmin in versioned docs
Latest commit 75483ee Feb 16, 2019


ZeppelinOS (zos)

standard-readme compliant Build Status lerna

ZeppelinOS smart contract platform.

ZeppelinOS is a platform to develop, deploy and operate smart contract projects on Ethereum and every other EVM and eWASM-powered blockchain.

This repository includes the ZeppelinOS Command-Line Interface, JavaScript Library, and the sources for the Documentation Website.


First, install Node.js and npm. Then, install ZeppelinOS running:

npm install --global zos


We recommend to use ZeppelinOS through the zos command-line interface.

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 ZeppelinOS project:

zos init my-project

Now it is possible to add contracts to the project with the zos add command, push these contracts to a blockchain network with zos push, use zos create to create instances for these contracts that later can be upgraded, and many more things.

Run zos --help for more details about thes and all the other functions of ZeppelinOS.

The ZeppelinOS documentation explains how to build a project using our platform, how to upgrade contracts, how to share packages for other projects to reuse, how to vouch for the quality of a package, how to use the JavaScript libraries to operate the project, and it explains details of the platform and some advanced topics.


If you find a security issue, please contact us at security@zeppelinos.org. We give rewards for reported issues, according to impact and severity.



To contribute, join our community channel on Telegram where you can talk to all the ZeppelinOS developers, contributors, partners and users.

You can also follow the recent developments of the project in our blog and Twitter account.


MIT © Zeppelin