| 1 | 
|
| 2 | [](https://www.npmjs.org/package/@nomiclabs/buidler)
|
| 3 | 
|
| 4 | ---------
|
| 5 | Buidler is a task runner for Ethereum smart contract developers. It facilitates performing frequent tasks, such as running tests, automatically checking code for mistakes or interacting with a smart contract. Check out the [plugin list](https://buidler.dev/plugins/) to use it with your existing tools.
|
| 6 |
|
| 7 | Developed by [Nomic Labs](https://nomiclabs.io/) and funded by an Ethereum Foundation grant.
|
| 8 |
|
| 9 | Join our [Buidler Telegram group](http://t.me/BuidlerSupport) to stay up to date on new releases, plugins and tutorials.
|
| 10 |
|
| 11 | ## Installation
|
| 12 |
|
| 13 | ### Local installation (recommended)
|
| 14 |
|
| 15 | The recommended way of using Buidler is through a local installation in your project. This way your environment will be reproducible and you will avoid future version conflicts. To use it in this way you will need to prepend `npx` to run it (i.e. `npx buidler`). To install locally initialize your `npm` project using `npm init` and follow the instructions. Once ready run:
|
| 16 |
|
| 17 | npm install --save-dev @nomiclabs/buidler
|
| 18 |
|
| 19 | ### Global installation
|
| 20 |
|
| 21 | Be careful about inconsistent behavior across different projects that use different Buidler versions.
|
| 22 |
|
| 23 | npm install --global @nomiclabs/buidler
|
| 24 |
|
| 25 | If you choose to install Buidler globally, you have to do the same for its plugins and their dependencies.
|
| 26 |
|
| 27 | ## Documentation
|
| 28 |
|
| 29 | On [Buidler's website](https://buidler.dev) you will find:
|
| 30 |
|
| 31 | - [Guides to get started](https://buidler.dev/getting-started/)
|
| 32 | - [Buidler EVM](https://buidler.dev/buidler-evm/)
|
| 33 | - [Plugin list](https://buidler.dev/plugins/)
|
| 34 | - [API docs](https://buidler.dev/api/)
|
| 35 |
|
| 36 |
|
| 37 | ## Contributing
|
| 38 |
|
| 39 | Contributions are always welcome! Feel free to open any issue or send a pull request.
|
| 40 |
|
| 41 | Go to [CONTRIBUTING.md](./CONTRIBUTING.md) to learn about how to set up Buidler's development environment.
|
| 42 |
|
| 43 | ## Feedback, help and news
|
| 44 |
|
| 45 | [Buidler Support Telegram group](http://t.me/BuidlerSupport): for questions and feedback.
|
| 46 |
|
| 47 | [Follow Nomic Labs on Twitter.](https://twitter.com/nomiclabs)
|
| 48 |
|
| 49 |
|
| 50 | ## Happy buidling!
|
| 51 |
|
| 52 | 👷♀️👷♂️👷♀️👷♂️👷♀️👷♂️👷♀️👷♂️👷♀️👷♂️👷♀️👷♂️👷♀️👷♂️
|