Run the examples locally

You can read and copy every example in Docs without installing anything. For your own application, start with the SDK quickstart. This page prepares the full source project for the guides' existing npm run … commands.

1. Review the setup file

Use Node 24. The setup source fetches the published source files from this Docs site and checks their SHA-256 hashes against the file manifest. It creates a new directory and refuses an existing destination. It does not install packages, execute example code, request keys or submit transactions.

curl -fL https://docs.ammora.org/examples/setup.mjs -o ammora-examples-setup.mjs
# Read ammora-examples-setup.mjs before running it
node ammora-examples-setup.mjs ./ammora-examples
cd ammora-examples

If a download or hash check fails, the incomplete directory is removed. Resolve the error before trying again. Existing destination directories are never overwritten; use your existing project or choose a new name deliberately.

2. Install and select GIWA

npm ci --ignore-scripts
cp .env.giwa.example .env
npm run typecheck
npm run unified:typecheck

The published project pins SDK 0.3.8 and includes all 188 action commands, shared helpers, templates and the optional ALMM unified extension. Repository-only audit/test scripts and private evidence are excluded. The manifest records the upstream source revision and each file's hash.

The local .env.giwa.example uses GIWA Sepolia 91342, auto-route, AMMORA_SEND=0 and an empty AMMORA_READ_RECEIPT. Shell environment variables take precedence over .env; align them too. Keep .env private and use your own addresses. No private key is needed for reads.

3. Start with reads

npm run quickstart:verify
npm run quickstart:configs -- 10
npm run launch:get-config -- 6

These verify deployment configuration and read Config state. A template ID is a starting point to review, not permission to reuse its recipients or economics. Resolve runtime, Explorer, network or state failures before preparing transactions.

Pick the next command in the example browser. The source shows exact arguments and whether it reads, previews or sends. Some commands are send-only; setting AMMORA_SEND=0 does not make every command a preview. Follow the launchpad, vesting, or stablecoin guide for role and execution order.

4. Use the files with your AI

Each example has its own Markdown containing the command, entry source and supporting-file links. Use Copy example Markdown in the browser. Use All source files to inspect shared helpers, JSON inputs, package configuration and the separate extensions/almm-unified CLI.

When copying only part of the project, keep relative paths and required imports together. Input files selected at runtime are not all detectable from imports; review the templates and detailed guide. Installing the SDK alone does not create this project's scripts.

5. Validation boundaries

The setup file retrieves source without sending chain requests. Package installation/type checks are separate from deployment verification and live execution. Historical transaction evidence keeps its original asset, wallet, SDK and block scope. Do not count it as a new test of your setup or resend a successful transaction to reproduce a report.