---
title: "Quickstart"
description: "Get your first agent running in 5 minutes. Initialize a new Nexus OS project directory: This creates a nexus.config.yaml and a data/ directory for the embedded database. Create your first agent from a built in template: "
resource: https://www.aiagents.nexus/docs/getting-started/quickstart
generated: { by: "process:nexus-agent-assets", at: 2026-09-07T09:13:03Z }
status: stable
---

# Quickstart

Get your first agent running in 5 minutes.

## 1. Create a Project

Initialize a new Nexus OS project directory:

```bash
naos init my-project
cd my-project
```

This creates a `nexus.config.yaml` and a `data/` directory for the embedded database.

## 2. Create an Agent

Create your first agent from a built-in template:

```bash
naos create hello-agent --template echo
```

Available templates: `echo`, `http`, `cron`, `pipeline`.

## 3. Run the Agent

Start the agent:

```bash
naos run hello-agent
```

You should see output confirming the agent is running:

```
[nexus] agent hello-agent started (pid: 1)
[nexus] status: running
```

## 4. Check Status

View all running agents:

```bash
naos status
```

Output:

```
AGENT       STATUS    UPTIME    MEMORY
hello-agent running   2m 15s    12MB
```

## 5. View the Dashboard

Launch the built-in web dashboard:

```bash
naos dashboard --open
```

This starts a local server at `http://localhost:4200` and opens it in your browser. The dashboard shows all agents, supervisors, costs, and more.

## Next Steps

- [Configuration](/docs/getting-started/configuration) — Customize your project settings
- [Creating Agents](/docs/agents/creating-agents) — Build custom agents
- [Supervisors](/docs/orchestration/supervisors) — Add fault tolerance