# Vyre docs

> Your team and your AI agents, working together on a server you own. Open source, self-hosted, any model.

Every page is Markdown at the URL below. Everything in one file: https://vyre.run/docs/llms-full.txt

Every command, tool, event, config key, variable, screen and concept, with the page that explains it and every mention: https://vyre.run/docs/index.json

## Start here

- [Vyre docs](https://vyre.run/docs/index.md): What Vyre is, which part of these docs is for you, and the shortest path from nothing to a working first day.

## Get started

- [Install](https://vyre.run/docs/get-started/install.md): Reserve your name, put the Vyre app on your Mac or Windows PC, paste the code, then join a team, add a server, or use your Mac as your home, and add your phone.
- [Your first hour](https://vyre.run/docs/using/first-hour.md): A first run of Vyre, in order. Set up your server, sign in to Claude, open Vyre on your phone, put the Lumen on your Mac and ask it, send one email, and make the Vyre app your own colour.
- [Your first day](https://vyre.run/docs/get-started/first-day.md): What to do on your first day after onboarding: open Lumen, start a thread in a project, launch an agent, store a secret, and find something from last week.
- [Without Docker](https://vyre.run/docs/get-started/without-docker.md): Run Vyre from npm on a Mac, or on a Linux server under systemd, with no containers.
- [Troubleshooting](https://vyre.run/docs/get-started/troubleshooting.md): The failures people actually hit installing and running Vyre, what each message means, and the command that fixes it.

## Releases

- [Vyre 0.1.0](https://vyre.run/docs/releases/0.1.0.md): The first tagged release of Vyre. What it is, what is in it, what it does not do yet, and how to install it and keep it up to date.
- [Release checklist](https://vyre.run/docs/releases/checklist.md): The steps that take a Vyre release from a green branch to every place it is served, in order, with who does each and what proves it.

## Using Vyre

- [Lumen](https://vyre.run/docs/using/capsule.md): Open Lumen on your Mac with Control twice, and use it to find things, ask your assistant or an agent, drive a session, and answer what is waiting on you.
- [Chat](https://vyre.run/docs/using/chat.md): Use Chat in the Vyre app, on your laptop or your phone, to read and type into the sessions Vyre runs on your server, pick which provider and model answers, and answer their questions inline.
- [Private chats](https://vyre.run/docs/using/private-chats.md): Each chat and its files are encrypted to the people in that chat; what the server, its owner and its admins can and cannot read.
- [Spaces](https://vyre.run/docs/using/spaces.md): Personal, My Cloud and a team's Cloud space: where your work lives, what each one keeps, and how to set one up.
- [Sidebar](https://vyre.run/docs/using/sidebar.md): Arrange the places in the app's sidebar, add a module's screens or a saved view, and set the default your team starts from.
- [Time zones](https://vyre.run/docs/using/time-zones.md): How the Vyre app and a space read and show times: your own zone, a space's home zone, and how schedules behave around daylight saving.
- [The vyre command](https://vyre.run/docs/using/cli.md): Do the everyday things from a terminal with vyre, from starting Vyre to resuming a thread, driving a session, asking an agent and scripting any tool.
- [Vyre in Claude Code](https://vyre.run/docs/using/claude-code.md): Install the Vyre plugin in your own Claude Code for Vyre's hooks, tools, skills and /vyre command, and put Vyre's status line under every session.
- [How Vyre runs your sessions](https://vyre.run/docs/using/sessions.md): The sessions Vyre starts run on your own server with your own Claude, Codex, Grok and OpenRouter accounts, one model picker per session, closed when idle and resumed on the next message, with a system prompt you can edit at three levels and undo.
- [Run a space's work on your own computer](https://vyre.run/docs/using/local-runner.md): A member can run a space's AI sessions on their own Mac, Linux or Windows computer instead of the space's server, in a sandbox, inside an encrypted workspace that opens only while the space leases its key, with credentials fetched at the moment of use.
- [Projects and threads](https://vyre.run/docs/using/projects-and-threads.md): How Vyre groups your Claude Code sessions into projects, what a new thread in a project is told, and how to pick, resume and start threads from each surface.
- [Project templates](https://vyre.run/docs/using/project-templates.md): How a project runs from a template of stages and tasks, how to write, try and put a template live, how to start a project from one, and how an agent's change to itself is approved.
- [Skills and plugins](https://vyre.run/docs/using/skills-library.md): How the Space keeps skills and plugins at four levels, who may add and approve one, how each AI is given the approved ones, and what a plugin with code is allowed to do.
- [Teammates](https://vyre.run/docs/using/teammates.md): A teammate is a named role in one project, like design or backend, with its own notes. How to add one, ask it, give it a charter and standing duties, let an integrator merge worktree work, retire it, and what it costs.
- [Flows and Kits](https://vyre.run/docs/using/flows.md): A Flow is a job Vyre does for you when something happens, like a new matter or a payment. How to use one, how a Kit gives you a working set of them, and a worked example with the law firm Kit, its stage tasks and what happens when a task runs late.
- [Agents](https://vyre.run/docs/using/agents.md): How to talk to your assistant, make agents that run on your own server with your own Claude quota, keep them inside the projects you choose, give them their own computer, and see what they cost.
- [Vault](https://vyre.run/docs/using/vault.md): Store credentials sealed, let a module, watcher or agent use one without seeing it, share with a person by pass, fill logins in the browser, and know what the Vault never shows.
- [Memory](https://vyre.run/docs/using/memory.md): Search everything said in every past session, see the facts Vyre remembers about people, organisations and projects, trace each fact to the turn it came from, and correct it.
- [Artifacts](https://vyre.run/docs/using/artifacts.md): The documents, reports, pages, dashboards, diagrams, decks, apps, images, video and audio your agents make, kept on your server with every version, private unless you share one, and what an interactive page can and cannot do.
- [Previews and questions](https://vyre.run/docs/using/previews.md): How an agent shows you something it built or started as a card in the chat, how long it lives, who can open it, what a page may ask for, and how an agent asks you several things at once.
- [Publish](https://vyre.run/docs/using/publish.md): How a folder of ready files becomes a site on the internet with one yes, where its keys come from, how it gets a GitHub repo, and what this server cannot build yet.
- [Outside agents](https://vyre.run/docs/using/outside-agents.md): How to let an agent that is not a Vyre session (Dots, Muse, Hermes, ChatGPT, your own Claude Code on another machine) read the records, memory and files you choose, ask before it changes anything, and stop the moment you end it.
- [Give your own AI a key](https://vyre.run/docs/using/set-up-with-your-ai.md): Make a named key for each of your AIs (Claude Code, Codex, an agent in another tool). It acts as you in Vyre, with the access you have, on this computer or hosted over HTTP. Settings lists the keys and revokes one with a tap.
- [Learning](https://vyre.run/docs/using/learning.md): How Vyre turns your corrections into lessons, enforces them with hooks so Claude cannot forget them, raises a lesson's level when it is broken again, and what only you can loosen.
- [Watchers](https://vyre.run/docs/using/watchers.md): Ask Claude to watch something and file what it finds into a project, see the dry run before it turns on, and look after running watchers from the terminal and the Vyre app.
- [Planner](https://vyre.run/docs/using/planner.md): Alarms, timers, reminders, todos and notes kept on your box, so they ring on your phone and in the Vyre app even when your Mac is shut, and your agents can add them too.
- [Connectors](https://vyre.run/docs/using/connectors.md): Connect MCP servers and Google accounts to Vyre, with credentials from the vault and every send held for your approval, and use them from any Claude session through one entry.
- [Vyre Computer](https://vyre.run/docs/using/computer.md): Let an agent work on a computer by name, the cloud computer by default or one of your Macs, with a Connection or a learned operation tried before the screen and a login typed in by the Vault.
- [Documents and Comms](https://vyre.run/docs/using/documents.md): Make a document from a Word template and your records, file it on the client, send it for signature from a stage, and deliver the link by email or text, with every send held for your yes.
- [Mobile](https://vyre.run/docs/using/mobile.md): Put the Vyre app on your phone from a file (the Android APK, or an iPhone build you install with Xcode), pair it from your computer, and approve work with Face ID or a fingerprint.
- [Windows](https://vyre.run/docs/using/windows.md): Use a Windows PC as a device on Vyre with the Windows app, the Vyre app in a browser, the CLI and the Claude Code plugin, pointed at your server.
- [Box care](https://vyre.run/docs/using/box-care.md): Keep your box healthy by checking it, upgrading it, backing it up and restoring it, reading its logs, moving it to another server, and removing it.
- [Tips](https://vyre.run/docs/using/tips.md): One short line at a time about the part of Vyre you are using, the parts you have not tried, and what an update brought. Where tips show, how often, and how to turn them off.
- [Ask the docs from inside Vyre](https://vyre.run/docs/using/docs-tool.md): Find and read the docs pages without leaving Vyre: docs.find takes what you want to do in plain words, docs.read returns a page or one section of it.

## Concepts

- [The box and the Mac](https://vyre.run/docs/concepts/box-and-mac.md): What runs on your server and what runs on your Mac, why each machine runs one vyred, and how the two talk over your private network.
- [Your private network](https://vyre.run/docs/concepts/network.md): How your devices and servers find each other with nothing to install, how a device pairs, whether a connection is direct or through the relay, what your address is, and who is on the other end.
- [Presence](https://vyre.run/docs/concepts/presence.md): How Vyre tells a person from a model, the three moments that need your yes, and how each surface gives it.
- [The security floor](https://vyre.run/docs/concepts/floor.md): The nine rules Vyre keeps whatever the settings say, and for each one, the code that enforces it today and what is not enforced yet.
- [Modules](https://vyre.run/docs/concepts/modules.md): Why everything in Vyre is a module, the kinds (core, Harness, surfaces, optional and third-party), and how vyred finds, orders and starts them.

## Build on Vyre

- [Modules (API 1)](https://vyre.run/docs/MODULES.md): The module contract v1 on one page. It covers what a module is, module.json, the ctx it gets, who may call each tool, how it reaches the world, how it is added, and the kit that checks it.
- [The module contract](https://vyre.run/docs/build/module-contract.md): The exact shape of a Vyre module, module.json with its five verbs and the entry file's ctx, and every rule the loader enforces, taken from the code.
- [Tools and events](https://vyre.run/docs/build/tools-and-events.md): How a module offers tools with ctx.tool, uses other modules with ctx.call, and emits and hears events, with a complete worked example you can run.
- [Writing a module](https://vyre.run/docs/build/writing-a-module.md): Build a working Vyre module in two files, and the rules the loader holds it to.
- [Build your first module](https://vyre.run/docs/build/first-module.md): A step-by-step tutorial that builds a bake log for Northwind Bakery, with two tools, an event, a declared setting and a test, then switches it off.
- [The agent brief for writing a module](https://vyre.run/docs/build/AGENT-BRIEF.md): The exact instructions to hand an AI agent that has never seen Vyre, so the module it writes installs and works the first time. Rules, steps, the manifest and ctx cheat sheets, a worked example and every refusal with its fix.
- [Tips for your module](https://vyre.run/docs/build/tips.md): Ship tips with a module under teaches.tips in module.json. The fields, the rules a tip must pass, how the tips module picks one, and how a surface shows it.
- [The MCP hub](https://vyre.run/docs/build/mcp-hub.md): How Vyre offers every module tool and every hub tool to Claude through one MCP server, and how the hub runs other MCP servers with vault credentials without ever becoming a route around the floor.

## Reference

- [CLI reference](https://vyre.run/docs/reference/cli.md): Every vyre command, how to call it and what it does, taken from the CLI's own command list.
- [CLI output for surfaces](https://vyre.run/docs/reference/cli-json.md): What vyre --json, --view and vyre commands --json print, so the Capsule, chat and the phone can run a command and draw its answer.
- [Tools](https://vyre.run/docs/reference/tools.md): Every tool Vyre's modules offer, grouped by module, with its input and the callers that may use it.
- [Events](https://vyre.run/docs/reference/events.md): Every event a module may emit, grouped by module, with the payload fields it carries.
- [Configuration](https://vyre.run/docs/reference/config.md): The settings in config.json with their types and defaults, and the environment variables Vyre reads.
- [Files layout](https://vyre.run/docs/reference/files-layout.md): Where everything lives under a Space's files root, and the one module that says so.
- [Modules](https://vyre.run/docs/reference/modules.md): Every module Vyre ships: where it runs, what it requires, and the tools, events and surfaces it offers.
- [Index](https://vyre.run/docs/reference/index.md): Every command, tool, event, config key, environment variable, screen and concept, with the page that explains it and every page and line that mentions it.

## Architecture

- [Architecture](https://vyre.run/docs/architecture/index.md): How Vyre is put together: one daemon per machine, three layers (Core, Harness, Local), the surfaces on top, the repository layout, and where the decisions are recorded.
- [Architecture overview](https://vyre.run/docs/architecture/overview.md): A ten-minute picture of how Vyre is built: the layers, how a call is checked, how an agent's turn runs, where data lives, the Gate, and what each top-level folder holds.
- [The Vyre map](https://vyre.run/docs/architecture/map.md): A 30-minute map of how Vyre is built for a developer who has never seen it: the kernel and its contract, modules, the Gate and approvals, the Vault, Records and Flows, Connections, the harness, the apps, the network and where every kind of data lives.
- [Specification](https://vyre.run/docs/architecture/spec.md): How Vyre is built, from principles and repository layout to the module contract, the core services, the security floor and the milestones.
- [Performance](https://vyre.run/docs/architecture/performance.md): Vyre's idle budgets, how scripts/perf-check holds vyred to them, and the numbers measured against them, with dates.
- [Boundaries](https://vyre.run/docs/architecture/boundaries.md): Which parts of Vyre may import which, the frozen exceptions test/boundaries.test.js allows, and what each one should become.
- [Spaces and members](https://vyre.run/docs/architecture/features/spaces-and-members.md): How a Space, its people, its roles, its invites and each person's seat on a project are kept and checked.
- [Identity and devices](https://vyre.run/docs/architecture/features/identity-and-devices.md): How a person's name, the devices that speak for it, pairing, sign in by name, recovery and GitHub sign-in work.
- [Kernel](https://vyre.run/docs/architecture/features/kernel.md): The trusted core that builds who is calling, decides every call, keeps the event log, and holds sealed values and the model door.
- [Chats](https://vyre.run/docs/architecture/features/chats.md): A chat is one thread of messages between people and agents in a Space, with its own key, tags, project and per-message actions.
- [Agents](https://vyre.run/docs/architecture/features/agents.md): A named agent has its own instructions, memory, context and access, can be shared as Can use or Can edit, and wakes on tasks it is given.
- [Sessions and models](https://vyre.run/docs/architecture/features/sessions-and-models.md): How a chat becomes a running AI session on Claude, Codex or Grok, on which account and on which computer, and how a person switches or fans out to several models.
- [Records](https://vyre.run/docs/architecture/features/records.md): The typed rows a Space keeps (contacts, projects, tasks, anything it defines), with fields, links, sealed values, views and CSV or Excel import and export.
- [Flows](https://vyre.run/docs/architecture/features/flows.md): A Flow is a stored list of steps that starts from a trigger, runs under an approver's authority, and stops for a person wherever a send, a question or a task needs one.
- [Tasks and Needs you](https://vyre.run/docs/architecture/features/tasks-and-needs-you.md): A task has one doer and an optional checker and moves through fixed states; Needs you is the one list of everything waiting on a person; Playbooks start a project with its stages and tasks.
- [Gate](https://vyre.run/docs/architecture/features/gate.md): The Gate holds every outward act that speaks, pays or deletes as the person, until a person approves the exact final words with proof they are present.
- [Vault](https://vyre.run/docs/architecture/features/vault.md): Credentials kept sealed at rest, shared by grant, lease or pass with people and agents alike, and released to a module or an agent without a model ever seeing the value.
- [Files](https://vyre.run/docs/architecture/features/files.md): The Space's Drive with versions, links you share, folders linked live from Google Drive or Dropbox, and the box and computer folders an agent may reach.
- [Documents and signing](https://vyre.run/docs/architecture/features/documents-and-signing.md): Fill a Word template from a record and the records linked to it, file the result on the record, and send it for signature to a signer who needs no account.
- [Sites and publishing](https://vyre.run/docs/architecture/features/sites-and-publishing.md): A site or app goes from a draft to a private preview to a live address through one held yes from a person, with its own domain, secrets, history and isolated edge.
- [MCP and the Engineer](https://vyre.run/docs/architecture/features/mcp-and-engineer.md): The Vyre MCP server that exposes module tools to Claude Code and other clients, the keys that let a person's own AI act as them, the MCP servers Vyre connects to, and the built-in Engineer agent.
- [Relay and networking](https://vyre.run/docs/architecture/features/relay-and-networking.md): How a server and its devices find each other through an always-working encrypted relay, a name directory, the built-in Wink network and optional direct paths.
- [Apps](https://vyre.run/docs/architecture/features/apps.md): The Vyre app on web, phone, Mac and Windows: one Expo codebase served by vyred, the native Mac shell with the Lumen command bar, the Windows shell, sideloaded phone builds and push.
- [Map your business onto Vyre](https://vyre.run/docs/for-agents/MAP-YOUR-BUSINESS.md): A step-by-step method for an AI agent, or a person, to turn any business into Vyre members, records, Playbooks, Flows, agents, documents, sites and Gate rules, with two worked examples.
- [Start here, for AI agents](https://vyre.run/docs/for-agents/START-HERE.md): The entry point for an AI agent that a person has asked to show how their business would run on Vyre, and to help set it up. What Vyre is, a map of the site and the docs, how to operate, the questions to ask, the mapping method, and how to get started today.
- [The prompt to give your AI agent](https://vyre.run/docs/for-agents/PROMPT.md): A two-line prompt that sends your own AI agent to Vyre's entry point for agents, which holds the instructions for mapping your business onto Vyre and helping set it up.
- [ADR 0001: How the Vault seals, releases and shares credentials](https://vyre.run/docs/adr/0001-vault-crypto.md): How the Vault seals credentials at rest, releases one item at a time to a declared module or agent, and shares items as relayed or sealed passes.
- [ADR 0002: Network and identity](https://vyre.run/docs/adr/0002-network-and-identity.md): vyred serves the Deck itself on the box's tailnet addresses with its own certificate and identifies each caller by tailscale whois of the source address, never by a header.
- [ADR 0003: How Glass streams an agent's screen, and who may type into it](https://vyre.run/docs/adr/0003-glass-stream.md): How an agent's screen streams live to the Deck over the tailnet, and how one person at a time takes the keyboard and hands it back.
- [ADR 0004: Presence: proving a person is there before a human-only action](https://vyre.run/docs/adr/0004-presence.md): Human-only actions (approving what the Gate holds, answering permission questions, unlocking vault items) need proof that the person is present on their own device, which a model cannot give.
- [ADR 0005: Glass: a remote computer you can watch, take over, sign in on and browse](https://vyre.run/docs/adr/0005-glass.md): Glass shows a remote computer live and lets a person watch an agent, take over, sign in with the Vault and browse, from the Deck, the Capsule or the phone.
- [ADR 0006: The Vault, next: a key hierarchy, presence on every value, and a person's app](https://vyre.run/docs/adr/0006-vault-next.md): The next Vault: a key hierarchy, presence required for every value a person sees, and an app a person would pick over a password manager.
- [ADR 0007: Intelligence: the memory graph and the learning loop](https://vyre.run/docs/adr/0007-intelligence.md): How project graphs are computed rather than filtered, and how the learning loop turns corrections into lessons that hooks enforce.
- [ADR 0008: The install journey](https://vyre.run/docs/adr/0008-install-journey.md): The install journey from a Mac and a server to a working assistant: vyre box add over SSH, onboarding in the browser, pairing and the ending.
- [ADR 0009: Hardening an agent's container](https://vyre.run/docs/adr/0009-container-hardening.md): Every create body for an agent's container is built in one place with privileged mode, bind mounts, host namespaces, capabilities and devices ruled out in code.
- [ADR 0010: Vault autofill](https://vyre.run/docs/adr/0010-vault-autofill.md): How the Vault fills a login into a browser page, the one path where a value reaches a screen, while staying shut to agents, web pages and stolen browser profiles.
- [ADR 0011: Web Push for the moments the user is needed](https://vyre.run/docs/adr/0011-web-push.md): The Deck uses Web Push so a phone learns when a session asks permission, the Gate holds something, a thread finishes or a lesson is proposed, without the Deck open.
- [ADR 0012: Chrome's debugging port never leaves the container unauthenticated](https://vyre.run/docs/adr/0012-cdp-proxy.md): Chrome's remote-debugging port inside an agent's computer is reached only through computerd's bearer-checked routes, never directly over the internal Docker network.
- [ADR 0014: Using the tailnet fully](https://vyre.run/docs/adr/0014-tailnet.md): Which Tailscale features Vyre uses beyond reaching the box, each optional and off by default.
- [ADR 0015: Screen context, Mac computer use, the side view and voice](https://vyre.run/docs/adr/0015-capsule-sight.md): How a session sees the screen, drives Chrome and Mac apps visibly, takes the user's voice, and lays out the side view, and the lines each of those never crosses.
- [ADR 0016: Connectors, the MCP hub and native accounts](https://vyre.run/docs/adr/0016-connectors.md): How Vyre adds MCP servers and Google accounts without a secret leaving the Vault, and what the Gate holds.
- [ADR 0018: The phone apps, native iOS and Android on the box's API](https://vyre.run/docs/adr/0018-mobile.md): The native SwiftUI and Compose apps and the device presence method; paused in favour of one Expo app (ADR 0027).
- [ADR 0019: The docs site](https://vyre.run/docs/adr/0019-docs-site.md): Why docs/ is the single source for docs.vyre.run, how pages are checked and built without a docs framework, how agents get every page as raw Markdown, and the round-2 additions (page syntax that needs no JavaScript, screenshots that go stale with the code, a terms index, colours from the code).
- [ADR 0020: Vyre as an installable Claude Code plugin](https://vyre.run/docs/adr/0020-claude-code-plugin.md): Installing Vyre as a Claude Code plugin, what it does without Vyre on the machine, and Vyre's status line.
- [ADR 0021: The box reads the paired Mac through the link](https://vyre.run/docs/adr/0021-box-reads-the-mac.md): How the box reads the paired Mac's sessions through the link, and the limits of the first version.
- [ADR 0024: Chat, new sessions, the box's folders, a terminal and questions](https://vyre.run/docs/adr/0024-chat.md): Chat starts sessions in a project or a folder on the box, opens a terminal in the browser, and shows Claude's questions and permission asks as cards the owner answers with no passkey.
- [ADR 0025: The planner on the box](https://vyre.run/docs/adr/0025-planner.md): Alarms, timers, reminders, todos, notes and a calendar kept on the box with one scheduler, delivered to push, the Capsule and the Deck, and open to agents.
- [ADR 0026: The relay, a second way to reach the box](https://vyre.run/docs/adr/0026-relay.md): The box dials out to a small public relay, and paired devices meet it there over an end-to-end encrypted Noise channel set up by scanning a QR code. No Tailscale, no open port, no account. Modelled on Paseo's relay, with device keys, per-direction keys and an authenticated box route added.
- [ADR 0027: One app for the phone, the box's web app and app.vyre.run](https://vyre.run/docs/adr/0027-one-app.md): One Expo codebase builds the iPhone web app, the Android APK, the Deck the box serves and the hosted app at app.vyre.run, with a measured smoothness bar and a native iOS build as the fallback.
- [ADR 0028: The Vault everywhere: import, agent logins, rotation and autofill on every device](https://vyre.run/docs/adr/0028-vault-everywhere.md): How the Vault fills day one from another password manager, lends one login to one agent for one site with a log of every use, reminds a person to rotate through the planner, and fills through each operating system's own autofill on iPhone, iPad, Android, the Mac, the browsers and agent computers.
- [ADR 0029: The resilience contract](https://vyre.run/docs/adr/0029-resilience.md): What every Vyre surface does when the network blips, a lid closes or the box restarts, so an outage is boring.
- [ADR 0030: Vyre-owned sessions and the provider router](https://vyre.run/docs/adr/0030-sessions.md): Vyre runs the sessions it starts through the Claude Agent SDK behind a provider router, so Claude Code now, and Codex and ACP agents later, share one session and event model, one ask path and one set of surfaces.
- [ADR 0031: Project teammates](https://vyre.run/docs/adr/0031-teammates.md): A teammate is a named, persistent agent that belongs to one project, keeps durable notes, and takes work from any session in that project through a serial inbox, so the same kind of work always goes to the same agent.
- [ADR 0032: The person and the device](https://vyre.run/docs/adr/0032-person-and-device.md): Over the network a device of the owner is not the person. Person sessions (passkey, 30 days, pinned to a node) carry the person's actions over HTTP; on the box, Vyre-owned sessions run as a uid that cannot open vyred's socket.
- [ADR 0033: Hackable Vyre](https://vyre.run/docs/adr/0033-hackable-vyre.md): A stable, versioned module API, an extension point for every part, user modules and one settings hub that survive updates, `vyre update` with channels and rollback, and third-party modules installed as grants.
- [ADR 0034: Vyre Memory](https://vyre.run/docs/adr/0034-vyre-iq.md): One question in, one cited answer out, from every session the user has had, their personal facts and the people and projects graph, in one to three seconds, and "not sure, here's what I know" rather than a wrong answer.
- [ADR 0035: The settings hub](https://vyre.run/docs/adr/0035-settings-hub.md): One hub on the box holds every setting, session option and design token, at account, project, device and session level. It is one file a person can edit by hand, and every surface (the Deck, the phone, the hosted app, the Capsule) reads it live and repaints on settings.changed.
- [ADR 0036: One system](https://vyre.run/docs/adr/0036-one-system.md): Four small glue modules (sight, context, suggest, waiting) give every surface the same answer to what is on a screen, where the user is, what they are typing toward and what is waiting on them. They own no data; they read other modules through the registry.
- [ADR 0040: vyre-core, a trusted root split from vyred](https://vyre.run/docs/adr/0040-vyre-core.md): On a Mac, vyred and the person share a uid, so anything a model's shell can write, vyred can be made to trust too. vyre-core is a small, root-owned, always-on daemon that owns every secret, trust anchor and send credential; the rest of vyred stays a person-uid app and asks it for anything privileged.
- [ADR 0039: Vyre anywhere](https://vyre.run/docs/adr/0039-vyre-anywhere.md): The server is a role the person chooses, not the OS. Solo, a Mac or Linux box as an always-on server, and a cloud server are one install with the same move-to-server flow; config.machine replaces the darwin-means-local guess.
- [ADR 0045: Wink, scan-to-pair tickets](https://vyre.run/docs/adr/0045-wink.md): A Vyre code carries only a 64-bit ticket; the phone derives a locator, a pairing secret, a MAC key and a record key from it, resolves a sealed record from the relay, and pairs over the ordinary Noise handshake. The relay holds ciphertext only.
- [ADR 0046: The relay introduces, Tailscale carries](https://vyre.run/docs/adr/0046-relay-introduces-tailscale-carries.md): A server signs in to Tailscale once at setup; Wink pairs every device over the relay; a Touch ID-confirmed pairing mints a short-lived, tagged auth key and sends it over the paired channel so a desktop auto-joins the tailnet, which Vyre then prefers. Phones stay on the relay by default.
- [ADR 0050: The built-in network](https://vyre.run/docs/adr/0050-built-in-network.md): Vyre carries its own traffic. Each server runs Headscale, desktops and Android run a Vyre-managed open-source client core, the iPhone goes through the relay, and the person only ever sees Wink. This replaces ADR 0046's Tailscale transport.
- [ADR 0047: The module contract v1](https://vyre.run/docs/adr/0047-module-contract-v1.md): The frozen module API 1 for Vyre 0.2. It covers module.json with per-tool reach and outward marks, the ctx a module gets, the capability manifest every agent reads, added modules running in a sandboxed host, the install card, and the kit that lets an agent write a module that works the first time.
- [ADR 0049: Deep Chrome control](https://vyre.run/docs/adr/0049-deep-chrome-control.md): One first-party Vyre extension using chrome.debugger, a native-messaging host and a module in vyred give agents fast, redacted, floor-checked control of the person's own Chrome, with the plan shown first and Esc to stop.
- [ADR 0051: The identity chain](https://vyre.run/docs/adr/0051-identity-chain.md): A person or a space is a permanent id plus a signed, chained list of who can speak for it. The name directory holds only public keys, verifies every change against the previous list, and cannot forge an entry.
- [ADR 0052: The session stream](https://vyre.run/docs/adr/0052-session-stream.md): One typed, resumable stream per session. Every screen reads the same frames with a cursor, resumes from it over a direct connection or the relay, and steering, stopping, terminal commands and tool results travel in it as typed frames and blocks.
- [ADR 0053: The public door](https://vyre.run/docs/adr/0053-the-public-door.md): People outside your network reach your server through a relay that routes by server name and never decrypts. The server keeps the certificate, filters the paths, and opens no inbound port.
- [ADR 0041: GitHub everywhere](https://vyre.run/docs/adr/0041-github-everywhere.md): How Vyre signs in to GitHub, lists repos, turns one into a project, and gives every session its own worktree and branch.
- [ADR 0042: The move engine](https://vyre.run/docs/adr/0042-move-engine.md): How a person moves from one machine to another (laptop to server, server to server), what stays live while it copies, how the vault crosses without ever touching disk unsealed or copying trust itself, and how the person confirms and later frees the source.
- [ADR 0043: Identity marks: four families, and the Vyre code](https://vyre.run/docs/adr/0043-identity-marks-and-vyre-code.md): Vyre has four visual identity families with distinct silhouettes (person circle, assistant creature, agent blob, teammate tile), none resembling any AI brand's own mark. The person's circle carries a second, scannable form (the Vyre code) that encodes a one-time pairing ticket, read only by phone.vyre.run's own decoder - not a standard QR, and no normal-camera fallback.
- [ADR 0037: Windows support: tiers and the 0.1.x cut](https://vyre.run/docs/adr/0037-windows.md): Windows PCs are devices, never the server. 0.1.x ships Windows as a client of a Linux server (Deck, PWA, CLI, Claude Code plugin) and a documented WSL2 path to run the server itself; a native Windows Capsule and computer use are 0.2.

## Security

- [Security](https://vyre.run/docs/security/index.md): The security model in one page: the floor that cannot be switched off, how the vault seals values, who can reach the box, how agents' containers are locked down, and how to report a problem.

## Contributing

- [Contributing](https://vyre.run/docs/contributing/index.md): How to change Vyre: where the code lives, the engineering rules every change follows, the changelog, decision records, and how to run the tests.
- [Writing the docs](https://vyre.run/docs/CONTRIBUTING-DOCS.md): The contract every page on docs.vyre.run follows: front matter, the nav, redirects, includes, generated reference pages, the checks, the build, and the style.
- [Testing](https://vyre.run/docs/contributing/testing.md): How Vyre's tests are organised, the helpers and fakes they use, how to run one area, and how the idle budgets are checked.
- [Design tokens](https://vyre.run/docs/design/TOKENS.md): The colour, type, shape and mark tokens every Vyre surface uses, with the values to paste verbatim.
- [Vyre product icons, brand sheet](https://vyre.run/docs/design/brand/README.md): The four Vyre product icons (Lumen, Drive, Vault, Memory), what each one means, the glass material, how to use and wire them, and where every export lives.
- [Deck design](https://vyre.run/docs/design/deck.md): The Deck's visual system and screen patterns, Direction B second pass, picked on 27 Sep 2026.
- [Settings inventory](https://vyre.run/docs/design/settings-inventory.md): Every setting in Vyre and Claude Code, the level it is set at, where it lives, and its control.
- [The native bar](https://vyre.run/docs/design/native-bar.md): Budgets that say when Vyre chat is as quick as the terminal, and how the harness measures them.
- [Vyre phone](https://vyre.run/docs/design/phone.md): The design for Vyre on a phone, one Expo app for iOS, Android and the web, built on the Deck's tokens.
- [Session credentials: real keys, not narrow tools](https://vyre.run/docs/design/session-credentials.md): How a Claude Code session gets vault items as its own environment, how it can ask for more mid-session, and how an "acts as me" key stays behind an egress proxy instead of ever reaching the model.
- [Vyre one app](https://vyre.run/docs/design/one-app/README.md): One Expo app for the web, iOS and Android, with the Capsule and the CLI on the same tokens, and install with no Apple Developer account.
- [Vyre one app, the direction](https://vyre.run/docs/design/one-app/DIRECTION.md): Three directions for one app on every device, the recommendation, the smoothness bar and the install path, for the user to decide before the full sheet.
- [Cohesion: making Vyre one system](https://vyre.run/docs/design/cohesion.md): The ranked map of places where Vyre's modules and surfaces should share one answer, who owns each, and the shared contracts behind them (ADR 0036).
- [Interaction: one language for all of Vyre](https://vyre.run/docs/design/interaction.md): How Vyre streams, updates live, answers optimistically, and shows its work, on every surface, so the whole product feels like one system built with the same hand.
- [Vyre Memory everywhere](https://vyre.run/docs/design/iq-everywhere.md): What Vyre Memory does on each surface today, what it should do, the gaps ranked by value for cost, and who builds each one. The contract is memory.ask (ADR 0034).
- [Import: discover your sessions and build the graph](https://vyre.run/docs/design/import.md): How Vyre finds every Claude Code session on a device, lets the person choose what to import, and makes it searchable and answerable while the graph fills in live. Stages, contracts, consent, sizes and owners.
- [MCP, native: every Claude Code server in Vyre](https://vyre.run/docs/design/mcp-native.md): What the hub and Connections UI do today for MCP servers, the gap against Claude Code's own config, and the plan to make discovery, multi-account and per-project on/off native (ADR 0016).
- [Onboarding v2: a step per import](https://vyre.run/docs/design/onboarding-v2.md): Onboarding leads for 0.1.1. Every import and setup gets its own dedicated, interactive, skippable, resumable step, each ending in a small celebration, with a summary at the end. The step-shell every team's engine plugs into, the ten steps, their owners and sizes, and how one onboarding serves every device.
- [Drive onboarding: what to sync, how, and the moment it sticks](https://vyre.run/docs/design/drive-onboarding.md): Options for a new onboarding step covering VyreDrive, sized and marked built or not, for the lead to take to the user.
- [How a project ties Vyre together](https://vyre.run/docs/design/projects-map.md): A project is a home folder plus everything picked into it. This maps how sessions, IQ, watchers, teammates, helpers, chat, the vault and files each touch a project, with an owner and a built/gap mark for each.
- [Vyre anywhere](https://vyre.run/docs/design/anywhere.md): The capability ladder, the role choice, the move-to-server flow, and the Mac server service that implement ADR 0039.
- [Glass plan -- true module, native screen, rc.2](https://vyre.run/docs/design/glass-plan.md): Audit of glass-live against 0.1.0-rc.1 (main), a plan for Glass as a clean swappable module, and a concrete "feels like your own screen" plan with cheap wins and tests.
- [Agent browsers -- three levels, a reach ladder, one registry call](https://vyre.run/docs/design/agent-browsers.md): Replacing one-computer-per-agent with three levels (none, a shared headless browser with per-agent contexts, a small desktop pool), a browse.task reach ladder, and Glass watching any of it live. User-approved direction, 28 Sep.
- [Teammates: default, and distinct in chat](https://vyre.run/docs/design/teammates.md): Makes project teammates the default over subagents in every Vyre SDK session, adds @role routing that creates a teammate on first use, and makes a teammate's handoffs distinct in chat without a per-teammate colour.
- [Tailscale plan](https://vyre.run/docs/design/tailscale-plan.md): Status of ADR 0014's ten parts, where more benefit is on the table, the simplest install, and what fits 0.1.1.
- [vitals (design)](https://vyre.run/docs/design/vitals.md): A first-party module showing how the server and every paired device are doing, without nagging or a new timer while nobody watches.
- [The assistant: ecosystem manager, and delegated authority](https://vyre.run/docs/design/assistant.md): What the assistant is today, ranked opportunities to make it the manager of the whole ecosystem, and the core design for delegating person-only powers to it safely.
- [Said: asking is approving](https://vyre.run/docs/design/said.md): How the person's own request becomes the approval for a send, post or payment, and why a model cannot forge it. The extractor in lib/said, its guards, its contract with sessions and vault, and the S9 eval.
- [Undo: the shared acted-log](https://vyre.run/docs/design/undo.md): How core/undo records what agents, the assistant, watchers and modules did for the person, each with the inverse its own module declared, and how one tap runs that inverse. Who may record, who may undo, and which caller the inverse runs as.
- [Windows support: tiers and plan](https://vyre.run/docs/design/windows-plan.md): The full assessment behind ADR 0037: a file-level inventory of Mac-only versus cross-platform code, four support tiers with sizes and an order, and the open risks.

## Design system

- [Vyre design system](https://vyre.run/docs/design/system/README.md): Design A v1, frozen 27 Sep 2026. Tokens, 47 component specs, layout and navigation, copy rules and the render audit, for the Deck, the app and Lumen.
- [Tokens](https://vyre.run/docs/design/system/tokens.md): The one tokens.json and what each surface generates from it; theme overrides and the rules no theme may break.
- [Layout and navigation](https://vyre.run/docs/design/system/layout.md): The breakpoints, the three shapes of the one app, the rail and the phone shell, Lumen, and where every place lives on each surface.
- [Copy](https://vyre.run/docs/design/system/copy.md): How Vyre's screens talk: voice, the words we use and never use, names, times and counts.
- [The render audit](https://vyre.run/docs/design/system/audit.md): The check every design board passes, how to run it locally and in CI, and what it does not catch.
- [Lumen, redesigned](https://vyre.run/docs/design/system/capsule.md): The Design A Lumen for capsule-pro. Keyboard first, answers on pause, a follow-up box, Vyre Memory with sources, an answer card that grows then scrolls, voice on Option-Return and computer use you can stop with Esc.
- [Spec lists by team](https://vyre.run/docs/design/system/teams.md): Every open gap in the Design A v1 specs, sorted by the team that closes it, with the items to do first and the checks that say a team is done.
- [Account picker row](https://vyre.run/docs/design/system/components/account-row.md): The one row for choosing which account does a thing, from vault.connections.list {capability}. Provider tile, account, label, Default or Last used, and its state with the fix inline, in suggestions, Lumen, chat and a send's draft card, with Connect another at the end.
- [Agenda](https://vyre.run/docs/design/system/components/agenda.md): The day agenda with hour rows, event blocks and the now line, plus the ringing card, the missed banner and the phone's firing screen.
- [Artifact card](https://vyre.run/docs/design/system/components/artifact-card.md): A thumbnail of a doc, report, page, dashboard, diagram, deck or app an agent made, opening a version-barred panel beside chat (or a full-screen sheet on the phone), with a diff between versions and a share sheet.
- [Ask card](https://vyre.run/docs/design/system/components/ask-card.md): A permission ask with exactly what will run, why, and three answers (Allow once, Always in the project, Deny) on keys A and D.
- [Avatar](https://vyre.run/docs/design/system/components/avatar.md): The agent tile (an initial in a rounded square) and the person avatar (an initial in a circle), in four sizes.
- [Banner](https://vyre.run/docs/design/system/components/banner.md): The in-page banner for a fact that changes what you can do on this page, such as a restart that is needed, a usage pause or a missed alarm, with one action.
- [Button](https://vyre.run/docs/design/system/components/button.md): The five buttons (primary, secondary, outline, ghost, hold), their four heights, busy and disabled states, and the key hint inside.
- [Calendar invite and event card](https://vyre.run/docs/design/system/components/calendar.md): A held outbound invite (title, time zone-aware time, people with availability, location or video, edit in place, Send) as a draft-card.md variant, and a read-only event card for an existing meeting.
- [Lumen on the Mac](https://vyre.run/docs/design/system/components/capsule-mac.md): The native Swift panel that opens with Control twice over any app, answers the Needs rows, streams the assistant's reply and queues offline.
- [Lumen on Windows](https://vyre.run/docs/design/system/components/capsule-windows.md): How the Mac Lumen's Design A translates to a native Windows panel, Mica and Acrylic, Segoe fallback fonts, the tray, system notifications and the Windows Hello prompt.
- [Card](https://vyre.run/docs/design/system/components/card.md): The one surface for grouped content, a panel with a hairline, with an optional 44 header and a footer that holds the actions.
- [Chip](https://vyre.run/docs/design/system/components/chip.md): Three small labels: the tag (a static fact), the filter chip (on or off) and the source chip (where a setting's value comes from).
- [Choice list](https://vyre.run/docs/design/system/components/choice-list.md): A short list of cards where one is chosen: Create a space or Join a space, run here or on the server.
- [Access list](https://vyre.run/docs/design/system/components/access-list.md): Who has something and at which level, Can use or Can edit; each row changes its level or removes the person, and Add lists the people and agents not yet on it.
- [Code display](https://vyre.run/docs/design/system/components/code-display.md): A code to read or copy: label, the code in mono at the title size, Copy, one line under it.
- [File viewer](https://vyre.run/docs/design/system/components/file-viewer.md): One component that shows any file the way it should look, with the same chrome for all: name, version, who changed it, Show changes, Open in Files, Download, Edit. Its markdown mode is also the editor for an agent's or a project's instructions.
- [Field editor](https://vyre.run/docs/design/system/components/field-editor.md): One pane to define a field of a Records type: name and kind, options, a relation, rules, conditions and who sees it. Includes the choices editor, relation editor, rule builder and visibility matrix.
- [Field rows](https://vyre.run/docs/design/system/components/field-rows.md): The fields of a type as rows, each with one line that says everything set on it.
- [Flow builder](https://vyre.run/docs/design/system/components/flow-builder.md): A Flow read as a sentence: a trigger, then steps in order, each a card that says what it does and opens to its settings.
- [Grouped list](https://vyre.run/docs/design/system/components/grouped-list.md): Items in named groups that can be added, renamed, reordered and collapsed. The one component every sectioned list uses.
- [Import wizard](https://vyre.run/docs/design/system/components/import-wizard.md): Four steps to bring records in from a file or another system; nothing is written until the third is approved.
- [Model map](https://vyre.run/docs/design/system/components/model-map.md): Every record type of a space with its counts and the types it links to, on one screen.
- [Record form](https://vyre.run/docs/design/system/components/record-form.md): The create form of any Records type, drawn from its fields.
- [Record page parts](https://vyre.run/docs/design/system/components/record-page-parts.md): The header, the related sections and the one timeline that make up a record page.
- [Type starter](https://vyre.run/docs/design/system/components/type-starter.md): Add a type: pick a starting point (blank or from a Kit), see the fields it brings, name it.
- [Code field](https://vyre.run/docs/design/system/components/code-field.md): A field for a code typed or pasted: capitals, hyphens put in as you type, a fixed first word.
- [Command bar](https://vyre.run/docs/design/system/components/command-bar.md): The one entry for jumping, finding and asking, as the ⌘K bar and palette on the desktop and as the phone Lumen opened into Find.
- [Composer](https://vyre.run/docs/design/system/components/composer.md): The session input that works like Claude Code in the terminal, with steer by default, queue for after, stop, rewind, modes, and the line prefixes for commands, files, shell and memory.
- [Confirmation line](https://vyre.run/docs/design/system/components/confirmation.md): The after-the-fact line for a send the person's own turn already asked for ("asking is approving," ADR matched by said_intents) - it happened, here's what, with Undo where that's real.
- [Control row](https://vyre.run/docs/design/system/components/control-row.md): One setting with a switch at the end, or with a segmented choice under its text; used where a list of settings is edited as you go.
- [Credential sheet](https://vyre.run/docs/design/system/components/credential-sheet.md): The one sheet every surface shows when a module answers needs_credential. What it asks (a key, a file or a sign-in), why in one line, a secret field that never echoes, where it is kept, the grant in the same step and one Touch ID, with an inline variant in Lumen and a bottom sheet on the phone.
- [Device row](https://vyre.run/docs/design/system/components/device-row.md): One device in Devices, saying how it reaches the box now, what it holds, when it was last seen, and for a browser whether you trust it, with Trust, Stop trusting and Remove.
- [Secret field](https://vyre.run/docs/design/system/components/secret-field.md): A key and its value where the value is never drawn until the person clicks Reveal; it shows for 60 seconds, Copy empties the clipboard after 30.
- [Diff](https://vyre.run/docs/design/system/components/diff.md): A unified line diff with added lines on the bone wash, removed lines on a neutral wash, and line numbers.
- [Draft card](https://vyre.run/docs/design/system/components/draft-card.md): A held outbound draft whose every line edits in place, with Send, Discard, a scheduled send and the presence line.
- [Email thread card](https://vyre.run/docs/design/system/components/email-thread.md): A read view of an email thread an agent found or is discussing, messages collapsed to the newest with sender rows, paired with draft-card.md for composing the reply.
- [File and link preview](https://vyre.run/docs/design/system/components/file-preview.md): A compact row for a file an agent touched or a link it found - icon or thumbnail, name, one meta line, opens in place. Not the full diff, not the full artifact card.
- [Flow step](https://vyre.run/docs/design/system/components/flow-step.md): The one page of a guided flow: Back, step strip, title, body, a failure, one primary action.
- [Form controls](https://vyre.run/docs/design/system/components/form-controls.md): Field, textarea, select, toggle, segmented control, stepper, checkbox, radio and search field, at desktop and touch sizes.
- [Glass frame](https://vyre.run/docs/design/system/components/glass-frame.md): The frame around an agent's live computer screen, with the Live badge, the take-over bar, the read-only banner and the idle warning chip.
- [Glass mini-view](https://vyre.run/docs/design/system/components/glass-mini.md): "What the agent is doing now": a small live frame of an agent's screen with its current step line, on Now, in a thread, in Lumen as a pill and on the phone. A chat tool row links to its step.
- [Icon button](https://vyre.run/docs/design/system/components/icon-button.md): A square button holding one icon, for frequent actions whose meaning the icon carries (More, Back, Add, Dictate, Send).
- [Icons](https://vyre.run/docs/design/system/components/icons.md): The one 16-grid stroke icon set, its sizes and colours, and the Vyre mark, shared by every surface.
- [Key hint](https://vyre.run/docs/design/system/components/key-hint.md): The small boxed key chip that shows a keyboard shortcut next to what it does, on desktop only.
- [List row](https://vyre.run/docs/design/system/components/list-row.md): The generic 44 row with a title and a meta line, used by every list that is not Needs you, settings or devices, with hover, focus and selected states.
- [List](https://vyre.run/docs/design/system/components/list.md): The list container every place uses, with its header, sticky group headers, filter chips, 40 rows at a time and Load 40 more.
- [Match words](https://vyre.run/docs/design/system/components/match-words.md): The words two devices both show so a person can see they are talking to each other.
- [Mode chip](https://vyre.run/docs/design/system/components/mode-chip.md): The session mode chip (Plan first, Asks first, Edits allowed, Doesn't ask) and the provider chip (Claude · opus · subscription), in the composer and the session header.
- [Needs row](https://vyre.run/docs/design/system/components/needs-row.md): The one row for everything that waits on you, of every kind, with a title, one detail line and a kind line, answered by a swipe on the phone and by keys on the desktop.
- [Authenticator code](https://vyre.run/docs/design/system/components/otp.md): A one-time code with the current value large, the next value small and a ring that counts down the 30 s window.
- [Password field](https://vyre.run/docs/design/system/components/password-field.md): A password input with Show and Hide and an optional four step strength meter.
- [Phone shell](https://vyre.run/docs/design/system/components/phone-shell.md): The app under 720 px, with a header of page labels, three pages you swipe, the floating Lumen, the Places sheet and pushed screens.
- [Pill](https://vyre.run/docs/design/system/components/pill.md): The one floating status pill for a box that does not answer, and the quiet queued line for what waits in the outbox; never a wall.
- [Plan card](https://vyre.run/docs/design/system/components/plan-card.md): An agent's plan to approve, as a short document with steps, what it will not touch and the files it expects, then Start building in a chosen mode, Revise or Keep planning.
- [Popover](https://vyre.run/docs/design/system/components/popover.md): Menus and pickers that open from a control, the mode popover, the @ file picker, the / command menu and row menus, which become a sheet on the phone.
- [Picker list](https://vyre.run/docs/design/system/components/picker-list.md): The one list under the composer for / commands, @ people and AIs,
- [Chip token](https://vyre.run/docs/design/system/components/chip-token.md): A quiet, removable chip for state that differs from the default: a picked record, a person, where it runs, queued.
- [Answering control](https://vyre.run/docs/design/system/components/answering-control.md): One control for which AI replies: stacked provider marks and the words, opening the Answering list for one, several or all, and each one's model.
- [Chat panel](https://vyre.run/docs/design/system/components/chat-panel.md): The one panel for everything about a chat, a right-side panel on a wide screen and a sheet on a phone, replacing the two "In this chat" sheets.
- [Message actions](https://vyre.run/docs/design/system/components/message-actions.md): The per-message actions as one quiet icon row with a menu for the rare ones, and the transcript keyboard that drives it.
- [Status pill](https://vyre.run/docs/design/system/components/status-pill.md): The one neutral pill for where something is in its stages ("Stage 2 of 5"), and the one violet variant that says it needs you.
- [PR review card](https://vyre.run/docs/design/system/components/pr-review.md): A pull request's summary, checks, files (diff.md's multi-file variant) and review comments, with Approve and merge from the session.
- [Presence line](https://vyre.run/docs/design/system/components/presence-line.md): The quiet line under Send that says a Face ID or Touch ID proof covers sends and until when, the lapsed "Send with Face ID" state, and the sign-in sheet for a new device.
- [Provider row](https://vyre.run/docs/design/system/components/provider-row.md): One AI account in a list: mark, name, one sentence, and a button that follows the state.
- [Question card](https://vyre.run/docs/design/system/components/question-card.md): An agent's question with radio or checkbox choices, an Other field and Submit, answered from the session or from Needs you. The Survey variant adds a recommended mark, a thoughts box per question and a progress bar.
- [Rail](https://vyre.run/docs/design/system/components/rail.md): The 72 px icon rail with labels that holds every place on tablet and desktop widths, with the Now count badge.
- [Command result card](https://vyre.run/docs/design/system/components/result-card.md): How a vyre command's result {view, title, rows or text, actions} renders natively in Lumen, chat and the Deck. Three views (table, text, card), a row cap with Show all, mono only for code and paths, actions as ghost buttons with keys, copy as text, and errors. Also the Answer variant memory.ask draws in Find and the Memory view, with correct-in-place.
- [Role picker](https://vyre.run/docs/design/system/components/role-picker.md): The list a person chooses a role from when inviting someone, each role with one sentence of what it can see, then optional projects and, for Guest, an end date.
- [Settings row](https://vyre.run/docs/design/system/components/settings-row.md): One setting as a row with its label, description, control, where its value comes from, a reset that names where it goes back to, and when the change applies.
- [Sheet](https://vyre.run/docs/design/system/components/sheet.md): The phone bottom sheet with a grabber and a scrim, which becomes a centred card or a right sheet on the desktop.
- [Sidebar](https://vyre.run/docs/design/system/components/sidebar.md): The Quiet sidebar: main places, AI and Build groups, drill-in panels with Back, a slim folded rail, search in the footer.
- [Sortable list](https://vyre.run/docs/design/system/components/sortable-list.md): A list whose rows are dragged by a grip to change their order (an agent's model plan).
- [Space tile](https://vyre.run/docs/design/system/components/space-tile.md): A space's mark: its uploaded logo cropped to a rounded square, else a monogram on a calm tint.
- [Stack](https://vyre.run/docs/design/system/components/stack.md): One layout primitive for screens: children in a column or a row with a gap from the space scale.
- [States](https://vyre.run/docs/design/system/components/states.md): The seven patterns every list applies on every surface, empty, loading, offline, error, many items, long names and decided, each with its exact copy.
- [Status mark](https://vyre.run/docs/design/system/components/status-mark.md): The five status marks (needs you, failed, running, unread, done), the needs-you badge and the neutral count, one model on every surface.
- [Stepper and checks](https://vyre.run/docs/design/system/components/stepper-checks.md): The numbered stepper, the live check rows that turn bone in place, and the QR block used by Add your phone and first-run setup.
- [Suggestions](https://vyre.run/docs/design/system/components/suggestions.md): The one suggestion list for Lumen input, the chat composer on the Deck, the PWA and the app, and later the CLI, drawn from suggest.query. One row look per kind, the three lanes, inline phrase completion as ghost text, and rows that never jump.
- [Tabs](https://vyre.run/docs/design/system/components/tabs.md): Segmented tabs that switch views inside a detail pane (Session, Terminal, Files; Now, Inbox, Results, Notes, Setup), and the phone's tab strip.
- [Terminal](https://vyre.run/docs/design/system/components/terminal.md): The session's real terminal in an xterm frame, with a phone key bar, one device owning the size, and a screen that survives disconnects.
- [Tip](https://vyre.run/docs/design/system/components/tip.md): One quiet tip at a time on every surface, from tips.next. A muted line or chip with its key or command, Show me, a close and "Hide tips about this"; plus the one "What's new" card after an update.
- [Toast](https://vyre.run/docs/design/system/components/toast.md): The one undo toast, 4 s, that follows every optimistic answer, removal or reset, in the row's place or floating above Lumen.
- [Tool row](https://vyre.run/docs/design/system/components/tool-row.md): One quiet line per tool call, with an icon, a verb, a mono summary and a running timer, folding runs of calls and opening to their detail.
- [Top bar](https://vyre.run/docs/design/system/components/top-bar.md): The 56 px bar over every desktop page, with the page title on the left, the command bar in the centre and one right slot.
- [Turn](https://vyre.run/docs/design/system/components/turn.md): One exchange in a session transcript, with your bubble, the agent's author line and prose, the thinking row, the steer marker and the turn footer.
- [Vyre mark](https://vyre.run/docs/design/system/components/vyre-mark.md): The Vyre wire drawn as a glass tube ending in a bead of light, with four states: static, intro, working, done.

## Status

- [Roadmap](https://vyre.run/docs/roadmap.md): Where Vyre is going, line by line, with what each release contains.
- [Known gaps](https://vyre.run/docs/known-gaps.md): What Vyre 0.5 does not do yet, what to do today instead, and what comes next.
- [Changelog](https://vyre.run/docs/changelog.md): Every change to Vyre, newest first, in plain sentences that say why.

## Project

- [Architecture: the front door](https://vyre.run/docs/project/ARCHITECTURE.md): How Vyre is built on one page: what it is, the layers, and a table of contents into every architecture page.
- [Development rules](https://vyre.run/docs/project/DEVELOPMENT-RULES.md): The rules every change to Vyre follows: how it is built, tested, reviewed and released.

## Roadmap plans

- [Roadmap by version](https://vyre.run/docs/roadmap/README.md): How each planned version gets its branch and its plan.
- [Plan for 0.5.1](https://vyre.run/docs/roadmap/0.5.1.md): What version 0.5.1 sets out to do, with the acceptance test for each item.
- [Plan for 0.5.2](https://vyre.run/docs/roadmap/0.5.2.md): What version 0.5.2 sets out to do, with the acceptance test for each item.