Docssdk 0.0.0Aether homeOpen Aether

Install the source checkout

Install Aether's workspace dependencies and verify the local CLI before building a package.

1 minute read

The supported builder path currently starts from the Aether source checkout. You need Git and Bun 1.3 or newer. Docker is only needed for the hosted stack, not for the local CLI tutorial.

#Install and verify

From the repository root:

TerminalShell
bun install
bun run apps/cli/src/main.ts systems

The second command must list demo and dnd5e-srd. If it does not, stop there: the CLI registry is the thing that decides which systems a local world can use.

#Start the existing demo table

TerminalShell
bun run dev:play

The repository development task starts the local server and Aether app with the built-in demo world. Use this when changing Aether itself or when you do not need a new system id.

#Scaffold a package

Run the private workspace CLI directly:

TerminalShell
bun run apps/cli/src/main.ts create system my-system --title "My System"
bun run apps/cli/src/main.ts create module my-content --title "My Content"
bun run apps/cli/src/main.ts create mod encounter-clock --title "Encounter Clock"
bun run apps/cli/src/main.ts create mod character-builder --ui app --title "Character Builder"

The system scaffold contains a validated document schema and a declarative native sheet. A native mod scaffold contains a host-rendered panel. --ui app creates a Vite app that runs in the mod sandbox.

Scaffolding creates files but does not register or install the package. Follow Build your first system for the complete system path, or Build a mod interface for local mod installation.

Was this page helpful?