colony-cli

The colony-cli package is a command line tool for building colonyStarter packages and running services such as Ganache, Truffle, and Trufflepig to assist with local development alongside the colonyNetwork smart contracts.

Prerequisites

  • Node >=10.13.0
  • Yarn >=1.12.0
  • Docker >=18.09.0

You may find it helpful to use Node Version Manager (nvm) to manage Node versions.

If you are using Linux, check out Linux Setup to ensure Yarn and Docker are set up accordingly.

Install

Install the colony-cli package globally:

yarn global add @colony/colony-cli

Commands

build

Build colonyStarter packages:

colony build [package-name]

service

Start a local test network with Ganache:

colony service start-ganache

Start a local test network with Ganache using --noVMErrorsOnRPCResponse:

colony service start-ganache --noVMErrorsOnRPCResponse

Deploy the colonyNetwork smart contracts:

colony service deploy-contracts

Deploy a specific version of the colonyNetwork smart contracts:

colony service deploy-contracts --specific glider

Serve truffle contract data with TrufflePig:

colony service start-trufflepig

Seed the network with global skills:

colony service seed-network

Create a test colony:

colony service colony-setup

Run Truffle commands:

colony service truffle [develop/compile/migrate/test]

Support

Questions? Problems? Existential dilemmas? We’re here to help!

Improve this doc.

All improvements to documentation are welcome and encouraged. Submit a PR for documentation on GitHub.