> ## Documentation Index
> Fetch the complete documentation index at: https://docs.devias.io/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> The docs are served at https://docs.devias.io. Every path in these docs is relative to that root: /llms.txt is https://docs.devias.io/llms.txt.
> Devias is an open-source platform that works as an operating system for a business: a core (records, views, workflows, agents, permissions) with installable modules.
> Pages are typed by folder. concepts/ explains what things are, guides/ gives procedures, reference/ is exhaustive (SDK, CLI, HTTP API), operate/ covers hosting. Use /start/glossary for exact terms.
> Every id in a module (module, object, field, view, action, workflow, step, connection, variable, event, policy) is a uuid. Generate them with `devias id <count>`. Never invent dotted or readable ids.
> Run `devias plan` and read its output before `devias apply`. Apply only what the plan says.
> The OpenAPI document, including the routes of the modules in the reference setup, is at /reference/api/openapi.json.
> Devias is young and changes quickly. If a page and the source repository (github.com/devias-io/devias) disagree, the repository is right.

# Quickstart

> Procedure to run Devias on one machine with Node.js 22, pnpm 10 and the embedded database. Starts the API on port 3000 and the studio on 5173, creates a workspace, installs the CRM module from a reviewed plan and turns on agents. Each step states its expected result.

This procedure runs the Devias server and studio on one machine. It needs [Node.js](https://nodejs.org) 22 or newer and [pnpm](https://pnpm.io) 10 or newer. No database setup is needed: until `DATABASE_URL` points at Postgres, Devias stores everything in an embedded database.

## Run Devias locally

1. **Get the code.**

   ```bash theme={"dark"}
   git clone https://github.com/devias-io/devias.git
   cd devias
   pnpm install
   ```

2. **Start it.**

   ```bash theme={"dark"}
   pnpm dev
   ```

   Expected result: the API listens on `http://localhost:3000` and the studio on `http://localhost:5173`. Verify the API:

   ```bash theme={"dark"}
   curl http://localhost:3000/api/health
   ```

   The response is JSON with `"ok": true`.

3. **Create a workspace.**

   Open `http://localhost:5173`, sign up, and create a workspace. A workspace is the space for one company: its data, people and modules. Its slug is the part of the address after `/workspaces/`.

   Expected result: a new workspace contains only the studio's own pages: Home, Tasks, Documents, Workflows, Agents and Skills.

4. **Install the CRM module.**

   Open **Settings → Modules** and choose **CRM**. The **Install** tab shows the plan: every object, field and view the module would add. Nothing is written until **Install** is pressed and confirmed.

   Expected result: People, Companies and Deals appear in the sidebar. Other modules install the same way.

5. **Check that it works.**

   Press `⌘K` and choose **New person**, or open **Deals** to see the pipeline as a board.

## Turn on agents

Agents need a key from an AI provider. Add one to a `.env` file in the project root and restart the server:

```bash theme={"dark"}
ANTHROPIC_API_KEY=your-key
```

`⌘J` then opens the assistant. To use Google or OpenAI instead, set `AI_PROVIDER` (`google` or `openai`) and the matching key. Without a key everything else works, and the studio shows agents as not configured. Every variable is listed in [Environment variables](https://docs.devias.io/operate/environment.md).

## Related

* [Architecture](https://docs.devias.io/concepts/architecture.md): studio, server and modules.
* [Navigate the studio](https://docs.devias.io/guides/studio/navigate-the-studio.md): regions, shortcuts and Home.
* [What a module is](https://docs.devias.io/guides/modules/what-a-module-is.md): build a module.
* [Deploy](https://docs.devias.io/operate/deploy.md): Postgres and a real deployment.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.