Quickstart

From clone to first run in a few minutes.

There is no installer and no account on our side. Lumium is a SvelteKit application with the agent runtime embedded, so the console and the execution loop start together.

1. Run it

Clone the repository onto the machine that will run Lumium and start the server. The example environment file lists the three values you need to set.

Clone the repository

git clone <your-fork-url> lumium
cd lumium/apps/core

Create the environment file

cp .env.example .env

Set the required values

LUMIUM_DATA_DIR=data
DATABASE_URL=file:data/lumium.db
ORIGIN=http://localhost:5173
BETTER_AUTH_SECRET=<random-string>

Install and start

pnpm install --ignore-workspace
pnpm dev

2. First run

Run the server

Install dependencies and start the dev server. The default database is a SQLite file in the project directory, so nothing else is required.

Create your organization

Open the console and sign up. The first thing you create is an organization, which is the tenant that owns people, agents, models, capabilities, and secrets.

Open a project

A project is where work happens: conversations, artifacts, work items, knowledge, files, and automations all belong to it. Membership in the project is the authorization boundary.

Assign an agent

Register a model for the organization, allow it for the project, and assign an agent. Then start a conversation and describe the work.

3. Where things live

Conversations: One thread per piece of work. People and agents post into the same thread.
Artifacts: Files, boards, and typed records that belong to the project, not to a conversation.
Work items: Canonical records with statuses. A board is a view over them, not a second copy.
Automations: Schedules that open conversations, and agent subscriptions to work events.
Knowledge: Organization documents, project knowledge, and conversation notes, kept separate.
Files: A content-addressed library with immutable revisions.
Settings: Models, agents, capabilities, skills, connectors, channels, secrets, and devices.

The concepts page explains the object model in full: organizations, projects, conversations, artifacts, work items, sessions, and the ledger.

Read the concepts

Next Concepts