This package has been deprecated

    Author message:

    ZeppelinOS/OpenZeppelin CLI is no longer being developed. For smart contract upgrades check out the OpenZeppelin Upgrades Plugins.

    TypeScript icon, indicating that this package has built-in type declarations

    2.4.3 • Public • Published

    ZeppelinOS Command-Line Interface (zos)

    standard-readme compliant NPM Package Build Status

    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.


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

    npm install --global zos


    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.


    If you find a security issue, please contact us at 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


    npm i zos

    DownloadsWeekly Downloads






    Unpacked Size

    658 kB

    Total Files


    Last publish


    • ajsantander
    • facuspagnuolo
    • frangio
    • maraoz
    • martriay
    • spalladino