Skip to main content

Stellar Scaffold

Go from an empty directory to a deployed Stellar dApp without wiring the pieces together yourself.

cargo install --locked stellar-scaffold-cli
Quickstart

Quickstart

Install the CLI, create a project, and get a contract and frontend running against a local network in a few minutes.

Start here

Tutorial

Build a complete dApp end to end — write the contract, wire up the generated client, add payments, and harden it.

Build a dApp

CLI reference

Every command in detail: init, build, generate, watch, and upgrade, plus the configuration each one reads.

Look up a command

Registry

Publish a WASM, deploy named contract instances, and reuse contracts other people have already published.

Publish and deploy

What is Stellar Scaffold?

Stellar Scaffold is a plugin for the Stellar CLI that scaffolds and maintains full-stack Soroban projects. It generates the Rust contract workspace, a frontend template, and the typed TypeScript clients that connect the two — then keeps the clients in sync as your contracts change.

It is built for the part of the work that is not your idea: local network setup, deploy addresses, client regeneration, environment config. You write contracts and UI; the toolkit keeps the wiring correct.

Read the introduction

The loop

Four commands cover the whole lifecycle. Everything in between — building contracts, deploying to a local network, generating TypeScript clients — happens on its own.

  1. stellar scaffold init my-project

    Sets up contracts, a frontend in the framework you pick, and the utility code connecting them — already wired together.

  2. stellar scaffold generate contract counter

    Adds a contract to the workspace and registers it in your environment config.

  3. npm run dev

    Watches your contracts, rebuilds and redeploys them on change, regenerates typed clients, and serves the frontend.

  4. stellar registry publish

    Publishes your WASM to the Stellar Registry so it can be deployed by name on testnet or mainnet.