Clarinet

Clarinet is everything you need to write, test, and deploy Clarity smart contracts on Stacks.

Overview

Clarinet is the fastest way to build, test, and deploy smart contracts on the Stacks blockchain. It gives you a local devnet, REPL, testing framework, and debugging tools to ship high-quality Clarity code with confidence.

To explore Clarinet features with AI, copy and paste llms.txt into your LLM of choice.

Key features

✓ Leverage a powerful CLI - Create new projects, manage your smart contracts and their dependencies using clarinet requirements, and interact with your code through the built-in REPL.
✓ Write unit tests with the SDK - Use the Clarinet SDK to write unit tests in a familiar JS environment and validate contract behavior.
✓ Run a private blockchain environment - Spin up a local devnet with nodes, miners, and APIs so you can test and integrate your code.
✓ VSCode extension - Linter, step by step debugger, helps writing smart contracts (autocompletion, documentation etc).

Installation

Terminal

$ brew install clarinet

Next steps

Quickstart→

Get started with Clarinet.

Writing Clarity contracts→

Learn how to write Clarity contracts.

Need help building with Clarinet?

Reach out to us on the #clarinet channel on Discord under the Hiro Developer Tools section. There's also a weekly office hours call every Wednesday at 1pm ET.