Skip to content
stxscript. GitHub

Home · CLI

The stxscript command line.

One package, one binary, the whole toolchain: transpiler, formatter, linter, checker, scaffolder, watcher, doc generator, test runner, and package manager. All of it installs with pip install stxscript.

stxscript build <input> [output] Transpile StxScript to Clarity

The core command. Reads a .stx file and writes a .clar file (or stdout if output is omitted).

stxscript fmt <files> Format code

Canonical formatting for .stx source — consistent style across a team without argument.

stxscript lint <files> Static analysis

Surfaces likely mistakes and style issues before they reach the chain.

stxscript check <files> Syntax validation

Fast validation that source parses and type-checks, without emitting Clarity.

stxscript new <name> Create new project

Scaffold from a template: basic, token, nft, or defi.

stxscript watch <path> Watch mode with auto-rebuild

Rebuilds on save while you iterate — the tight inner loop.

stxscript doc <input> Generate documentation

Produces documentation from the source and its type annotations.

stxscript test [path] Run contract tests

Runs the contract-level test suite for your project.

stxscript pkg <command> Package management

init / add / remove / install / list — manage project dependencies.