Overview
Mosaic CLI Documentation
Mosaic is a Rust-first local agent runtime and operations CLI. This documentation is structured for fast setup, profile configuration, and production diagnosis.
Scope: CLI-first delivery. Web and desktop shells are out of this phase.
Current command scope
- Core:
setup,configure,models,ask,chat,tui,session - Operations:
status,health,doctor,logs,system - Runtime:
channels,gateway,approvals,sandbox,memory,knowledge,security
First 4 commands
mosaic --project-state setup \
--base-url https://api.openai.com \
--api-key-env OPENAI_API_KEY \
--model gpt-4o-mini
mosaic --project-state models list
mosaic --project-state ask "hello"
mosaic --project-state chat
mosaic --project-state tui
Reading map
Quickstart
10-minute path to first successful ask/chat run.
Open QuickstartLearning Path
Detailed progression from beginner to advanced.
Open Learning PathAgents Guide
Step-by-step tutorial for the agents module and routing.
Open Agents GuideOperations
Runbook for channels, gateway, policy, and diagnostics.
Open OperationsModule Deep Dives
- Azure Ops Playbook: one complete production baseline run with Azure profile.
- Models & Profiles: multi-profile setup and model routing strategy.
- Sessions Guide: create/resume/clear conversation sessions.
- TUI Guide: full-screen terminal UI, shortcuts, and non-interactive contract.
- Policy Guide: approvals + sandbox baseline.
- Agents Guide: custom agents and route control.
- Channels Guide: terminal/slack/telegram operations.
- Memory Guide: index/search/clear lifecycle.
- Knowledge Guide: ingest local/http/mcp docs and ask with references.
- Plugins Guide: install/check/run/enable/disable.
- Skills Guide: install/check/info/remove.
- Gateway Guide: lifecycle and call interface.
- Gateway Call API: JSON contract and automation usage.
- Regression Guide: zero-to-release verification flow.