Truffle project boilerplate utility
Last updated a year ago by boczeratul .
MIT · Original npm · Tarball · package.json
$ cnpm install @dexon-foundation/truffle-box 
SYNC missed versions from official npm registry.


Truffle Box management functionality.

Provides behavior for unboxing a new project from a predefined Truffle Box.

Box Configuration

Truffle Boxes are configured via an optional truffle-box.json file in the box repo's root directory.

This box configuration file specifies an object containing the following properties:

  • ignore

    A list of relative paths to files that should be removed upon box unpack. Useful to remove box READMEs or other artifacts that pertain to box but not the set-up Truffle project.


    "ignore": [
  • commands

    An object mapping supported behaviors for project to invoked command strings.

    truffle unbox prints commands to screen upon unboxing for documentation purposes.


    "commands": {
      "compile": "truffle compile",
      "migrate": "truffle migrate",
      "test": "truffle test"
  • hooks

    An object to specify commands to run at particular steps in the unbox process. Maps strings identifying individual hooks to command strings.


    "hooks": {
      "post-unpack": "npm install"

Available Unbox Hooks

  • post-unpack

    If provided, runs command after box files are fetched and cleaned up for a new project.

    Commonly useful to install dependencies, e.g.

Current Tags

  • 1.0.19                                ...           latest (a year ago)

6 Versions

  • 1.0.19                                ...           a year ago
  • 1.0.18                                ...           a year ago
  • 1.0.17                                ...           a year ago
  • 1.0.16                                ...           a year ago
  • 1.0.12                                ...           a year ago
  • 1.0.8                                ...           a year ago
Today 0
This Week 0
This Month 6
Last Day 0
Last Week 6
Last Month 4
Dependencies (6)
Dev Dependencies (4)

Copyright 2014 - 2016 © taobao.org |