Skip to content

Latest commit

 

History

History
140 lines (103 loc) · 5.56 KB

getting-started.md

File metadata and controls

140 lines (103 loc) · 5.56 KB
title Get Started with Monad
sidebarTitle Get Started
description Install Monad, connect a model provider, and run your first durable agent session.
keywords
Monad installation
agent runtime setup
model provider
first session

import { LocalRuntimeData } from '/snippets/local-runtime-data.mdx';

This tutorial takes you from installation to a working mesh in five steps. What you are building is a Monad Mesh: a durable agent team the daemon owns. It starts with one member — Monad Agent Runtime, Monad's bundled first-party agent — and grows by adding other agent runtimes without moving any work.

Monad stores its own state on your machine. Requests to the model provider you choose still leave the machine.

简体中文版:开始使用 Monad

flowchart LR
  A["1. Install the daemon"] --> B["2. Connect a model<br/>for the first-party agent"]
  B --> C["3. Run a session"]
  C --> D["4. Handle approval"]
  D --> E["5. Grow the mesh"]
Loading

1. Install Monad

Use one of the installation methods in the root README. In an interactive terminal, the installer starts the daemon and opens the Web UI on macOS, Linux, and Windows, including the setup flow for a new installation. After an automated or quiet install, run monad up to do the same.

flowchart LR
  You(["You"]) --> Clients["Web · CLI · TUI · editor"]
  Clients --> Mesh["Monad Mesh<br/>daemon-owned team state and policy"]
  Mesh --> Engine["Monad Agent Runtime<br/>first-party member"]
  Mesh --> More["Other members you add later<br/>third-party · ACP · peer"]
  Mesh --> Home[("Local durable state")]
  Engine --> Provider["Your model provider"]
Loading

The mesh owns the team and its work. Closing a browser or terminal does not transfer that authority to another client.

2. Connect a model

Your first mesh member is Monad Agent Runtime, and it needs a model provider. Monad does not bundle local inference. If you plan to work only through third-party agent providers such as Codex or Claude Code, they authenticate separately — skip to step 5.

Choose one setup route:

Route Command or location
Guided terminal setup Run monad init
Scripted setup Run monad provider set and monad credential add
Guided web setup Run monad on a new installation
Web settings Open Studio → Models and providers

The setup flow tests the connection before saving it and lets you choose a default model. See model providers for provider-specific configuration.

Check the result:

monad model list
monad status
monad doctor

3. Run your first session

A session is one durable work thread. It survives client closure and daemon restart, and you can operate it from any client.

Run a one-off task:

monad chat "summarize what changed in this folder"

Create and observe a named session:

monad session new "my first session"
monad session send session_id_here "hello"
monad session watch session_id_here
monad session list

The same session appears in the Web UI because state lives in the daemon. See sessions and the CLI reference for branching, restoration, and scripting.

4. Handle an approval

When an agent requests a gated action, the turn stops and waits for a decision. The approval shows the requested action and its consequence.

sequenceDiagram
  participant A as Agent
  participant G as Approval gate
  participant Y as You
  A->>G: request gated action
  G->>Y: show action and consequence
  Y-->>G: approve or deny
  G-->>A: return decision
Loading

Keep these rules in mind:

  • Denial is a normal result: the agent receives it and can continue
  • The gate fails closed: a high-risk call is denied when no client can answer
  • Sandboxing is separate: approval does not replace process and network containment

See sandbox backends before increasing agent autonomy.

5. Grow the mesh

Add members first, then capability. Existing sessions and history stay where they are.

Goal Add Guide
Run a provider-native runtime as a teammate A third-party agent (Codex, Claude Code, Gemini CLI, …) Third-party agents
Hand a bounded subtask to another agent An Agent Client Protocol connection ACP
Use another machine you own A peer daemon Peer federation
Coordinate several members on one body of work A project and its members Build a team
Decide which member does what — Choose a runtime

Then extend what a member can do:

Goal Add Guide
Add reusable operating knowledge A skill Skills
Connect external tools A Model Context Protocol server MCP
Reach the team from a messaging app A channel Channels
Install a vendor capability bundle An Atom Pack Atoms

Type / in the chat input to inspect available skills and commands.

Continue from here