Back to Eliza

__APP_NAME__

packages/elizaos/templates/project/README.md

2.0.12.0 KB
Original Source

APP_NAME

An elizaOS project built on elizaOS.

Layout

  • apps/app — the branded React + Capacitor + Electrobun app package
  • scripts — source-mode helpers for package mode and optional local elizaOS
  • test — local test helpers for the generated app

First Run

bash
bun install
bun run dev

The default install uses published @elizaos/* packages. To switch to an in-repo elizaOS source checkout, eject the local source:

bash
bun run eliza:eject

Common Commands

bash
# 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

Notes

  • Published package mode is the default and uses the 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.
  • Published package mode uses the registry packages and skips the current beta local-embedding/native 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.
  • The default brand kit is intentionally minimal. The source-of-truth files are 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.