Quick start

This page takes you from a fresh install to your first completed task. The supported first-success onboarding now performs the provider, safety, verification, and demo steps in the desktop/web UI or CLI; this page shows the short path and what to do next. Install the agent first if you have not — see Installation.

1. Start the host and open the web UI

holaryn serve

This starts the persistent Holaryn host with the web UI at http://127.0.0.1:8765. Open that address in your browser. If you installed the desktop app, just launch it — it starts (or attaches to) a host and opens the same UI in its own window.

2. Follow first-success onboarding

Holaryn Agent has no fallback provider. Until you configure one, the agent does not guess a vendor. A fresh desktop or web session detects that state and opens /onboarding, where you can authenticate, scan and choose a model, select safe autonomy, stream a real verification response, and approve then undo a generated-sandbox demo without using a terminal or editing config files.

For the terminal path, start or resume with:

holaryn onboard

The CLI reports the next exact command. Full details are in First-success onboarding; advanced provider editing remains in Connections and models.

3. Start a chat

Switch to the Chat tab (Ctrl+1 in the desktop app), type a message, and send it. You will see the agent's turns, tool calls, and any approval prompts live in the conversation. When the agent wants to do something consequential — like writing a file — it asks you first by default; see Autonomy and approvals.

4. Run a one-off task from the terminal

You do not need the host running for this — holaryn run is a self-contained attended session:

holaryn run "Summarize the README in this directory"

The agent streams its events to your terminal and prompts you inline for any approvals. Omit the task to get an interactive REPL:

holaryn run

Type tasks at the holaryn> prompt; type quit or exit to leave. The REPL also accepts slash commands and @model mentions for one-shot runs on another configured model.

Where to go next

Running the agent — the persistent host, the OS service, autonomy flags, steering, and resume.
Web interface — a tour of the seven tabs.
Scheduler and automation — unattended jobs on a schedule.
CLI reference — every holaryn subcommand.

← Previous Provider recovery, failover, and circuits Next → Repository instructions