Skip to content
Get packs

Truffle

Ethereum smart contract development toolkit; archived and being sunset by Consensys.

GitHub Download v5.11.5
Stars
13.9k
Forks
2.3k
Licence
MIT
Language
TypeScript
Last update
2.5 years ago
Type
Dev tool

This repository is archived and no longer maintained.

What it is

Truffle is a development environment, testing framework, and asset pipeline for Ethereum smart contracts. It handles compiling, deploying, and testing contracts, and includes a local blockchain server and an interactive console. The repository is archived and the project is being sunset, so the README directs users to Consensys's blog for migration options.

  • Compile Solidity contracts with truffle compile
  • Deploy contracts with a scriptable migrations framework using truffle migrate
  • Run automated contract tests with Mocha and Chai using truffle test
  • Interact with deployed contracts through the built-in console

Great for

  • Developers maintaining existing Truffle-based Ethereum projects
  • Teams studying how Truffle's compile, migrate, and test workflow was built
  • Developers who need to read or fork the MIT-licensed code

Not ideal for

  • New projects: the README says the suite is being sunset, and the repository is archived, so it will not receive updates there
  • Non-developers, since it requires working knowledge of Ethereum and smart contracts

How to get it

  1. 1

    Install with a package manager

    You'll need: Node.js (version not specified in README) · npm

    Install Truffle globally

    npm install -g truffle
  2. 2

    Run it

    • Run npm install -g truffle
    • Create an empty project directory and run truffle init
    • Run truffle compile, truffle migrate, or truffle test
  3. 3

    Get the most out of it

    • Install Ganache separately with npm install -g ganache for a more advanced local development environment
    • Use the configuration reference in the official docs to customize networks and settings
    • Read the Consensys blog post on the sunset to plan a migration

Downloads

Source code (.zip)develop branch · straight from GitHubRelease v5.11.5Release notes and sourceOfficial website & docsconsensys.io/blog/consensys-announces-the-sunset-of-truffle-and-ganache-and-new-hardhat?utm_source=github&utm_medium=referral&utm_campaign=2023_Sep_truffle-sunset-2023_announcement_

Strengths

  • Bundles compilation, deployment, testing, and a local blockchain server in one tool
  • Supports network management for many public and private networks
  • Released under the permissive MIT license

Trade-offs

  • Archived and being sunset, so it is no longer maintained in this repository
  • The README does not describe the state of ongoing support beyond pointing to the Consensys blog

How it compares

ProjectStarsTypeLevelUpdatedBest for
truffle (this)13.9kDev toolintermediate2.5 years agoDevelopers maintaining existing Truffle-based Ethereum projects
full-blockchain-solidity-course-py11.2kLearning resourcebeginner2.6 years agoBeginners who want a structured path into Solidity and smart contracts
openzeppelin-contracts27.3kLibraryintermediate4 days agoDevelopers writing Solidity smart contracts who need standard tokens or permission systems
sismo-badges15.9kLibraryadvanced3.1 years agoDevelopers building or auditing Ethereum contracts for the Sismo attestation system
shardeum31.2kOtheradvanced1.1 years agoDevelopers building or testing EVM-compatible decentralized apps who want a local test network
ccxt44.7kLibraryintermediate4 days agoDevelopers building trading bots or algorithmic trading software

Stats synced from GitHub. The assessment above was drafted with AI from the project's README on 2026-10-29 and may miss recent changes — check the README before relying on a command. MIT licence: free to use, modify and distribute, including commercially, as long as you keep the copyright notice.