Skip to main content

Clarinet Overview

Announcement: As part of a simplification and improvement process of the Clarinet project, the commands clarinet test and clarinet run are now be deprecated and won't be available in Clarinet 2 that will be released in October 2023. The testing features are available now in the Clarinet SDK.

See our guide to learn how to test smart contract. The SDK API reference is also available here

Clarinet provides a CLI package with a clarity runtime, a REPL, and a testing harness. Clarinet includes a Javascript library, a testing environment, and a browser-based Sandbox. With Clarinet, you can rigorously iterate on your smart contracts locally before moving into production.

Clarinet consists of two main components:

  • Clarity REPL (Read, Evaluate, Print, Loop)
  • Testing harness.

When the above components are used together, you can rapidly develop and test a Clarity smart contract, by deploying the contract to a local devnet or testnet environment.

screenshot

To better understand Clarinet and how to develop with Clarinet, Hiro has created an introductory video tutorial series from Hiro Engineer Ludo Galabru that will guide you through some of the basics of using Clarinet. The video series also shows you how to use Clarinet to develop, test, and deploy smart contracts.

To view these video tutorials, please see Hiro's Youtube channel.

For the latest information on Clarinet, refer to blog posts on Clarinet.

When developing smart contracts, you can also use the Clarity Visual Studio Code plugin.