Skip to content

User Guide

This page is now an index. The full user guide has been split into focused chapters under Guide → User Guide. External links to USER_GUIDE are preserved — pick the chapter you want below.

Language: 中文版

Where Did the Content Go?

The previous monolithic USER_GUIDE has been broken up into smaller, dedicated chapters so each feature has its own page. Use the table below to find what you're looking for.

Getting Started

Old sectionNew page
Getting StartedGetting Started
Login & RegistrationLogin & Registration
Choose a Session BackendChoose a Backend (NEW)

Chat & Conversation Modes

Old sectionNew page
Chat Mode (Claude Code)Chat (Claude Code)
Copilot ModeCopilot Mode (NEW)
Yeaft SessionsYeaft Sessions (NEW)
Crew ModeCrew (Multi-Role)
Expert PanelExpert Panel
Split ScreenSplit Screen

Tools & Workspace

Old sectionNew page
Workbench (Terminal/Files/Git)Workbench
SettingsSettings
Keyboard ShortcutsShortcuts
Sidebar / Session Listcovered in Chat (Claude Code)

Agent & Deployment

Old sectionNew page
Agent Installation & ConnectionAgent Installation
Agent CLI ReferenceAgent CLI

Technical Reference

For the technical implementation (provider system, Yeaft engine, wire protocol, etc.), see Guide → Technical.

Why the Restructure?

The old single-page guide was getting too long to maintain and was missing entire features:

  1. Copilot CLI backend (via ACP) has been a first-class chat provider for months — it wasn't in the guide
  2. Yeaft Sessions (multi-VP parallel collaboration) is the current main dev direction — wasn't documented
  3. Splitting per feature lets each page link straight to the relevant component without overwhelming a new reader

If you bookmarked a section anchor on this page, the equivalent content lives on the linked chapter — the URLs above are stable going forward.

Released under the MIT License.