Quick Start

This guide uses the currently implemented StellarForge CLI MVP commands.

For contributor installation, see Installation. For full options and failure behavior, see the Command Reference.

1. Create a project

The default template is basic-app:

stellarforge new my-app
cd my-app

Or choose one of the other bundled templates:

stellarforge new my-api --template api-service
stellarforge new my-contract --template smart-contract
stellarforge new my-stack --template full-stack

Supported template IDs are basic-app, full-stack, smart-contract, and api-service.

stellarforge doctor

The command checks the supported local toolchain and prints remediation guidance. A failed required diagnostic exits with code 5.

From a supported generated Node.js project:

stellarforge dev

StellarForge looks for a supported npm development script: dev, then start, then start:backend.

stellarforge test

Node.js projects use npm run test; Cargo projects use cargo test.

For a smart-contract project, create stellarforge.config.json at the project root:

{
  "version": 1,
  "network": "testnet",
  "identity": "deployer"
}

The identity must already exist in Stellar CLI identity management. Do not place raw secret keys or seed phrases in project configuration.

stellarforge deploy

Or override configuration explicitly:

stellarforge deploy --network testnet --source deployer

The MVP deployment path is Testnet-only. Mainnet deployment is not implemented.