mirror of
https://github.com/dohooo/helmor.git
synced 2026-09-22 16:40:02 +08:00
7c3ad97c71
docs: add user guide
2.4 KiB
2.4 KiB
Helmor User Guide
Helmor is a local-first desktop app for running many coding agents in parallel, each in its own isolated git workspace — with everything you need to review, test, and ship their work in one window.
New here? Start with the Introduction, then follow Your first workspace.
Get Started
| Page | What it covers |
|---|---|
| Introduction | What Helmor is, the core ideas, and a tour of the window |
| Install | Download, first-launch setup, updates, and the CLI |
| Your first workspace | From adding a repository to merging your first agent-written PR |
| Configure your project | helmor.json: setup, run, and archive scripts; repository settings |
Concepts
| Page | What it covers |
|---|---|
| Workspaces | Git worktrees, workspace modes, lifecycle, archive and restore |
| Agents & models | Claude Code, Codex, Cursor, OpenCode — auth, models, effort, modes |
| Sessions | Session tabs, streaming, steering, queueing, context usage |
| Parallel agents | Running many workspaces at once without losing the thread |
| Stacked PRs | Building dependent changes as a stack of workspaces |
Reference
| Page | What it covers |
|---|---|
| Composer | Everything the prompt input can do |
| Review & ship | The inspector: changes, diffs, git actions, terminals, run scripts |
| Editor | The built-in Monaco file editor |
| Settings | Every settings panel, explained |
| Keyboard shortcuts | The full shortcut map |
| CLI & MCP | Driving Helmor from the terminal or from other agents |
Security
| Page | What it covers |
|---|---|
| Privacy | What stays local, what leaves your machine, and where data lives |
Troubleshooting
| Page | What it covers |
|---|---|
| FAQ | Short answers to common questions |
| Troubleshooting | Logs, auth issues, sync conflicts, and recovery steps |