Quickstart

Get your first agent running in 5 minutes.

1. Create a Project

Initialize a new Nexus OS project directory:

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:

naos create hello-agent --template echo

Available templates: echo, http, cron, pipeline.

3. Run the Agent

Start the agent:

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:

naos status

Output:

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

5. View the Dashboard

Launch the built-in web dashboard:

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