In-App Guide

  • Desktop app
  • All plans
View as Markdown

What it does

Four pieces of help live inside the desktop app. The Guide answers "what is this and how do I start" with a FAQ adapted to your experience level and a Build with me tutorial that creates a real first project with you in about 15 minutes. The first-launch walkthrough collects your profile, default provider and crew size, then shows the quick version of how AgentsRoom works. The interface tour names every pane of a project window. The Setup assistant installs or repairs a missing agent CLI, step by step, in a visible terminal. The site adds a written guide, "Set up your first agent".

Where to find it

  • Guide button in the title bar, top right (next to AgentsRoom Help, Community and Settings). Once it retires from the title bar, it moves into the AgentsRoom Help bubble, under "Or reach us directly". On the Open Space, the add tile also offers Open the guide.
  • Walkthrough: plays on first launch; replay it from the footer of the Settings window, Replay walkthrough. It ends on a Getting started card ("Welcome in. Here's the quick version.") that explains what vibe coding is, that AgentsRoom is the cockpit and not the AI, and whether your chosen CLI is installed (Ready / Not detected, with Install with the assistant, Install guide, Re-check and I already have it). Its button Create my first project simply closes the card and leaves you on the first-project screen; since 2026-09-29 it no longer starts the Build with me tutorial as well, which newcomers found too much on day one.
  • Interface tour: proposed on a fresh install's first project, once the first agent is launched (the project first opens on "What are we working on today?" with one Full-Stack agent, nothing starts by itself) (Show me around / Guided tour link in the project), and replayable from Settings > View > Interface tour > Replay the tour.
  • Setup assistant: opens from the setup card shown above the composer when an agent's CLI is missing or refused to start, from the CLI update card, and from the chip in the status bar while an install runs.
  • Site: /guide.

How to use it

  1. Click Guide. Answer What is your experience level with code? (change it any time with Change level): the FAQ switches between beginner questions ("What is a project?", "The agent did something wrong, what do I do?"), intermediate ones ("One new feature = one new session?") and expert ones ("How do I structure a multi-project fleet?").
  2. Click Start under Build with me. The tutorial walks you through creating a project, adding a Frontend agent, sending a first message, letting it work, launching the result in the built-in browser and checking it. You perform every action yourself; Exit tutorial keeps your progress and Resume picks it up later.
  3. Interface tour: three or four short questions (which assistants you use, how many things at once, the pace you want, which tools to keep within reach), then the room is built and each zone is named (Projects, Agents, Tools, Composer, Files).
  4. Setup assistant: Machine analysis runs locally (Node.js, npm, Git, network, disk...), then Generate the install plan for the CLIs you select, Start the installation. Pick Assisted (every fix waits for your approval) or Auto (low-risk fixes run by themselves, three attempts per step; anything touching the system still asks). Minimize keeps it running in the background.

Settings

  • walkthroughCompleted (global): onboarding walkthrough done; set to false to replay it.
  • roomTourDone (global): interface tour done or dismissed; set to false to be offered it again.
  • roomTourPending (global): tour armed by the first-launch walkthrough, waiting for the first agent launched in a project.
  • userProfile (global): onboarding profile (audience and experience level) driving the adaptive guide.
  • onboardingVariant (global): first-run path, guided (tutorials) or short (launchpad hint).

Agent tools (MCP)

None.

Providers

All providers. The walkthrough asks for your default provider and seeds new projects with it; the Setup assistant knows the install steps of every supported CLI.

Mobile

Not on the mobile companion. The phone has its own first-run pairing screen; the Guide, tours and Setup assistant are desktop-only.

Limits

  • Build with me needs a working agent CLI; if it cannot start, the tutorial pauses on "The agent could not start" and resumes once the setup card is followed.
  • The Setup assistant runs commands in a visible terminal on your machine; nothing is sent during the analysis.
  • The interface tour starts inside a project ("Open a project first: the tour starts there").
  • The FAQ is static text: for a question it does not cover, ask AgentsRoom Help or reach the team from its support links.

Common questions

  • Where is the help? The Guide button in the title bar, top right.
  • I skipped the intro, can I see it again? Settings footer > Replay walkthrough; for the pane tour, Settings > View > Interface tour > Replay the tour.
  • The agent will not start. Follow the setup card above the composer: the Setup assistant diagnoses and installs the missing CLI.
  • Can I change the level of the guide? Yes, Change level at the top of the Guide.
  • I pressed "Create my first project" and a tutorial started instead. Until 2026-09-29 that button also launched Build with me. It now only closes the card: the first screen behind it is where you start, and the tutorial waits for you in the Guide.

Related