This repository has been archived by the owner. It is now read-only.
Core code for Truffle command line tool
Clone or download
Pull request Compare This branch is 5 commits behind develop.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
assets
docs
lib
test
.gitignore
.travis.yml
ISSUE_TEMPLATE.md
LICENSE
README.md
appveyor.yml
chain.js
cli.js
exec.js
index.js
mkdocs.yml
nil.js
package.json

README.md

npm npm Build Status Join the chat at https://gitter.im/consensys/truffle


Truffle is a development environment, testing framework and asset pipeline for Ethereum, aiming to make life as an Ethereum developer easier. With Truffle, you get:

  • Built-in smart contract compilation, linking, deployment and binary management.
  • Automated contract testing with Mocha and Chai.
  • Configurable build pipeline with support for custom build processes.
  • Scriptable deployment & migrations framework.
  • Network management for deploying to many public & private networks.
  • Interactive console for direct contract communication.
  • Instant rebuilding of assets during development.
  • External script runner that executes scripts within a Truffle environment.

Install

$ npm install -g truffle

Quick Usage

For a default set of contracts and tests, run the following within an empty project directory:

$ truffle init

From there, you can run truffle compile, truffle migrate and truffle test to compile your contracts, deploy those contracts to the network, and run their associated unit tests.

See the documentation for more details.

Documentation

Please see the Official Truffle Documentation for guides, tips, and examples.

Contributing

There are many ways to contribute!

  1. Write issues in the issues tracker. Please include as much information as possible!
  2. Take a look at our Waffle for prioritization. Note that this includes issues for Truffle and related tools.
  3. Contact us in our gitter chat!

Please see the main projects CONTRIBUTING.md for instructions on how to setup a Development Environment to work on Truffle itself.

Contributors

A project by Consensys and @tcoulter, and many contributers.

License

MIT