Clarinet is a Clarity runtime packaged as a command line tool, designed to facilitate smart contract understanding, development, testing and deployment. Clarinet consists of a Clarity REPL and a testing harness, which, when used together allow you to rapidly develop and test a Clarity smart contract, with the need to deploy the contract to a local devnet or testnet.
Clarinet is a Clarity runtime packaged as a command-line tool designed to facilitate smart contract understanding, development, testing, and deployment. It serves as an essential utility for working with Clarity, the programming language for the Stacks blockchain and Bitcoin.
Key Features:
Clarity REPL (Read-Eval-Print Loop): Enables interactive exploration and debugging of Clarity smart contracts directly from the command line.
Testing Harness: Provides a robust framework to test Clarity smart contracts locally, ensuring reliability before deployment.
Cross-Chain Compatibility: Supports development for both the Stacks blockchain and Bitcoin, leveraging their unique capabilities.
Local Development: Allows rapid iteration without the need to deploy contracts to live networks during testing.
Winget Installation: Can be easily installed via winget, ensuring seamless setup across supported platforms.
Audience & Benefit:
Ideal for smart contract developers, auditors, and testers seeking a streamlined workflow for building high-quality Clarity-based applications. Clarinet empowers users to reduce errors, accelerate development cycles, and deploy secure, efficient contracts with confidence.
README
Clarinet
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.
🧑💻 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.
This repo follows the Conventional Commit specification when writing commit messages.
Note: It is important that any pull requests you submit have commit messages that follow this standard.
To start contributing:
Fork this repo and clone the fork locally.
Create a new branch
git checkout -b
Run npm i in the local repo to install and initialize husky and commitlint.
npm i
These tools will be used in a git commit hook to lint and validate your commit message. If the message is invalid, commitlint will alert you to try again and fix it.
Here is an example of a bad message response:
git commit -m "bad message"
⧗ input: bad message
✖ subject may not be empty [subject-empty]
✖ type may not be empty [type-empty]
✖ found 2 problems, 0 warnings
ⓘ Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint
husky - commit-msg hook exited with code 1 (error)
