Guide
Choose Your Usage Path
The documentation now has beginner, detailed-learning, and operations tracks. Start with Quickstart, then use Learning Path and module guides for depth.
Quickstart (10 min)
From install to first ask/chat in the shortest reliable path.
Learning Path
Detailed stage-by-stage tutorial from basic to advanced.
Open Learning PathModels & Profiles
Setup multiple providers, aliases, fallback chains, and safer profile patches.
Open Models & ProfilesSessions Lifecycle
Create, inspect, resume, and clear reusable ask/chat sessions.
Open Sessions GuideTUI Guide
Chat-first fullscreen terminal UI with sessions pane and live inspector.
Open TUI GuidePolicy Baseline
Apply approvals and sandbox rules with command-level safety checks.
Open Policy GuideAzure Ops Playbook
One complete scriptable runbook: Azure profile, channels, gateway, policy, and regression gate.
Open Azure PlaybookAgents Module
Dedicated step-by-step guide for agents and route control.
Channels Module
Terminal/Slack/Telegram channel operations and reliability checks.
Open Channels GuideGateway Call API
Detailed gateway call contract and automation usage.
Operations
Production-oriented runbook: channels, gateway, policy, diagnostics, and regression checks.
Open OperationsRegression Guide
From beginner checks to release gate with scripted regression flows.
Open Regression GuidePath A: Quickstart
Use this if you are setting up Mosaic for the first time or validating a new machine.
- Install and verify
mosaic --help. - Run
setupwith one profile. - Validate with
models listandhealth. - Run
askandchat.
Path B: Operations
Use this after quickstart when you need channels, gateway control, policy enforcement, and team-level diagnostics.
- Add and test delivery channels.
- Operate gateway lifecycle and probe status.
- Apply approvals + sandbox policy.
- Use
status/health/doctor/logs/dashboardfor day-2 operations.
Path C: Detailed progression + modules
Use this when you want full learning depth and module-specific walkthroughs.
- Follow Learning Path stage by stage.
- Use Models & Profiles to lock model routing and profile hygiene.
- Use Sessions Guide for reproducible conversation state control.
- Use TUI Guide when you need a chat-first terminal UI with inspector and shortcut workflow.
- Use Policy Guide for approvals/sandbox safety baseline.
- Use Azure Ops Playbook to run a full production baseline in one sequence.
- Use Agents Guide for full agents workflow.
- Use module guides for Channels, Memory, Knowledge, Plugins, Skills, Gateway, and Gateway Call API.
Suggested order
- Finish Quickstart.
- Follow Learning Path to build depth.
- Complete Agents Guide for agent routing mastery.
- Set up real channel + gateway in Operations.
- Run release checks from Regression Guide.
- Keep Troubleshooting as runbook fallback.