mirror of
https://github.com/jlengrand/Maestro.git
synced 2026-03-10 00:21:21 +00:00
docs: standardize Auto Run and Playbook terminology
Replace 'multi-document batch runs' and 'batch processing' terminology with 'Auto Run' (individual documents) and 'Playbook' (collections of Auto Run documents) across user-facing documentation. Preserves 'batch mode' references where they describe Claude Code's actual non-interactive operation mode.
This commit is contained in:
@@ -725,7 +725,7 @@ File-based document runner for automating multi-step tasks. Users configure a fo
|
||||
| `AutoRun.tsx` | Main panel showing current document with edit/preview modes |
|
||||
| `AutoRunSetupModal.tsx` | First-time setup for selecting the Runner Docs folder |
|
||||
| `AutoRunDocumentSelector.tsx` | Dropdown for switching between markdown documents |
|
||||
| `BatchRunnerModal.tsx` | Configuration modal for multi-document batch execution |
|
||||
| `BatchRunnerModal.tsx` | Configuration modal for running multiple Auto Run documents |
|
||||
| `PlaybookNameModal.tsx` | Modal for naming saved playbook configurations |
|
||||
| `PlaybookDeleteConfirmModal.tsx` | Confirmation modal for playbook deletion |
|
||||
| `useBatchProcessor.ts` | Hook managing batch execution logic |
|
||||
|
||||
@@ -45,7 +45,7 @@ This approach mirrors methodologies like [Spec-Kit](https://github.com/github/sp
|
||||
| **Command Terminal** | A PTY shell for running commands directly. Tab completion for files, git branches, and command history. |
|
||||
| **Session Explorer** | Browse all past sessions for an agent. Star, rename, search, and resume any previous conversation. |
|
||||
| **Auto Run** | Automated task runner that processes markdown checklists. Spawns a fresh session per task. |
|
||||
| **Playbook** | A saved Auto Run configuration with document order, options, and settings for repeatable batch workflows. |
|
||||
| **Playbook** | A saved collection of Auto Run documents with document order, options, and settings for repeatable workflows. |
|
||||
| **History** | Timestamped log of all actions (user commands, AI responses, Auto Run completions) with session links. |
|
||||
| **Remote Control** | Web interface for mobile access. Local network or remote via Cloudflare tunnel. |
|
||||
| **CLI** | Headless command-line tool for scripting, automation, and CI/CD integration. |
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
---
|
||||
title: Auto Run + Playbooks
|
||||
description: Batch-process markdown checklists with AI agents using Auto Run and reusable Playbooks.
|
||||
description: Process markdown checklists with AI agents using Auto Run documents and reusable Playbooks.
|
||||
icon: play
|
||||
---
|
||||
|
||||
Auto Run is a file-system-based document runner that lets you batch-process tasks using AI agents. Select a folder containing markdown documents with task checkboxes, and Maestro will work through them one by one, spawning a fresh AI session for each task.
|
||||
Auto Run is a file-system-based document runner that lets you process tasks using AI agents. Select a folder containing markdown documents with task checkboxes, and Maestro will work through them one by one, spawning a fresh AI session for each task.
|
||||
|
||||

|
||||
|
||||
@@ -34,22 +34,22 @@ Use markdown checkboxes in your documents:
|
||||
2. Click the **Run** button (or the ▶ icon)
|
||||
3. Customize the agent prompt if needed, then click **Go**
|
||||
|
||||
## Multi-Document Batch Runs
|
||||
## Running Multiple Auto Run Documents
|
||||
|
||||
Auto Run supports running multiple documents in sequence:
|
||||
|
||||
1. Click **Run** to open the Batch Runner Modal
|
||||
1. Click **Run** to open the Auto Run configuration modal
|
||||
2. Click **+ Add Docs** to add more documents to the queue
|
||||
3. Drag to reorder documents as needed
|
||||
4. Configure options per document:
|
||||
- **Reset on Completion** - Creates a working copy in `Runs/` subfolder instead of modifying the original. The original document is never touched, and working copies (e.g., `TASK-1735192800000-loop-1.md`) serve as audit logs.
|
||||
- **Duplicate** - Add the same document multiple times
|
||||
5. Enable **Loop Mode** to cycle back to the first document after completing the last
|
||||
6. Click **Go** to start the batch run
|
||||
6. Click **Go** to start running documents
|
||||
|
||||
## Playbooks
|
||||
|
||||
Save your batch configurations for reuse:
|
||||
Save your Auto Run configurations as Playbooks for reuse:
|
||||
|
||||
1. Configure your documents, order, and options
|
||||
2. Click **Save as Playbook** and enter a name
|
||||
@@ -140,7 +140,7 @@ For editing complex Auto Run documents, use the **Expanded Editor** — a fullsc
|
||||
The Expanded Editor provides:
|
||||
- **Edit/Preview toggle** — Switch between editing markdown and previewing rendered output
|
||||
- **Document selector** — Switch between documents without closing the modal
|
||||
- **Run controls** — Start, stop, and monitor batch runs from the expanded view
|
||||
- **Run controls** — Start, stop, and monitor Auto Run progress from the expanded view
|
||||
- **Task progress** — See "X of Y tasks completed" and token count at the bottom
|
||||
- **Full toolbar** — Create new documents, refresh, and open folder
|
||||
|
||||
|
||||
@@ -124,7 +124,7 @@ Maestro can prevent your computer from sleeping while AI agents are actively wor
|
||||
|
||||
Sleep prevention automatically activates when:
|
||||
- Any session is **busy** (agent processing a request)
|
||||
- **Auto Run** is active (batch processing tasks)
|
||||
- **Auto Run** is active (processing tasks)
|
||||
- **Group Chat** is in progress (moderator or agents responding)
|
||||
|
||||
When all activity stops, sleep prevention deactivates automatically.
|
||||
|
||||
@@ -7,7 +7,7 @@ icon: sparkles
|
||||
## Power Features
|
||||
|
||||
- 🌳 **[Git Worktrees](./git-worktrees)** - Run AI agents in parallel on isolated branches. Create worktree sub-agents from the git branch menu, each operating in their own directory. Work interactively in the main repo while sub-agents process tasks independently — then create PRs with one click. True parallel development without conflicts.
|
||||
- 🤖 **[Auto Run & Playbooks](./autorun-playbooks)** - File-system-based task runner that batch-processes markdown checklists through AI agents. Create playbooks for repeatable workflows, run in loops, and track progress with full history. Each task gets its own AI session for clean conversation context.
|
||||
- 🤖 **[Auto Run & Playbooks](./autorun-playbooks)** - File-system-based task runner that processes markdown checklists through AI agents. Create Playbooks (collections of Auto Run documents) for repeatable workflows, run in loops, and track progress with full history. Each task gets its own AI session for clean conversation context.
|
||||
- 🏪 **[Playbook Exchange](./playbook-exchange)** - Browse and import community-contributed playbooks directly into your Auto Run folder. Categories, search, and one-click import get you started with proven workflows for security audits, code reviews, documentation, and more.
|
||||
- 🎵 **[Maestro Symphony](./symphony)** - Contribute to open source by donating AI tokens. Browse registered projects, select GitHub issues, and let Maestro clone, process Auto Run docs, and create PRs automatically. Distributed computing for AI-assisted development.
|
||||
- 💬 **[Group Chat](./group-chat)** - Coordinate multiple AI agents in a single conversation. A moderator AI orchestrates discussions, routing questions to the right agents and synthesizing their responses for cross-project questions and architecture discussions.
|
||||
|
||||
@@ -32,7 +32,7 @@ The Wizard creates a fully configured agent with an Auto Run document folder rea
|
||||
|
||||
After completing the Wizard, you'll be offered an **Introductory Tour** that highlights key UI elements:
|
||||
- The AI Terminal and how to interact with it
|
||||
- The Auto Run panel and how batch processing works
|
||||
- The Auto Run panel and how document processing works
|
||||
- File Explorer and preview features
|
||||
- Keyboard shortcuts for power users
|
||||
|
||||
|
||||
@@ -101,7 +101,7 @@ The **Validated** flag helps you track which Auto Run tasks have been human-revi
|
||||
|
||||
Validated entries show a **checkmark icon** (✓✓) in the list view, making it easy to see at a glance which tasks have been reviewed.
|
||||
|
||||
**Workflow tip:** After an Auto Run batch completes, use the History panel to review each task:
|
||||
**Workflow tip:** After an Auto Run session completes, use the History panel to review each task:
|
||||
1. Open the first AUTO entry
|
||||
2. Click **RESUME** to jump to the session and verify the work
|
||||
3. If satisfied, toggle **VALIDATED**
|
||||
|
||||
@@ -40,7 +40,7 @@ The **Process Monitor** displays a hierarchical tree view:
|
||||
|------|-------------|
|
||||
| AI Agent | Main Claude Code (or other agent) process |
|
||||
| Terminal | Shell process for the session |
|
||||
| Batch | Auto Run batch processing agent |
|
||||
| Batch | Auto Run document processing agent |
|
||||
| Synopsis | Context compaction synopsis generation |
|
||||
| Moderator | Group chat moderator process |
|
||||
| Participant | Group chat participant agent |
|
||||
|
||||
@@ -90,7 +90,7 @@ The Activity tab shows your usage patterns over time:
|
||||
The Auto Run tab focuses specifically on automated playbook execution:
|
||||
|
||||
**Metric Cards:**
|
||||
- **Total Sessions** — Number of Auto Run batch sessions
|
||||
- **Total Sessions** — Number of Auto Run sessions
|
||||
- **Tasks Done** — Total tasks completed (with attempted count)
|
||||
- **Avg Tasks/Session** — Average tasks completed per Auto Run session
|
||||
- **Success Rate** — Percentage of tasks that completed successfully
|
||||
|
||||
@@ -23,9 +23,11 @@ You may READ files from anywhere to understand the project:
|
||||
|
||||
This restriction ensures the wizard can safely run in parallel with other AI operations without file conflicts.
|
||||
|
||||
## Auto-run Documents
|
||||
## Auto Run Documents
|
||||
|
||||
When creating Playbooks, generate detailed multi-document Markdown implementation plans in the `{{AUTORUN_FOLDER}}` folder. Use the format `$PREFIX-X.md`, where `X` is the phase number and `$PREFIX` is the effort name. Break phases by relevant context; do not mix unrelated task results in the same document. Each task must be written as `- [ ] ...` so auto-run can execute and check them off with comments on completion. Be deliberate about document count and task granularity.
|
||||
When creating Playbooks (which are collections of Auto Run documents), generate detailed Markdown implementation plans in the `{{AUTORUN_FOLDER}}` folder. Use the format `$PREFIX-XX.md`, where `XX` is the two-digit phase number (01, 02, etc.) and `$PREFIX` is the effort name. Always zero-pad phase numbers to ensure correct lexicographic sorting. Break phases by relevant context; do not mix unrelated task results in the same document. Each task must be written as `- [ ] ...` so Auto Run can execute and check them off with comments on completion. Be deliberate about document count and task granularity.
|
||||
|
||||
**Multi-phase efforts:** When creating 3 or more phase documents for a single effort, place them in a dedicated subdirectory prefixed with today's date (e.g., `{{AUTORUN_FOLDER}}/YYYY-MM-DD-Feature-Name/FEATURE-NAME-01.md`). This allows users to add the entire folder at once and keeps related documents organized with a clear creation date.
|
||||
|
||||
### Structured Output Artifacts
|
||||
|
||||
|
||||
Reference in New Issue
Block a user