ZeppelinOS Command-Line Interface (zos)

Command-line interface for the 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 is the repository for the ZeppelinOS commmand-line interface, the recommended way to use ZeppelinOS.

Install

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

npm install --global zos

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 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 this and all the other functions of ZeppelinOS.

The ZeppelinOS documentation explains how to use the zos 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 ZeppelinOS JavaScript libraries instead of this zos command.

Security

If you find a security issue, please contact us at [email protected]. We give rewards for reported issues, according to impact and severity.

Maintainers

• @facuspagnuolo
• @spalladino

Contribute

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.

License

MIT © Zeppelin