packages/elizaos/templates/project/README.md
An elizaOS project built on elizaOS.
apps/app — the branded React + Capacitor + Electrobun app packagescripts — source-mode helpers for package mode and optional local elizaOStest — local test helpers for the generated appbun install
bun run dev
The default install uses published @elizaos/* packages. To switch to an
in-repo elizaOS source checkout, eject the local source:
bun run eliza:eject
# Web / control UI
bun run dev
# Desktop shell
bun run dev:desktop
# App test suite
bun run test
# App package only
bun run --cwd apps/app build
beta npm dist-tag unless ELIZAOS_VERSION or ELIZAOS_DIST_TAG is set. bun run eliza:eject clones or reuses ./eliza, installs it, and records local source mode in .elizaos/source-mode. bun run eliza:packages switches back to published packages.node-llama-cpp and Baileys QR-auth paths so first install and startup do not depend on optional native or GitHub packages. Eject to local source mode to work on local inference or WhatsApp QR internals../eliza is ignored by git and is not a submodule. Use ELIZA_GIT_URL and ELIZA_BRANCH to choose a different checkout before running bun run setup:upstreams.apps/app/public/favicon.svg and apps/app/public/splash-bg.svg.bun run --cwd apps/app brand:assets regenerates the derived desktop assets: public/splash-bg.jpg, electrobun/assets/appIcon.png, electrobun/assets/appIcon.ico, and electrobun/assets/appIcon.iconset/.apps/app/public/logos/* is still required because @elizaos/app-core maps provider IDs to those fixed asset paths during onboarding and settings flows.