![](https://user-images.githubusercontent.com/232174/75543992-f1c39e00-5a1a-11ea-8fd4-8933638b5910.png)
[![NPM Package](https://img.shields.io/npm/v/@nomiclabs/buidler.svg?style=flat-square)](https://www.npmjs.org/package/@nomiclabs/buidler)
![Build Status](https://github.com/nomiclabs/buidler/workflows/CI/badge.svg)
---------
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.

Developed by [Nomic Labs](https://nomiclabs.io/) and funded by an Ethereum Foundation grant.

Join our [Buidler Telegram group](http://t.me/BuidlerSupport) to stay up to date on new releases, plugins and tutorials.

🚧 **For the most recently published code, look at the [`master`](https://github.com/nomiclabs/buidler/tree/master) branch** 🚧

## Installation

### Local installation (recommended)

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:

    npm install --save-dev @nomiclabs/buidler

### Global installation

Be careful about inconsistent behavior across different projects that use different Buidler versions.

    npm install --global @nomiclabs/buidler
    
If you choose to install Buidler globally, you have to do the same for its plugins and their dependencies.

## Documentation

On [Buidler's website](https://buidler.dev) you will find:

- [Guides to get started](https://buidler.dev/getting-started/)
- [Buidler EVM](https://buidler.dev/buidler-evm/)
- [Plugin list](https://buidler.dev/plugins/)
- [API docs](https://buidler.dev/api/)


## Contributing

Contributions are always welcome! Feel free to open any issue or send a pull request.

Go to [CONTRIBUTING.md](./CONTRIBUTING.md) to learn about how to set up Buidler's development environment. 

## Feedback, help and news

[Buidler Support Telegram group](http://t.me/BuidlerSupport): for questions and feedback.

[Follow Nomic Labs on Twitter.](https://twitter.com/nomiclabs)


## Happy buidling!

👷‍♀️👷‍♂️👷‍♀️👷‍♂️👷‍♀️👷‍♂️👷‍♀️👷‍♂️👷‍♀️👷‍♂️👷‍♀️👷‍♂️👷‍♀️👷‍♂️