Skip to main content

Overview

Clarinet is a local development environment that offers everything you need to create and deploy smart contracts on Stacks.

With Clarinet, you can quickly setup your Clarity project through the command line tool. This covers every stage of the development cycle from generating new contracts, an interactive REPL and validating contracts to deployment on a devnet, testnet or mainnet.

Install Clarinet​

brew install clarinet
info

For a visual guide, please see the Setting Up Your Clarity Environment (macOS) video.

Guides​

Create a new contract

→

Add new contracts to your project and have them automatically configured in your project file.

Debug a contract

→

Debug your contract by stepping through your code, printing values, and tracing code execution.

Write unit tests

→

Write unit tests with the Clarinet SDK to verify contract functionality.

Create deployment plans

→

Standardize your contract deployments with customizable plans that can execute multi-step processes automatically.

Run a local development environment

→

Deploy your code in private blockchain environments to test and integrate your contracts.

Analyzing contracts for vulnerabilities

→

Learn how to enable the check_checker feature to identify potentially dangerous areas in your contracts.

Clarinet JS SDK: Make testing in Clarinet even easier with the Clarinet SDK.

Hiro Platform: Skip the Clarinet installation and go straight to building in a hosted dev platform.

Stacks.js: Don’t reinvent the wheel and build faster with a JS library that handles basic functions.

Need help building with Clarinet? Reach out to us on the #clarinet channel on Discord under Hiro Developer Tools section. We also host a weekly office hours on Discord every Monday at 11am ET.