Skip to content
Maia Docs

Run locally with Dev

Local Dev mode is usually used for quick development/debugging. In Dev mode, steps execution can be independent of Runner / sandbox isolation.

Prerequisites

Section titled “Prerequisites”
  • Node.js 20+
  • pnpm
  • Git

Start Maia

Section titled “Start Maia”

  1. Clone the source repo

    Terminal window
    git clone https://github.com/obiscr/maia.git
    cd maia

  2. Install dependencies

    Terminal window
    pnpm install

  3. Generate Prisma Client & initialize database

    Terminal window
    pnpm prisma:generate
    pnpm prisma:migrate

  4. Start development service

    Terminal window
    pnpm dev

Then open:

Open Maia Dev default port: http://localhost:3000

Data storage location

Section titled “Data storage location”

In local mode, data will be stored in the following location by default.

  • macOS: /Users/alice/Library/Application Support/maia-data
  • Linux: /home/alice/.local/share/maia-data
  • Windows: C:\Users\alice\AppData\Local\maia-data

Get updates

Section titled “Get updates”

When maia repository has updates, run the following commands in the source code directory:

Terminal window
git pull
pnpm install

Update database

Section titled “Update database”

If the update includes database migrations (new or modified table structures), you need to run the migration command:

Terminal window
pnpm prisma:migrate

This command will apply new migration files from the prisma/migrations/ directory.

Start the service

Section titled “Start the service”

After completing the migration, start the dev service:

Terminal window
pnpm dev

If you have local uncommitted changes, resolve conflicts/commit them first before updating.