maraoz / zos-cli

ZeppelinOS command line interface

ZeppelinOS Command Line Interface

⚠️ Under heavy development: do not use in production ⚠️

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 from the zOS Kernel. If you wish a lower-level development experience, see zos-lib.

Table of Contents

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

Getting Started

Install

To install zos simply run:

npm install --global zos

Basic usage

Before you begin

zos integrates with Truffle, an Ethereum development environment. Please install Truffle and initialize your project with it:

npm install --global truffle
mkdir myproject && cd myproject
truffle init

Setup your project

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

zos init <name> <version>

For example:

zos init myproject 0.1

Examples

• Develop an upgradeable smart contract application using zos
• Testing a zos upgradeable application
• Develop a new zOS Kernel standard library release using zos
• Use zos to fund development and auditing of zOS Kernel releases with your ZEP tokens
• Extend provided zOS Kernel 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
• ZeppelinOS Blog
• Proxy Patterns

Code

• ZeppelinOS library (zos-lib)
• ZeppelinOS kernel

License

Code released under the MIT License