Installation

Caatinga can be executed directly without global installation via npx or installed locally within your project.

Direct Execution (Recommended)

You can run any Caatinga command using npx with the ctg binary:

npx ctg --help

Local Installation

Add @caatinga/cli to your project’s dev dependencies:

pnpm add -D @caatinga/cli

npm install -D @caatinga/cli

yarn add -D @caatinga/cli

Verifying Setup with Doctor

Run ctg doctor to run system checks against your environment:

npx ctg doctor

Abbreviated output in a freshly scaffolded project (versions vary):

ℹ Caatinga Doctor

ℹ ✓ Node.js 22.22.0
ℹ ✓ Stellar CLI 28.0.0
ℹ ✓ @stellar/stellar-sdk 16.3.1
ℹ ✓ rustc 1.91.1 (<commit> <date>)
ℹ ✓ wasm32v1-none target installed
ℹ ✓ Project dependencies installed
ℹ ✓ caatinga.config.ts found
ℹ ✓ caatinga.artifacts.json found
ℹ ✓ network (skipped — no --network provided)
ℹ ✓ source identity (skipped — no --source provided)

Advisory sections follow for the default network (deploy coverage, env sync, bindings); before the first deploy they list what is still missing, which does not fail the check.

Run it inside a project: before ctg init, the config and artifacts checks fail and doctor ends with Status: blocked. Pass --network <name> to check another network and --source alice to check that the identity alias exists. Doctor makes no RPC calls and does not check account balances.