Houston docs

How to use Houston, the cross-platform coding agent that works with your own model. These pages describe Houston v0.11.1, the latest release.

Getting started

  • Getting started in the desktop app

    On first launch, the welcome screen shows a three-step Get started checklist:

  • What Houston is

    Houston is a coding agent that runs on your own machine and works inside a single project folder.

  • Clients (where Houston runs)

    Houston runs in six places. All of them share one agent core, so tools, permissions, and skills behave the same everywhere.

  • Models

    Bring any model with your own key: Anthropic, OpenAI, Google, any OpenAI-compatible endpoint, or a local model runtime.

  • Settings and keys

    Settings opens as a full page over the window. Back to app (at the top of the sidebar) or Esc returns to the chat.

Working with the agent

Reviewing and undoing changes

Permissions and safety

  • Approval modes and permissions

    Approval is layered: a mode for the chat, permission rules that refine it, and guardrails that projects and administrators can add.

  • Shell sandbox and network

    Shell commands run under the host OS sandbox where one exists, confined to the project folder: writes outside the project are blocked, and network access is...

  • Project rules

    Houston folds a small hierarchy of rules files into the system prompt on each run, in this order:

Sessions and automation

  • Context, worktrees, and history

    When a conversation grows too large, Houston keeps it inside the model's context window:

  • Spawn separate sessions

    A subagent reports back into the current turn. spawn_session instead spins off a separate chat that runs in the background.

  • Proposed sessions

    When the agent spots parallel work you didn't ask for (a fix noticed in passing, the natural follow-up), it proposes it with propose_session instead of...

  • Watching work you sent off (/spawned)

    When the agent hands a task to a separate session (see "Spawn separate sessions"), it runs in the background, often on its own branch and worktree.

  • Scheduled runs

    Ask the agent for a recurring (or one-time) background run, such as "every morning at 9, run the tests and summarize failures", and it stores a schedule...

Extending Houston

  • Skills

    A skill is a reusable bundle of instructions the agent loads only when a task needs it.

  • Custom subagents

    A subagent works on a task in its own fresh context and reports back, keeping the main conversation clean.

  • Hooks

    Hooks (Settings, Hooks) run your own shell commands at set points in the agent loop.

  • Plugins

    Drop a JS file in .houston/plugins/ to register observational lifecycle hooks for logging, metrics, or notifications:

  • MCP servers

    Connect Model Context Protocol servers in Settings: a local stdio process, or a remote HTTP (streamable) or SSE endpoint.

  • GitHub tools

    When the gh CLI is installed and signed in, Houston offers dedicated tools for the GitHub loop.

Reference

  • What a session cost (/cost)

    /cost breaks the session down by model:

  • Checking your setup (/doctor)

    /doctor reports what Houston can see, in both the desktop app and the terminal:

  • Version and updates

    The desktop app updates itself separately.

  • Edit, View, and Go menus

    The desktop app's menus list what its shortcuts do, with the shortcut beside each item. A shortcut you rebind in Settings shows up in the menus too.

  • Help menu

    The desktop app's Help menu is last in the menu bar on every platform.

  • Sharing Houston

    To invite a friend, any of these works:

  • License and legal

    Houston is open-source software under the Apache License 2.0 (LICENSE in the repository, and a copy inside the packaged app under Resources/).