Getting Started

Getting Started

Prerequisites

• Bun 1.1+ (package manager + script runner)
• Ollama with at least:

  ollama pull llama3.2          # chat
  ollama pull nomic-embed-text  # embeddings (RAG)

• Optional: Firebase CLI for rules/hosting deploy and emulators
• macOS / Windows / Linux (Electron targets all three)

First-time setup

From the repo root:

./scripts/setup.sh

This installs app dependencies and copies env examples. Then:

./scripts/dev.sh

Or manually:

cd app
cp .env.example .env   # set ANYLM_FIREBASE_PROJECT + ANYLM_FIREBASE_API_KEY
bun install
bun start              # typechecks/builds, then launches Electron

Firebase project setup: see Auth & Firebase and firebase/README.md.

Emulator mode

./scripts/dev.sh --emulator

Points the app at local Firebase emulators instead of a live project (requires emulator config in firebase/).

Day-to-day commands (app/)

Command	Purpose
bun start	Fix Electron bundle → build → launch
bun run build	env inject → main tsc → renderer tsc → assets
bun run typecheck	Both tsconfigs, no emit
bun test	Unit tests (bunfig.toml preloads Electron mock)
bun run dist	electron-builder packages into app/release/
bun run clean	Remove dist/ and generated env module

What “running” means

Nothing else must be started first for governance: the in-process API talks to Firestore with the user token.

You do need:

1. Ollama reachable (default http://127.0.0.1:11434, overridable via ANYLM_OLLAMA_HOST / OLLAMA_HOST)
2. Valid Firebase project ids in app/.env (or emulators)
3. Optionally Chroma — bundled and started by the app; RAG soft-degrades if it fails

The local OpenAI-compatible endpoint (when enabled in settings) listens on:

http://127.0.0.1:3227/v1

Web site (optional)

cd web
cp .env.example .env.local   # NEXT_PUBLIC_GITHUB_OWNER / REPO
bun install   # or npm — follow web/README.md
bun dev

Verify your setup

cd app
bun run typecheck
bun test
bun start

Confirm: boot splash → sign-in (or resume session) → Ollama status green → create a project → send a chat message.

Next reading

• Architecture
• Code Structure
• Contributing