quil
v1.92.0 github
QUIL / DOCS · THE DOCS LIVE ON GITHUB, THIS PAGE ROUTES TO THEM

What are you trying to do?

Each row is one way to use Quil: the steps, the keys, and the exact section of the docs that explains it. The first six are the stops of the tour on the home page.

new here? install quick start keys
IN THE TOUR · 6
01
AGENTS, SIDE BY SIDE see it in the tour

Run Claude Code, Codex and OpenCode at once, each with its own folder and conversation.

DO

  1. Split the pane: Alt+Shift+H side by side, Alt+Shift+V stacked.
  2. Type claude, codex or opencode in the new shell. The pane becomes that agent.
  3. For its own checkout, use Ctrl+N and pick Worktree → + new branch….

KEYS

Alt+Shift+Hsplit
Alt+Shift+Vsplit
Ctrl+Nnew pane

READ ON GITHUB

features.md › Hand-started agents↗features.md › Built-in plugins↗features.md › Spawn a pane in a worktree↗features.md › AI session resume↗
02
AN AGENT THAT RUNS THE OTHERS see it in the tour

Let one agent open panes, start other agents, hand out tasks and read the results.

DO

  1. Add Quil to your AI client as an MCP server: quil mcp.
  2. Open a team from the palette: New from template → agent-team.
  3. The orchestrator calls delegate_task. Each result is typed back into its prompt.

KEYS

Alt+Shift+Ppalette
quil mcp36 tools

READ ON GITHUB

mcp.md › Wiring Quil into your AI client↗mcp.md › Delegating work to another pane↗mcp.md › The 36 tools↗workspace-templates.md › Shipped templates and limits↗
03
THE WORK RUNS ELSEWHERE see it in the tour

Run the work on a server. The laptop only shows it, and can close.

DO

  1. Attach a whole session: quil --remote gpu01.
  2. Or add the host as a project: Alt+Shift+N → Remote (ssh). Quil installs itself there when needed.
  3. If the link drops, the panes keep running and Quil reconnects with backoff.

KEYS

quil --remote <host>
quil remote setup <host>

READ ON GITHUB

features.md › Remote daemon over SSH↗features.md › When the link drops↗features.md › Projects on another machine↗remote-windows.md › Windows remotes over SSH↗
04
AN AGENT IN A BOX see it in the tour

Give an agent skipped permissions inside a Docker container that only sees its checkout.

DO

  1. Build the image once: scripts/sandbox-image.sh.
  2. Tick Run in a Docker container in the agent's setup dialog.
  3. Closing the pane removes the container. Its commits stay in your repository.

KEYS

scripts/sandbox-image.sh
--with codex,opencodemore agents

READ ON GITHUB

sandbox-panes.md › Using it↗sandbox-panes.md › Building the image↗sandbox-panes.md › What the sandbox does and does not bound↗sandbox-panes.md › The sbx backend (microVM)↗
05
TOO MUCH GOING ON see it in the tour

See which agent needs you, and find any text in any pane.

DO

  1. Read the sidebar: ▲ waiting on you, ⠹ working, ✓ finished while you were away.
  2. Jump to the agent that has waited longest: Alt+Shift+A.
  3. Search actions, tabs, projects and every pane's scrollback: Alt+Shift+P. Enter goes to the pane.

KEYS

Alt+Shift+Aoldest waiting
Alt+Shift+Psearch
Alt+Nnotifications

READ ON GITHUB

features.md › Projects↗features.md › Command palette↗features.md › Notification center↗features.md › Desktop notifications↗
06
THE WORKSPACE REMEMBERS see it in the tour

Restart the machine and get the same tabs, splits, folders, history and agent conversations back.

DO

  1. Run quil after the restart. The workspace is read from ~/.quil.
  2. Agents resume their sessions: claude --resume, codex resume, opencode --session.
  3. Leave a note on a pane with Alt+E. It survives the restart too.

KEYS

quilstart
Alt+Epane notes
Alt+Rrestart a pane

READ ON GITHUB

features.md › Reboot-proof sessions↗features.md › Lazy restore↗features.md › AI session resume↗features.md › Pane notes↗
MORE WAYS TO USE IT · 7
11
THE ON-CALL ENGINEER

Keep the cluster, the database, the servers and the webhooks open, and get them back after a restart.

DO

  1. Open k9s with its read-only toggle on the kube context you need.
  2. Open lazysql read-only. SSH and Stripe panes re-run their command after a restart.
  3. Pin a pane you must not forget: Mark attention (◆) in the pane menu, Alt+A.

KEYS

Ctrl+NTools
Alt+Apane menu

READ ON GITHUB

features.md › k9s integration↗features.md › lazysql integration↗plugin-reference.md › Strategy Reference↗
12
ONE WORKSPACE, TWO WINDOWS

Attach from the desk and the laptop at the same time, and see the same workspace in both.

DO

  1. Run quil in a second terminal, local or with --remote.
  2. Both windows show the same projects, tabs and panes, and mirror each other's layout.
  3. The status bar shows [master] or [follower]. The master sets pane sizes.

KEYS

quilsecond window
client.take_controlbindable

READ ON GITHUB

features.md › Multi-client sync↗keybindings.md › Multi-client↗

The shelf

The main documents in the repository, in plain Markdown.

README.mdWhat Quil is, install, five keys↗docs/installation.mdEvery way to install it↗docs/quick-start.mdFirst launch, step by step↗docs/features.mdEvery capability, by area↗docs/keybindings.mdThe keymap, presets, rebinding↗docs/configuration.mdEvery key in config.toml↗docs/workspace-templates.mdtemplates.toml: teams of panes↗docs/mcp.mdThe MCP server and its 36 tools↗docs/plugin-reference.mdWriting a pane type in TOML↗docs/sandbox-panes.mdAgents inside Docker↗docs/remote-windows.mdA Windows machine as the remote↗docs/troubleshooting.mdWhen something is wrong↗docs/architecture.mdWhy it is built this way: the ADRs↗docs/roadmap.mdWhat shipped, what is next↗docs/vision.mdWhy Quil exists↗CHANGELOG.mdEvery release↗