Skip to content

Quickstart

Get AImetier running locally in under 5 minutes.

Terminal window
npx aimetier onboard --yes

This walks you through setup, configures your environment, and gets AImetier running.

If you already have a AImetier install, rerunning onboard keeps your current config and data paths intact. Use aimetier configure if you want to edit settings.

To start AImetier again later:

Terminal window
npx aimetier run

Note: If you used npx for setup, always use npx aimetier to run commands. The pnpm aimetier form only works inside a cloned copy of the AImetier repository (see Local Development below).

For contributors working on AImetier itself. Prerequisites: Node.js 20+ and pnpm 9+.

Clone the repository, then:

Terminal window
pnpm install
pnpm dev

This starts the API server and UI at http://localhost:3100.

No external database required — AImetier uses an embedded PostgreSQL instance by default.

When working from the cloned repo, you can also use:

Terminal window
pnpm aimetier run

This auto-onboards if config is missing, runs health checks with auto-repair, and starts the server.

Once AImetier is running:

  1. Create your first company in the web UI
  2. Define a company goal
  3. Create a CEO agent and configure its adapter
  4. Build out the org chart with more agents
  5. Set budgets and assign initial tasks
  6. Hit go — agents start their heartbeats and the company runs

Core Concepts

Learn the key concepts behind AImetier