# Wayland Documentation

> Docs for the Wayland desktop command center and the Wayland Core engine.

- [Agents](https://docs.getwayland.com/concepts/agents/): Agent definitions, local versus remote, and how they relate to assistants and the engine.
- [Architecture Overview](https://docs.getwayland.com/concepts/architecture/): How the engine loop, providers, tools, MCP, sessions, memory, and the desktop wrap together.
- [Assistants](https://docs.getwayland.com/concepts/assistants/): What an assistant is, the built-in library, and how presets and intents fit together.
- [Channels](https://docs.getwayland.com/concepts/channels/): What channels are, the 25 built-ins, and the three-tier model.
- [Context Compression](https://docs.getwayland.com/concepts/compression/): How Wayland keeps long sessions within the token budget.
- [The Constitution](https://docs.getwayland.com/concepts/constitution/): The always-loaded rules document, specialist overlays, and how edits take effect.
- [Self-Improvement (wcore-evolve)](https://docs.getwayland.com/concepts/evolution/): How skills improve over generations, and the scoring trust boundary that keeps it honest.
- [MCP](https://docs.getwayland.com/concepts/mcp/): The Model Context Protocol client, its transports, and how external tools join the agent.
- [Memory and the Wiki](https://docs.getwayland.com/concepts/memory/): Persistent per-project memory, the IJFW backbone, and the in-app knowledge wiki.
- [Models, Providers, and Profiles](https://docs.getwayland.com/concepts/models-providers/): The provider catalog, the engine-native five, and how profiles switch configurations.
- [Permissions and Sandboxing](https://docs.getwayland.com/concepts/permissions-sandbox/): How tool calls are gated and how sandboxes isolate model-driven work.
- [Projects and Workspaces](https://docs.getwayland.com/concepts/projects/): Projects as scoped working contexts, and how they map to the engine's project directory.
- [Remote Access and WebUI](https://docs.getwayland.com/concepts/remote-webui/): Reaching your desktop agent from a browser or phone, and how devices are paired.
- [Skills](https://docs.getwayland.com/concepts/skills/): Named prompt snippets with variables, shell expansion, and conditional activation.
- [Teams and Standing Companies](https://docs.getwayland.com/concepts/teams/): Multi-agent teams, how they coordinate, and how an ad-hoc team becomes a Standing Company.
- [Tools and the Tool Registry](https://docs.getwayland.com/concepts/tools/): The eight built-in tools, concurrency rules, and how MCP and plan-mode tools join them.
- [Workflows (ForgeFlows)](https://docs.getwayland.com/concepts/workflows/): Declarative multi-stage agent pipelines, how they run, and how they surface.
- [ACP Server and Client](https://docs.getwayland.com/core/acp/): Serve and drive Wayland Core over the Agent Client Protocol with wayland-core acp serve and acp request.
- [Agents (agent command)](https://docs.getwayland.com/core/agents/): Create, list, and manage user-defined agents from the CLI, and run with a named agent.
- [Context and Output Compaction](https://docs.getwayland.com/core/compaction/): How Wayland Core keeps long sessions within budget, plus the flags and config that tune token usage.
- [Configuration](https://docs.getwayland.com/core/configuration/): The three-level cascading config, the TOML format, and the key sections that shape a run.
- [Cron Scheduler](https://docs.getwayland.com/core/cron/): Schedule recurring jobs from the CLI with wayland-core cron, targeting a slash command, a channel message, or a skill.
- [Doctor and Diagnostics](https://docs.getwayland.com/core/doctor/): Probe your environment, read the logs, and detect unclean shutdowns when Wayland Core misbehaves.
- [wcore-evolve (online evolution)](https://docs.getwayland.com/core/evolve/): Turn on online evolution so successful sessions improve the system prompt, and understand the loop behind it.
- [Hooks](https://docs.getwayland.com/core/hooks/): Run shell commands on tool lifecycle events to auto-format, lint, and audit.
- [Install and Update Wayland Core](https://docs.getwayland.com/core/install/): Install the standalone engine with npm or from source, and keep it current with self-update.
- [JSON Stream Protocol](https://docs.getwayland.com/core/json-stream/): The line-based JSON protocol that lets a host process drive Wayland Core over stdin and stdout.
- [MCP Client](https://docs.getwayland.com/core/mcp-client/): Connect the engine to Model Context Protocol servers over stdio, SSE, or streamable HTTP.
- [mcp-serve: Expose Tools as MCP](https://docs.getwayland.com/core/mcp-serve/): Serve the engine's tool registry as an MCP server so other clients can call Wayland Core's tools.
- [Memory System](https://docs.getwayland.com/core/memory/): Per-project persistent memory that carries facts and outcomes across sessions, and how to inspect it.
- [Wayland Core Overview](https://docs.getwayland.com/core/overview/): What the wayland-core engine is and its full capability surface.
- [Plan Mode](https://docs.getwayland.com/core/plan-mode/): A read-only mode where the engine explores the codebase and writes an implementation plan before changing anything.
- [Plugins and Marketplace](https://docs.getwayland.com/core/plugins/): Install, list, and remove plugins for Wayland Core from the local registry or a remote GitHub source.
- [Profiles](https://docs.getwayland.com/core/profiles/): Named profiles and extends inheritance for switching providers and models in one flag.
- [AGENTS.md and Project Context](https://docs.getwayland.com/core/project-context/): How Wayland Core finds and loads per-project instructions, and how to scaffold them with init.
- [Providers and Auth](https://docs.getwayland.com/core/providers-auth/): Configure and authenticate each engine-native provider: Anthropic, OpenAI and compatibles, Google Gemini, Bedrock, and Vertex AI.
- [Replay and VCR](https://docs.getwayland.com/core/replay/): Replay a recorded session trace deterministically and diff two traces to find where behavior diverged.
- [Sessions (save and resume)](https://docs.getwayland.com/core/sessions/): How Wayland Core persists conversations and how to resume, continue, or pin a session by ID.
- [Single-shot and REPL](https://docs.getwayland.com/core/single-shot-repl/): Run a one-shot prompt or the interactive terminal UI, and know when each fits.
- [Skills Lifecycle (audit, promote, archive)](https://docs.getwayland.com/core/skills-lifecycle/): Maintain the learned-skills library from the CLI with audit, promote, and archive.
- [Skills](https://docs.getwayland.com/core/skills/): Author and invoke skills: named prompt snippets with variables, shell expansion, and per-skill overrides.
- [Sub-Agents (Delegate)](https://docs.getwayland.com/core/sub-agents/): How the Delegate tool runs independent sub-agents in parallel and merges their results.
- [Swarm (worktree workers)](https://docs.getwayland.com/core/swarm/): Dispatch a set of worktree-isolated workers across a repository with wayland-core swarm.
- [Built-in Tools](https://docs.getwayland.com/core/tools/): Reference for the eight built-in tools the engine calls to read, write, search, and run commands.
- [Workflows (forgeflows CLI)](https://docs.getwayland.com/core/workflows/): Validate, list, and run saved RON ForgeFlows from the command line with wayland-core workflow.
- [Add a Cloud Model Provider](https://docs.getwayland.com/how-to/add-provider/): Connect credentials for any of the 32 providers in the desktop catalog.
- [Back Up and Sync (E2E Encrypted)](https://docs.getwayland.com/how-to/backup-sync/): Back up your Wayland data and turn on end-to-end encrypted sync across machines.
- [Build a Custom Agent](https://docs.getwayland.com/how-to/build-agent/): Create local and remote agents in the desktop, with the matching CLI commands.
- [Channels: BlueBubbles](https://docs.getwayland.com/how-to/channels/bluebubbles/): Connect iMessage through a BlueBubbles server to Wayland with a server URL and password.
- [Channels: DingTalk](https://docs.getwayland.com/how-to/channels/dingtalk/): Connect a DingTalk robot to Wayland with a client ID and client secret, plus an optional webhook secret.
- [Channels: Discord](https://docs.getwayland.com/how-to/channels/discord/): Connect a Discord bot to Wayland using a bot token and the Discord Gateway.
- [Channels: Email (AgentMail)](https://docs.getwayland.com/how-to/channels/email-agentmail/): Connect email to Wayland through AgentMail with an API key and a hosted inbox address.
- [Channels: Email (IMAP/SMTP)](https://docs.getwayland.com/how-to/channels/email-imap/): Connect your own mailbox to Wayland with IMAP for receiving and SMTP for sending.
- [Channels: Google Chat](https://docs.getwayland.com/how-to/channels/google-chat/): Connect Google Chat to Wayland with a service account and an audience value.
- [Channels: iMessage](https://docs.getwayland.com/how-to/channels/imessage/): Connect iMessage to Wayland on a Mac, with a polling interval and allowed handles.
- [Channels: IRC](https://docs.getwayland.com/how-to/channels/irc/): Connect Wayland to an IRC network with a server, nick, channels, and optional SASL.
- [Channels: Lark / Feishu](https://docs.getwayland.com/how-to/channels/lark/): Connect a Lark (Feishu) app to Wayland with an app ID, app secret, and event subscription.
- [Channels: LINE](https://docs.getwayland.com/how-to/channels/line/): Connect a LINE Messaging API channel to Wayland with a channel access token and secret.
- [Channels: Matrix](https://docs.getwayland.com/how-to/channels/matrix/): Connect a Matrix account to Wayland with a homeserver URL, user ID, and access token.
- [Channels: Mattermost](https://docs.getwayland.com/how-to/channels/mattermost/): Connect a Mattermost bot to Wayland with a server URL, access token, and team.
- [Channels: MS Teams](https://docs.getwayland.com/how-to/channels/ms-teams/): Connect a Microsoft Teams bot to Wayland with an app ID and app password.
- [Channels: Nextcloud Talk](https://docs.getwayland.com/how-to/channels/nextcloud-talk/): Connect Nextcloud Talk to Wayland with a server URL, username, and app password.
- [Channels: Nostr](https://docs.getwayland.com/how-to/channels/nostr/): Connect Nostr to Wayland with a private key and a set of relays.
- [Channels: Signal](https://docs.getwayland.com/how-to/channels/signal/): Connect Signal to Wayland through signal-cli, registered to a phone number.
- [Channels: Slack](https://docs.getwayland.com/how-to/channels/slack/): Connect a Slack app to Wayland with a bot token and either Socket Mode or the Events API.
- [Channels: SMS (Twilio)](https://docs.getwayland.com/how-to/channels/sms-twilio/): Connect Twilio SMS to Wayland with your Account SID, auth token, and a from-number.
- [Channels: Synology Chat](https://docs.getwayland.com/how-to/channels/synology-chat/): Connect Synology Chat to Wayland with incoming and outgoing webhook integrations.
- [Channels: Telegram](https://docs.getwayland.com/how-to/channels/telegram/): Connect a Telegram bot to Wayland so you can chat with an assistant from Telegram.
- [Channels: Twitch](https://docs.getwayland.com/how-to/channels/twitch/): Connect Twitch chat to Wayland with a bot account, OAuth token, and channels.
- [Channels: Webhook](https://docs.getwayland.com/how-to/channels/webhook/): Connect any system to Wayland with an inbound webhook URL and an outbound delivery URL.
- [Channels: WeChat](https://docs.getwayland.com/how-to/channels/wechat/): Connect WeChat to Wayland by scanning a QR code to log in an account.
- [Channels: WeCom](https://docs.getwayland.com/how-to/channels/wecom/): Connect WeCom (Work WeChat) to Wayland in WebSocket mode (bot ID and secret) or Webhook mode (corp ID, token, and encoding AES key).
- [Channels: WhatsApp](https://docs.getwayland.com/how-to/channels/whatsapp/): Connect WhatsApp to Wayland through a local bridge or the WhatsApp Cloud API.
- [Create a Custom Assistant](https://docs.getwayland.com/how-to/create-assistant/): Build a new assistant from the library or from scratch, attach skills, and launch it.
- [Edit the Constitution](https://docs.getwayland.com/how-to/edit-constitution/): Customize the always-loaded rules your assistants follow, and add specialist overlays.
- [Set Up Image Generation](https://docs.getwayland.com/how-to/image-generation/): Turn on the built-in image generation tool and connect an image-capable model.
- [Install and Configure MCP Servers](https://docs.getwayland.com/how-to/install-mcp/): Add MCP servers from the library or by hand to give your assistants more tools.
- [Use a Local Model](https://docs.getwayland.com/how-to/local-models/): Point Wayland at a local OpenAI-compatible server such as Ollama.
- [Build, Import, and Pin Skills](https://docs.getwayland.com/how-to/manage-skills/): Author, import, and organize skills in the desktop, and keep the library healthy.
- [Enable Remote Access and Pair a Device](https://docs.getwayland.com/how-to/remote-access/): Turn on the built-in WebUI and pair a phone or browser to reach your desktop agent.
- [Launch and Run a Team](https://docs.getwayland.com/how-to/run-team/): Pick a team, launch it, drive multi-agent work, and promote it to a Standing Company.
- [Run and Author Workflows](https://docs.getwayland.com/how-to/run-workflows/): Find, run, and build multi-stage workflows in the desktop.
- [Schedule Tasks (Cron)](https://docs.getwayland.com/how-to/schedule-tasks/): Create scheduled jobs in the desktop, and the matching cron commands in the engine.
- [Promote a Team to a Standing Company](https://docs.getwayland.com/how-to/standing-company/): Turn an ad-hoc team into a persistent Standing Company that stays ready between sessions.
- [Use Memory and the Wiki](https://docs.getwayland.com/how-to/use-memory/): Browse, search, and curate what Wayland remembers across sessions, plus the knowledge wiki.
- [Set Up Voice (STT and TTS)](https://docs.getwayland.com/how-to/voice/): Enable speech-to-text input and text-to-speech output in the desktop.
- [Wayland Documentation](https://docs.getwayland.com/): Everything you need to run the Wayland desktop command center and the Wayland Core engine.
- [Channel Matrix](https://docs.getwayland.com/reference/channel-matrix/): All 25 built-in channels by tier, with the credentials each one needs to connect.
- [CLI Flag Reference](https://docs.getwayland.com/reference/cli-flags/): Every top-level flag on the wayland-core command, with its short form and environment variable.
- [CLI Subcommand Reference](https://docs.getwayland.com/reference/cli-subcommands/): Every wayland-core subcommand and its sub-subcommands, verified against the engine source.
- [Config File Reference (TOML)](https://docs.getwayland.com/reference/config-toml/): Every section of the wayland-core config file, with keys and defaults verified against the engine.
- [Environment Variables](https://docs.getwayland.com/reference/env-vars/): Every environment variable the wayland-core engine reads, and how they rank against flags and config.
- [File and Directory Layout](https://docs.getwayland.com/reference/file-layout/): Where Wayland Core keeps its data on disk, by directory and platform.
- [Provider Catalog](https://docs.getwayland.com/reference/provider-catalog/): All 32 model providers in the Wayland desktop catalog, with the five that the engine runs natively.
- [Settings: About](https://docs.getwayland.com/reference/settings/about/): The About settings panel, showing the app version, update controls, and links to docs and support.
- [Settings: Agents](https://docs.getwayland.com/reference/settings/agents/): The Agents settings panel, which lists detected coding agents, remote agents, and the Flux Router roadmap item.
- [Settings: Assistants](https://docs.getwayland.com/reference/settings/assistants/): Every control on the Assistants settings panel, where you create, edit, and configure the assistants you launch.
- [Settings: Channels](https://docs.getwayland.com/reference/settings/channels/): The Channels settings panel, where you connect Wayland to messaging platforms grouped by tier.
- [Settings: Constitution](https://docs.getwayland.com/reference/settings/constitution/): The Constitution editor panel, where you edit Wayland's standing rules and manage specialist overlays.
- [Settings: Editor](https://docs.getwayland.com/reference/settings/editor/): The Editor settings panel, which controls how Markdown documents open, save, and render in Wayland.
- [Settings: General](https://docs.getwayland.com/reference/settings/general/): The General settings panel, covering language, startup behaviour, timeouts, notifications, and directory paths.
- [Settings: IJFW Memory](https://docs.getwayland.com/reference/settings/ijfw/): The IJFW Memory settings panel, where you opt out of automatic setup and find manual install steps.
- [Settings: Image Generation](https://docs.getwayland.com/reference/settings/images/): The Image Generation settings panel, which enables the built-in image-gen MCP server and picks its default model.
- [Settings: MCP Library](https://docs.getwayland.com/reference/settings/mcp-library/): The MCP Library settings panel, where you browse, install, and manage Model Context Protocol servers.
- [Settings: Models and Providers](https://docs.getwayland.com/reference/settings/models/): The Models and Providers settings panel, where you connect providers, manage credentials, and browse the model catalog.
- [Settings: Notifications](https://docs.getwayland.com/reference/settings/notifications/): The Notifications settings panel, which controls when and how Wayland alerts you.
- [Settings: Skills](https://docs.getwayland.com/reference/settings/skills/): The Skills settings panel, where you browse, filter, build, import, and pin the skills your agent can use.
- [Settings: Storage](https://docs.getwayland.com/reference/settings/storage/): The Storage settings panel, covering disk usage, directories, backup, encrypted sync, and reset.
- [Settings: Theme and Display](https://docs.getwayland.com/reference/settings/theme-display/): The Theme and Display settings panel, covering theme, density, the launchpad bar, and other appearance controls.
- [Settings: Voice](https://docs.getwayland.com/reference/settings/voice/): The Voice settings panel, covering speech-to-text and text-to-speech for the chat box.
- [Settings: Wayland Core](https://docs.getwayland.com/reference/settings/wcore/): The Wayland Core status panel, which reports the engine's availability, version, and binary path.
- [Settings: Remote / WebUI](https://docs.getwayland.com/reference/settings/webui/): The Remote and WebUI settings panel, where you start the web server, pair devices, and review the access log.
- [Keyboard Shortcuts](https://docs.getwayland.com/reference/shortcuts/): Keyboard controls for the Wayland desktop app and the engine REPL.
- [Built-in Tool Schemas](https://docs.getwayland.com/reference/tool-schemas/): Parameters and limits for the eight built-in tools the agent uses.
- [Contributing](https://docs.getwayland.com/resources/contributing/): How the Wayland Core engine is organized and what to know before contributing.
- [ForgeFlow (RON) Authoring Reference](https://docs.getwayland.com/resources/forgeflow-ron/): The RON ForgeFlow grammar - meta, schemas, phases and steps, agent fields, and data flow.
- [Glossary](https://docs.getwayland.com/resources/glossary/): Definitions for every Wayland and Wayland Core term used across these docs.
- [Plugin and Marketplace Authoring](https://docs.getwayland.com/resources/plugin-authoring/): Build, sign, and distribute Wayland Core plugins, and understand the marketplace index format.
- [Release Notes and Versioning](https://docs.getwayland.com/resources/releases/): How Wayland Core is versioned, released, signed, and how self-update verifies a build.
- [Skill Authoring Reference](https://docs.getwayland.com/resources/skill-authoring/): The SKILL.md format, variables, shell expansion, per-skill overrides, and load order.
- [Connect Your First Model](https://docs.getwayland.com/start/connect-model/): Add one provider so chat works, then pick a model for your conversations.
- [Desktop vs Core: Which Do I Use](https://docs.getwayland.com/start/desktop-vs-core/): When to reach for the Wayland desktop app and when to use the wayland-core CLI engine.
- [Your First Conversation](https://docs.getwayland.com/start/first-conversation/): Start a chat, send a message, approve a tool call, and see the agent do real work.
- [First Run and Onboarding](https://docs.getwayland.com/start/first-run/): Walk from a blank install to a working assistant on your first launch of Wayland.
- [Install Wayland Core (CLI)](https://docs.getwayland.com/start/install-core/): Install the standalone wayland-core engine with npm or build it from source.
- [Install the Desktop App](https://docs.getwayland.com/start/install-desktop/): Download and install the Wayland desktop app on macOS, Windows, or Linux.
- [What is Wayland](https://docs.getwayland.com/start/what-is-wayland/): An overview of the Wayland desktop command center and the Wayland Core engine, and who each is for.
- [Channel Connection Issues](https://docs.getwayland.com/troubleshooting/channels/): Fix channel failures: status stuck on idle, bad bot tokens or scopes, webhooks not received, and bridge runtime problems.
- [Wayland Core Troubleshooting](https://docs.getwayland.com/troubleshooting/core/): Diagnose and fix CLI failures: no provider detected, crashes, command timeouts, missing ripgrep, and where to find logs.
- [Desktop App Troubleshooting](https://docs.getwayland.com/troubleshooting/desktop/): Fixes for common desktop failures: the app will not launch, the engine binary is missing, the dashboard is blank, login loops, and a full reset.
- [FAQ](https://docs.getwayland.com/troubleshooting/faq/): The most common questions about Wayland and Wayland Core, answered.
- [MCP Server Issues](https://docs.getwayland.com/troubleshooting/mcp/): Diagnose and fix MCP server connection, startup, and tool-naming problems.
- [Provider and Auth Errors](https://docs.getwayland.com/troubleshooting/providers/): Fix authentication and provider-compatibility errors across Anthropic, OpenAI-compatible, Bedrock, and Vertex.
- [A Daily Briefing with Cron and Channels](https://docs.getwayland.com/tutorials/daily-briefing/): Build a briefing skill, schedule it to post to a channel each morning, and confirm the runner fires.
- [Stand Up a Software Engineering Team](https://docs.getwayland.com/tutorials/eng-team/): Launch an engineering team on a repository, run a task across specialists, review the activity log, and promote it to a Standing Company.
- [Author and Ship a ForgeFlow](https://docs.getwayland.com/tutorials/forgeflow/): Write a RON ForgeFlow, validate it from the CLI, run it, and build the same thing from the in-app modal.
- [Drive Wayland Core from a Node Host (JSON Stream)](https://docs.getwayland.com/tutorials/json-stream-host/): Spawn the engine from Node, exchange JSON-stream events over stdio, handle tool approvals, and shut down cleanly.
- [Build a Sales Outreach Assistant](https://docs.getwayland.com/tutorials/sales-assistant/): Start from the Sell intent, customize a cold-outbound assistant, connect a channel, and schedule a follow-up.
- [Run a Customer Support Channel Bot](https://docs.getwayland.com/tutorials/support-bot/): Wire a support assistant to a channel, route inbound messages, set notifications and quiet hours, and hand off when needed.