# Localix documentation Localix brings agent conversations, source files, terminals, previews, and workbenches into one workspace. Start with setup and a first session, follow a recipe for a concrete task, or use the reference below to find a feature's controls and limits. ## Start here 1. [Understand Localix](getting-started/what-is-localix.md) — workspace concepts and supported workflows. 2. [Run Localix](getting-started/installation.md) — desktop prerequisites, browser development, and local builds. 3. [Start your first session](getting-started/first-session.md) — connect a provider, open a project, and make a change. Read [Privacy](getting-started/privacy.md) to understand data storage and outbound requests. Use [Troubleshooting](getting-started/troubleshooting.md) when setup or a run fails. ## Find a task | I want to… | Read | | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------- | | Work in parallel | [Subagents](features/delegation.md) · [Agents](features/agents.md) | | Control what enters the next request | [Workspace context](features/workspace.md#explicit-and-automatic-context) · [Checkpoints](features/context-checkpoints.md) | | Review actions before they run | [Permission modes](features/permission-modes.md) · [Permission rules](features/permissions.md) | | Choose a provider or model | [Providers](features/providers.md) | | Run models on this computer | [Local models](features/local-models.md) · [Semantic search](features/semantic-search.md) | | Wait for CI or repeat a prompt | [Monitors](features/monitors.md) · [Loops](features/loops.md) | | Add a tool or workbench | [Build with the agent](extending/build-with-the-agent.md) · [Mini app authoring](extending/mini-apps.md) | | Change Localix itself | [Contributing](internals/contributing.md) · [Code map](internals/code-map.md) | ## Recipes Each recipe walks through one task from setup to a visible result. | Recipe | Result | | --------------------------------------------------------------------------- | ----------------------------------------------------- | | [Fix a UI bug by pointing at it](recipes/fix-a-ui-bug-by-pointing-at-it.md) | Attach element context from the preview to a message. | | [Bring your own agent CLI](recipes/bring-your-own-agent-cli.md) | Run a supported external coding agent in Localix. | | [Drive an interactive program](recipes/drive-interactive-terminal.md) | Send PTY input and wait for rendered terminal output. | ## Feature reference ### Core | Guide | Covers | | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------- | | [Decide what an agent may do](features/capabilities.md) | Choose the tools, skills, plugins, and MCP access an agent holds. | | [Agent presets](features/agents.md) | Edit shipped roles, instructions, context, and turn limits. | | [Forks](features/delegation.md) | Continue an agent in a child session and receive its reports. | | [Choose how much the agent asks](features/permission-modes.md) | Choose Default, Plan, Bypass, or Autonomous for a conversation. | | [Permission rules](features/permissions.md) | Write ordered allow, ask, and deny rules. | | [Let the agent propose configuration changes](features/configure.md) | Review an agent’s proposal to enable a missing capability. | | [Organize work with projects and sessions](features/sessions-and-projects.md) | Organize projects, sessions, branches, drafts, and attachments. | | [Read conversation activity](features/conversation-history.md) | Inspect messages, tool activity, and navigation through a transcript. | | [Give the agent files and images](features/attachments.md) | Attach uploads or original paths and understand model-facing previews. | | [Answer formatting](features/answer-formatting.md) | Use supported Markdown, structured content, links, and deliverables. | | [Respond to human-in-the-loop requests](features/hitl.md) | Answer questions, quizzes, and confirmation requests. | | [Background work](features/background-work.md) | Follow forks, jobs, and unattended work. | | [Let an agent interact with a terminal](features/interactive-terminals.md) | Let an agent send input to a terminal and inspect its screen. | | [Wait for something to happen](features/monitors.md) | Wait for a command or plugin event to wake a session. | | [Repeat work on a schedule](features/loops.md) | Repeat prompts while the Localix runtime is running. | ### Workspace | Guide | Covers | | ----------------------------------------------------------------- | ------------------------------------------------------------------ | | [Use the workspace](features/workspace.md) | Arrange panels and inspect explicit and automatic message context. | | [Native workspace tabs](features/native-workspace-tabs.md) | Manage native windows, tabs, and workspace restoration. | | [Mini apps](features/mini-apps.md) | See, switch on, configure and create mini apps with `/mini-app`. | | [Mini apps as Mac apps](features/mini-app-mac-apps.md) | Install a mini app with a screen as its own macOS app. | | [External agent sessions](features/external-agents.md) | Link supported external coding-agent sessions. | | [Settings](features/settings.md) | Find application, project, provider, and capability settings. | | [Keyboard shortcuts](features/keyboard-shortcuts.md) | Find keyboard actions and their focus boundaries. | | [Annotate a live preview](features/visual-feedback.md) | Attach source-mapped element feedback from a live preview. | | [Use language server features](features/lsp.md) | Use diagnostics and language-server features. | | [Track model usage and estimated cost](features/cost-tracking.md) | Inspect model usage and estimated request cost. | | [Run models on this computer](features/local-models.md) | Download Gemma 4 and other open models sized for this computer. | | [Search by meaning](features/semantic-search.md) | Find chats, skills, plugins, MCP servers and agents by meaning. | | [Manage notifications](features/notifications.md) | Configure notifications and review recorded events. | | [Use Localix from the command line](features/cli.md) | Open a project or file through the desktop shell launcher. | ### Models & context | Guide | Covers | | ---------------------------------------------------------------------------- | ---------------------------------------------------------- | | [Connect model providers](features/providers.md) | Connect providers and route models to different workloads. | | [Keep a long session in the request budget](features/context-checkpoints.md) | Keep long sessions within the request budget. | | [Know the tool roster](features/tools.md) | Inspect live, deferred, and withheld tools. | | [Manage the tool budget](features/tool-budget.md) | Understand schema estimates and the backend usage report. | ### Memory & skills | Guide | Covers | | ---------------------------------------------------------- | ------------------------------------------------- | | [Carry context into later work](features/learning-loop.md) | Use memory, session recall, and memory providers. | | [Reuse procedures with skills](features/skills.md) | Load, pin, and reuse procedures. | ### Integrations | Guide | Covers | | -------------------------------------------------------------- | ------------------------------------------------------------- | | [Connect MCP servers](features/mcp.md) | Connect external tool servers and inspect their availability. | | [Use hooks and slash commands](features/hooks-and-commands.md) | Use lifecycle hooks and slash commands. | | [Execution environments](features/execution-environments.md) | Understand how tools run on the local machine. | | [Manage credentials with Vault](features/secrets.md) | Store vault credentials and use secret interpolation. | | [Send messages into a session](features/webhook.md) | Push an external message into a session. | ## Extending Localix | Guide | Covers | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | | [Build a mini app](extending/mini-apps.md) | Write a mini app's manifest and backend, and see the APIs it gets. | | [Install Claude Code plugins](extending/claude-code-plugins.md) | Install a Claude Code plugin as it is and see what runs. | | [Build a mini app with the agent](extending/build-with-the-agent.md) | Describe a mini app and review the agent’s build result. | | [Build workbench UI](extending/mini-app-ui.md) | Build a workbench interface against the host bridge. | | [Build a sandboxed HTML view](extending/sandboxed-views.md) | Use the iframe bridge, scoped backend actions, and scratch state. | | [Mini app synchronization](extending/mini-app-sync.md) | Synchronize mini app resources and live views. | | [Keyboard ownership](extending/keyboard-ownership.md) | Keep mini app shortcuts within their focus and ownership boundaries. | | [Report mini app failures](extending/mini-app-problems.md) | Report mini app failures through the host’s problem surfaces. | | [The UI kit](extending/ui-kit.md) | Use shared components, tokens, and supported import paths. | | [Wake a session from a mini app](extending/mini-app-wakes.md) | Wake a session from a mini app event. | | [Semantic index and change feed](extending/mini-app-semantics.md) | Index a mini app's items by meaning and follow its own changes. | | [Validate mini app route requests](extending/mini-app-routes.md) | Validate mini app HTTP request contracts. | | [Author a skill](extending/skills-authoring.md) | Write SKILL.md procedures and supporting resources. | | [Shared Markdown](extending/markdown.md) | Use the shared Markdown renderer and interactive components. | ## Contributor references The public contributor guides cover setup and architecture. Repository-only notes provide source ownership and contracts for work on a particular subsystem. | Guide | Covers | | ------------------------------------------------- | ---------------------------------------------------------------- | | [Architecture](internals/architecture.md) | Understand package boundaries and runtime composition. | | [Environment variables](internals/environment.md) | Find environment variables, defaults, and development overrides. | | [Contributing](internals/contributing.md) | Set up a checkout and choose focused verification. | - [Code map](internals/code-map.md) — locate the owning module before editing. - [Subsystem notes](internals/subsystems/README.md) — context, workbenches, search, and integration boundaries. - [Agent runtime](internals/agent-runtime.md) · [SDK](internals/sdk.md) — runtime and programmatic entry points. - [Desktop lifecycle](internals/desktop-runtime-lifecycle.md) · [Native browser](internals/desktop-browser.md) — shutdown, recovery, and browser integration. - [Desktop packaging](internals/desktop-as-primary-artifact.md) — native shell, staging, launcher, and updates. - [Workspace scope](internals/single-scope-sidebar.md) · [Client/server sync](internals/client-server-sync.md) — routed state and restoration. - [UI virtualization](internals/ui-virtualization.md) — bounded row windows for long lists. - [Visual system](internals/visual-system.md) — repository UI components and tokens. - [Documentation standards](internals/doc-standards.md) — page structure, evidence, links, and captures. The [public navigation](public-nav.json) defines the pages published on the documentation site. This index also links repository-only references; those are read in the checkout or on GitHub.