# Tools Clarinet Documentation

## Pages

- [Clarinet](https://hiro-systems-docs-git-develop-hirosystems.vercel.app/tools/clarinet.md): Clarinet is everything you need to write, test, and deploy Clarity smart contracts on Stacks.
- [Quickstart](https://hiro-systems-docs-git-develop-hirosystems.vercel.app/tools/clarinet/quickstart.md): Learn how to create a simple counter contract using Clarinet.

#### (clarinet cli)

- [CLI reference](https://hiro-systems-docs-git-develop-hirosystems.vercel.app/tools/clarinet/(clarinet-cli)/cli-reference.md)
- [Deploying your contracts](https://hiro-systems-docs-git-develop-hirosystems.vercel.app/tools/clarinet/(clarinet-cli)/deployment.md): Clarinet provides comprehensive deployment tools to help you move your contracts from local development to production networks. Whether you're testing on devnet, staging on testnet, or launching on mainnet, Clarinet streamlines the entire deployment process.
- [Interacting with your contracts locally](https://hiro-systems-docs-git-develop-hirosystems.vercel.app/tools/clarinet/(clarinet-cli)/contract-interaction.md): Clarinet provides powerful tools for interacting with your contracts during development. The console gives you an interactive REPL environment where you can call functions, check state, and debug issues in real-time.
- [Managing your projects](https://hiro-systems-docs-git-develop-hirosystems.vercel.app/tools/clarinet/(clarinet-cli)/project-development.md): Clarinet streamlines the entire lifecycle of Clarity smart contract development. From project initialization to contract management and code formatting, you'll have all the tools needed for professional development.
- [Validating your contracts](https://hiro-systems-docs-git-develop-hirosystems.vercel.app/tools/clarinet/(clarinet-cli)/validation-and-analysis.md): Clarinet provides powerful tools for validating, analyzing, and debugging your smart contracts. From static type checking to real-time cost analysis, you can ensure your contracts are correct and efficient before deployment.
- [Working with a local blockchain](https://hiro-systems-docs-git-develop-hirosystems.vercel.app/tools/clarinet/(clarinet-cli)/local-blockchain-development.md): Clarinet provides a complete local blockchain environment, providing all the services you need for smart contract development without deploying to a public network.

#### (clarinet js sdk)

- [Browser SDK reference](https://hiro-systems-docs-git-develop-hirosystems.vercel.app/tools/clarinet/(clarinet-js-sdk)/browser-sdk-reference.md): Use the Clarinet SDK directly in browser environments
- [Clarinet JS SDK](https://hiro-systems-docs-git-develop-hirosystems.vercel.app/tools/clarinet/(clarinet-js-sdk)/sdk-introduction.md): Practical guide to testing smart contracts with the Clarinet JS SDK
- [SDK reference](https://hiro-systems-docs-git-develop-hirosystems.vercel.app/tools/clarinet/(clarinet-js-sdk)/sdk-reference.md)
- [Testing against mainnet data](https://hiro-systems-docs-git-develop-hirosystems.vercel.app/tools/clarinet/(clarinet-js-sdk)/mainnet-execution-simulation.md): Mainnet Execution Simulation (MXS) allows you to test your Clarity smart contracts using actual data and state from the Stacks mainnet. This powerful feature helps ensure your contracts behave as expected in a live environment.
- [Writing integration tests](https://hiro-systems-docs-git-develop-hirosystems.vercel.app/tools/clarinet/(clarinet-js-sdk)/integration-testing.md): Integration testing is a crucial step in smart contract development that involves testing how different components of your system work together. The Clarinet JS SDK provides powerful tools for writing and running integration tests, allowing you to simulate complex scenarios and interactions between multiple contracts.
- [Writing unit tests](https://hiro-systems-docs-git-develop-hirosystems.vercel.app/tools/clarinet/(clarinet-js-sdk)/unit-testing.md): Unit testing is the process of testing individual components or functions of smart contracts to ensure they work as expected. The Clarinet JS SDK provides a testing framework that allows you to write these tests using the Vitest testing framework, helping you catch bugs and errors early in the development process.

#### (integrations)

- [Clarity formatter](https://hiro-systems-docs-git-develop-hirosystems.vercel.app/tools/clarinet/(integrations)/clarity-formatter.md): The Clarity formatter is a tool designed to automatically format your Clarity smart contract code according to standardized style rules. Using consistent formatting improves code readability and maintainability, making it easier for developers to understand, collaborate on, and learn from existing Clarity projects.
- [Register Chainhooks on devnet](https://hiro-systems-docs-git-develop-hirosystems.vercel.app/tools/clarinet/(integrations)/chainhook-integration.md): Learn how to register Chainhooks on devnet to monitor and react to smart contract events during local development.
- [sBTC integration with Clarinet](https://hiro-systems-docs-git-develop-hirosystems.vercel.app/tools/clarinet/(integrations)/sbtc-integration.md): Build and test smart contracts that use sBTC, the decentralized Bitcoin-backed token on Stacks.
- [Stacks.js integration with devnet](https://hiro-systems-docs-git-develop-hirosystems.vercel.app/tools/clarinet/(integrations)/stacks-js-integration.md): Build a frontend that interacts with your smart contracts on devnet using the Stacks.js libraries.
- [Testing Pyth oracle contracts](https://hiro-systems-docs-git-develop-hirosystems.vercel.app/tools/clarinet/(integrations)/pyth-oracle-integration.md): Learn how to test smart contracts that depend on Pyth oracle price feeds using Clarinet.
- [VS Code extension](https://hiro-systems-docs-git-develop-hirosystems.vercel.app/tools/clarinet/(integrations)/vscode-extension.md): The Clarity VS Code extension transforms your editor into a powerful smart contract development environment. You get syntax highlighting, auto-completion, debugging, and real-time error checking.

#### (overview)

- [Anatomy of a Clarinet project](https://hiro-systems-docs-git-develop-hirosystems.vercel.app/tools/clarinet/(overview)/project-structure.md): Understand the complete structure and configuration of a Clarinet project
- [Frequently asked questions](https://hiro-systems-docs-git-develop-hirosystems.vercel.app/tools/clarinet/(overview)/faq.md): Common questions and solutions for Clarinet development
- [Quickstart](https://hiro-systems-docs-git-develop-hirosystems.vercel.app/tools/clarinet/(overview)/quickstart.md): Build your first Clarity smart contract in under 5 minutes