README.md

ZeppelinOS Command Line Interface

This package provides a unified command line interface to ZeppelinOS.

ZeppelinOS is a platform to develop, manage and operate smart contract applications in Ethereum. It can be used to create smart contract systems that can be fixed and improved over time, enabling developers to opt-in to mutability for their deployed code through upgradeability patterns. zos also provides an interface to connect your application code to already deployed standard libraries.

If you're looking for a lower-level development experience, see zos-lib.

Table of Contents

• Getting Started
  • Install
  • Basic usage
• Examples
• Links
• Security
• License

Getting Started

Install

To install zos simply run:

npm install --global zos

Basic usage

Before you begin

mkdir myproject && cd myproject
npm init

Setup your project

Initialize your project with ZeppelinOS. The next command will create a new zos.json file:

zos init <name> [version]

Where <name> is your project's name, and [version] an optional initial version name. For example:

zos init my-project 0.1.0

Guides

• Installation and setup
• Building an upgradeable application
• Using the stdlib in your app
• Developing a new standard library
• Testing upgradeable applications
• Extend provided standard library code in your own contracts (experimental)
• Migrate your non-upgradeable legacy ERC20 token into an upgradeable version with a managed approach (experimental)
• Migrate your non-upgradeable legacy ERC20 token into an upgradeable version with an opt-in approach (experimental)

Links

Documentation

• ZeppelinOS
• Documentation site
• ZeppelinOS Blog

Code

• ZeppelinOS CLI (this repository)
• ZeppelinOS library (zos-lib)

Security

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

License

Code released under the MIT License