This directory is the user-facing product documentation set. It complements the root release README with task-oriented guides.
quickstart.md- install, configure, run, and open the Web UI.use-cases.md- task-oriented recipes for common goals.gateway.md- gateway lifecycle, host/port, safety, and status.configuration.md- provider, router, search, channel, memory, and permission configuration.cli.md- command groups and common CLI workflows.tui.md- terminal chat usage, slash commands, files, sessions, and the development-only OpenTUI client.web-ui.md- local control console and chat UI.sessions.md- session continuity, export, resume, abort, and cleanup.goal-mode.md- persistent multi-turn Goals, progress, guardrails, pause/resume, and Plan-mode interaction.glossary.md- user-facing terminology.
features.md- capability catalog.features/squilla-router.md- model routing.features/tui-frontend.md- terminal backend architecture, plugin slots, Router HUD, and OpenTUI validation.features/tui-product-contract.md- TUI, Web UI, Gateway, standalone, fallback, and legacy ownership rules.features/tool-compression.md- compact tool results and handles.features/meta-skills.md- reusable workflow skills.features/meta-skill-user-guide.md- user-facing MetaSkill guide.authoring/meta-skills.md- MetaSkill authoring guide.features/memory.md- durable memory and recall.features/skills.md- skill discovery, install, and authoring.features/compaction-and-cache.md- long-session compaction and prompt-cache continuity.goal-mode.md- durable session Goals and safe automatic continuation.
releases/0.5.4.md- OpenSquilla 0.5.4 release notes.releases/0.5.3.md- OpenSquilla 0.5.3 release notes.releases/0.5.2.md- OpenSquilla 0.5.2 release notes.releases/0.5.1.md- OpenSquilla 0.5.1 release notes.releases/0.5.0.md- OpenSquilla 0.5.0 release notes.releases/0.5.0rc3.md- OpenSquilla 0.5.0 Preview 3 release notes.releases/0.5.0rc2.md- OpenSquilla 0.5.0 Preview 2 release notes.releases/0.5.0rc1.md- OpenSquilla 0.5.0 Preview 1 release notes.releases/0.4.1.md- OpenSquilla 0.4.1 release notes.releases/0.4.0.md- OpenSquilla 0.4.0 release notes.releases/0.3.0.md- OpenSquilla 0.3.0 release notes.channels.md- supported messaging channels and setup flow.providers-and-models.md- LLM provider catalog, model selection, and runtime-backed model inspection.search.md- web search providers and query workflow.artifacts-and-media.md- artifacts, generated files, images, PDF, and TTS.tools-and-sandbox.md- built-in tools, approvals, sandbox posture, and write policy.sandbox-security.md- Safe and Full execution modes, guest isolation, policy behavior, bundled runtimes, and upgrade compatibility.approvals-and-permissions.md- permission profiles, approval commands, workspace containment, and sandbox posture.agents.md- durable named agents and workspace defaults.scheduling.md- recurring and one-time scheduled work.mcp-server.md- MCP server bridge for MCP-capable clients.usage-and-cost.md- token usage, estimated cost, and cost investigation workflow.diagnostics-and-replay.md- diagnostics, raw capture guidance, read-only turn replay, and developer replay benchmarks.tui-real-terminal-harness.md- maintainer real-terminal TUI integration harness and evidence capture.docker.md- Docker/Compose deployment on home servers and NAS: prebuilt GHCR images, LAN exposure with token auth, and upgrades.operations.md- sessions, cron, usage, diagnostics, migration, MCP server, and install inventory commands.troubleshooting.md- common install/runtime issues.glossary.md- short definitions for product terms.
Documentation improvements are welcome. Start with
contributing-docs.md for docs-specific guidance, then
open a small pull request against main.
Fast paths:
- Report a stale command, broken link, or confusing page with the documentation issue template.
- Edit the affected Markdown page on GitHub and open a focused pull request
against
main. - For new feature documentation, keep independent features on independent pages
under
docs/features/.
OpenSquilla documentation should help users run the product first, then understand its special advantages. Mechanism-heavy runtime detail belongs in developer design notes or source comments, not in the first-run path.
Product guide · 中文 · 日本語 · Français · Deutsch · Español · Improve these docs · Report a docs issue · Contributing