Skip to content

usage.md

Latest commit

 

History

History
55 lines (36 loc) · 1.21 KB

usage.md

File metadata and controls

55 lines (36 loc) · 1.21 KB

Usage

Install

From the repo:

pnpm install && pnpm build
make link          # npm link the built CLI as `sforge`

sforge build/test/deploy require the Stellar CLI and a Rust toolchain with the wasm32v1-none target.

sforge init <name> --template <template>

Scaffolds a new standalone Soroban project:

sforge init payments --template escrow

This copies the template, renames the crate to payments, pins soroban-sdk, adds an optimized [profile.release], and writes a .gitignore and README.md. The result builds and tests on its own — no workspace required.

sforge templates

Lists the available templates (any directory in templates/ with a Cargo.toml).

sforge build

Wraps stellar contract build, producing optimized WASM under target/wasm32v1-none/release/.

sforge test

Wraps cargo test for the current project.

sforge deploy

Wraps stellar contract deploy:

sforge deploy \
  --wasm target/wasm32v1-none/release/payments.wasm \
  --source my-identity \
  --network testnet

Create a funded identity first:

stellar keys generate my-identity --network testnet --fund