Skip to main content

Clarity development software

Language Server Protocol for Clarity (including Visual Studio Code extension)

The Language Server Protocol (LSP) defines the protocol used between an editor or IDE and a language server that provides language features like auto complete, go to definition, find all references etc.

This makes programming in Clarity easier and much more intuitive.

Clarity LSP Screenshot

Clarity LSP repository is available here. The extension for Visual Studio Code can be downloaded directly from Visual Studio Marketplace, but can be and older version. For a more up to date version you can also download it from open-vsx.

Clarity REPL

A read—eval—print loop (REPL), also termed an interactive toplevel or language shell, is a simple, interactive computer programming environment that takes single user inputs (that is, single expressions), evaluates (executes) them, and returns the result to the user; a program written in a REPL environment is executed piecewise.

Clarity-repl

Instructions on how to install Clarity REPL can be found here.

Clarinet

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

Installation instructions, including build from source instructions can be found here. If you prefer you can directly download the latest compiled realease for Windows, Mac and Linux here.

Clarinet 101 contains multiple Clarinet video tutorials

Getting started with Clarinet

You can verify you have Clarinet installed by checking its version:

$ clarinet --version
clarinet 0.70

More detailed information on using Clarinet is available here. However to get you started, the following commands are important to know.

Create a new project and enter its directory:

clarinet new my-project && cd my-project

Create a new contract inside my-project:

clarinet contract new mycoolcontract

Check the syntax of Clarity:

clarity check

To test your contract:

clarinet test

Enter Clarinet's console:

clarinet console