# truffle > Truffle - Simple development framework for Ethereum Latest version **5.11.5** (published 2023-09-13) · MIT license · 0 weekly downloads ## Install ```sh npm install truffle pnpm add truffle yarn add truffle bun add truffle ``` Provides the command `truffle`. ## Health **Score 20/100 (F)** — status: abandoned. Positive: no vulnerabilities; popular repo. Warnings: low downloads; no types; no esm support; large bundle. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 5.11.5 | | Published | 2023-09-13 | | First published | 2015-06-29 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Node | ^16.20 \|\| ^18.16 \|\| >=20 | | Dependencies | 7 | | Unpacked size | 56.5 MB | | Known vulnerabilities | 0 | | Install scripts | yes | | GitHub stars | 13912 | | Author | consensys.net | | Maintainers | cliffoo, jeff.smale, kevinbluer, gnidan, eggplantzzz, fainashalts, haltman, cds-amal, tcoulter | ## Links - npm: https://www.npmjs.com/package/truffle - Repository: https://github.com/trufflesuite/truffle - Homepage: https://github.com/trufflesuite/truffle#readme - Issues: https://github.com/trufflesuite/truffle/issues - npm.io page: https://npm.io/package/truffle ## Dependencies (7) - [mocha](https://npm.io/package/mocha.md) 10.1.0 - [ganache](https://npm.io/package/ganache.md) 7.9.1 - [@truffle/db](https://npm.io/package/@truffle/db.md) ^2.0.36 - [app-module-path](https://npm.io/package/app-module-path.md) ^2.2.0 - [original-require](https://npm.io/package/original-require.md) ^1.0.1 - [@truffle/debugger](https://npm.io/package/@truffle/debugger.md) ^12.1.5 - [@truffle/db-loader](https://npm.io/package/@truffle/db-loader.md) ^0.2.36 ## Recent versions - 5.11.5 (latest) — 2023-09-13 - 5.9.0-visual-debugger.0 (visual-debugger) — 2023-05-12 - 5.5.29-hardhat-error.0 (hardhat-error) — 2022-08-25 - 5.6.0-typescript-migrations.0 (typescript-migrations) — 2022-07-21 - 5.5.19-alpha.2 (signTypedData_v4) — 2022-06-24 - 5.4.32-dashboard.1 (dashboard) — 2022-02-01 - 5.4.14-fc.0 (fc) — 2021-10-04 - 5.4.13-decoder-beta.0 (decoder-beta) — 2021-09-29 - 5.4.10-alpha.1 (eip1559-beta) — 2021-09-13 - 5.3.10-cheerios.1 (cheerios) — 2021-06-10 - 5.3.10-decoder-no-web3.0 (decoder-no-web3) — 2021-06-09 - 5.2.7-preserves.5 (preserves) — 2021-03-31 - 5.1.49-abi-utils.0 (abi-utils) — 2020-10-12 - 5.1.46-alpha.0 (cgewecke) — 2020-09-21 - 5.1.37-save-intermediate.1 (save-intermediate) — 2020-07-31 - … 487 more at https://npm.io/package/truffle/versions ## README [![npm](https://img.shields.io/npm/v/truffle.svg)]() [![npm](https://img.shields.io/npm/dm/truffle.svg)]() [![Join the chat at https://gitter.im/consensys/truffle](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/consensys/truffle?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) ----------------------- 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 ``` _Note: To avoid any strange permissions errors, we recommend using [nvm](https://github.com/nvm-sh/nvm)._ ### 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. Truffle comes bundled with a local development blockchain server that launches automatically when you invoke the commands above. If you'd like to [configure a more advanced development environment](https://trufflesuite.com/docs/truffle/reference/configuration) we recommend you install the blockchain server separately by running `npm install -g ganache` at the command line. + [ganache](https://github.com/trufflesuite/ganache): a command-line version of Truffle's blockchain server. + [Ganache UI](http://trufflesuite.com/ganache-ui/): A GUI for the server that displays your transaction history and chain state. ### Documentation Please see the [Official Truffle Documentation](http://trufflesuite.com/docs/) for guides, tips, and examples. ### Contributing This package is a distribution package of the Truffle command line tool. Please see [@truffle/core](https://github.com/trufflesuite/truffle/tree/develop/packages/core) to contribute to the main core code. ### License [MIT](./LICENSE) --- _Source: https://npm.io/package/truffle · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._