

This page explains how to install and use the Chainlink Library in your projects.
If you're new to smart contract development and want a step-by-step guide, try out our Beginner Walkthrough
Install into Existing Projects
If you already have a project, you can add Chainlink to it by using the following package managers.
NPM
Install using NPM
npm install @chainlink/contracts --save
Yarn
Install using Yarn
yarn add @chainlink/contracts
Create a New Project
If you're creating a new project from scratch, these commands will help you set up your project to interact with Chainlink.
Truffle Box
Install Truffle with NPM:
npm install truffle -g
With Truffle installed, run the commands below to unbox a Chainlink contract into a new directory.
mkdir MyChainlinkProject
cd MyChainlinkProject/
truffle unbox smartcontractkit/box
For more details on how to use the Truffle, see this blog post.
Brownie Mix
Install Brownie with pip:
pip install eth-brownie
With Brownie installed, run the commands below to open a Brownie project into a new directory.
mkdir MyChainlinkProject
cd MyChainlinkProject/
brownie bake chainlink-mix
cd chainlink-mix
Set your WEB3_INFURA_PROJECT_ID
, and PRIVATE_KEY
environment variables. You can get this from Infura. You can find your PRIVATE_KEY
from your Ethereum wallet like Metamask.
Using Chainlink Contracts
Once you have the Chainlink library installed, you can leverage the Chainlink ecosystem.
If you're interested in retrieving up to date crypto prices in your contracts, learn more about our Price Feeds.
If you need to consume randomness in your contracts, learn about Chainlink VRF.
And if you want your contracts to retrieve data from off-chain APIs, learn about Using Any API.
Updated 18 days ago
What's Next
Learn how to consume crypto prices, random numbers and how to call any API from your smart contracts
Introduction to Price Feeds |
Introduction to Chainlink VRF |
Introduction to Using Any API |