Skip to content

docs: Document Warp's SSH extension and feature support over SSH#9

Merged
hongyi-chen merged 6 commits intomainfrom
oz/ssh-extension-docs
May 1, 2026
Merged

docs: Document Warp's SSH extension and feature support over SSH#9
hongyi-chen merged 6 commits intomainfrom
oz/ssh-extension-docs

Conversation

@hongyi-chen
Copy link
Copy Markdown
Collaborator

Summary

Document Warp's new SSH extension that brings the local Warp experience to remote macOS and Linux hosts: file tree backed by the remote filesystem, native file reads, native code diffs (no more falling back to sed), and reliable, parallel completions multiplexed over a single SSH connection. Reframe tmux Warpification as the fallback path. Code Review, LSP, and Codebase Context support over SSH are explicitly called out as still in progress.

Changes

src/content/docs/terminal/warpify/ssh.mdx

  • Replaced the tmux-only opening with an SSH-extension-first overview.
  • Embedded Kevin's Loom demo via <VideoEmbed> (the existing component already supports loom.com/share/<id>).
  • Added a "What you get over SSH" section listing the now-supported features and a "Coming soon" note for Code Review, LSP, and Codebase Context.
  • Added an "Installing the SSH extension" walkthrough covering the in-block install choice and ~/.warp*/remote-server install paths per channel.
  • Added a "Managing the install prompt" section pointing at warpify.ssh.ssh_extension_install_mode (always_ask, always_install, never_install) and ssh_hosts_denylist.
  • Reframed the existing tmux FAQs as fallback-path content for hosts where the extension isn't installed.

src/content/docs/code/ssh-feature-support.mdx

  • Reorganized into "Features that work over SSH" (with a sub-list of features that require the extension) and "Features not yet available over SSH" (with explicit roadmap framing for Code Review, LSP, and Codebase Context).
  • Moved File tree, Native file reading, and Code diffs into the supported list, and noted parallel multiplexed completions.
  • Cross-linked to the new install section.

src/content/docs/code/overview.mdx

  • Updated the top :::note and the second :::note near "How it works" so the sed/grep fallback only describes Windows clients, declined extension installs, and Docker-backed sessions — not all SSH sessions.

src/content/docs/agent-platform/capabilities/codebase-context.mdx

  • Reworded the SSH/WSL :::danger block (now a :::caution) so it accurately describes what does and doesn't work over SSH today, links to code/ssh-feature-support, and keeps the GitHub issue references.

src/content/docs/code/code-editor/file-tree.mdx

  • Added a :::note confirming the file tree now works over SSH when the SSH extension is installed.

src/content/docs/code/code-review.mdx

  • Added a brief :::note to the overview saying Code Review is local-only over SSH but is on the roadmap.

src/content/docs/code/code-editor/language-server-protocol.mdx

  • Updated the "Local sessions only" limitation bullet to point at code/ssh-feature-support and frame SSH support as "on the roadmap."

src/content/docs/terminal/warpify/index.mdx

  • Updated the SSH bullet so the Warpify overview reflects that SSH is now powered by the SSH extension on macOS and Linux, with a tmux-powered fallback elsewhere.

src/content/docs/changelog/index.mdx

  • Prepended a new 2026.04.29 entry calling out the SSH extension under "New features" and the parallel-multiplexed completions improvement under "Improvements," plus a note that Code Review, LSP, and Codebase Context support over SSH are still in progress.

Validation

  • npm run build — 309 pages built successfully (no warnings or errors).
  • All cross-links point at slugs that already exist in src/sidebar.ts.
  • No sidebar (astro.config.mjs) or redirect (vercel.json) updates needed since this only edits existing pages.

Conversation: https://staging.warp.dev/conversation/35f56ef1-3705-4928-b661-1d07b29a5217
Run: https://oz.staging.warp.dev/runs/019de10c-2768-7b10-8e16-6d409156a9c8
Plans:

This PR was generated with Oz.

Update the SSH and SSH-feature-support docs to reflect the new SSH
extension that enables file tree, native file reads, native code diffs,
and reliable multiplexed completions over SSH on macOS and Linux.
Reframe tmux Warpification as the fallback path. Embed Kevin's Loom
demo on the SSH page, refresh adjacent caveats in code/agent docs to
narrow the sed/grep fallback scope, and add a 2026.04.29 changelog
entry.

Co-Authored-By: Oz <oz-agent@warp.dev>
@cla-bot cla-bot Bot added the cla-signed label May 1, 2026
@vercel
Copy link
Copy Markdown

vercel Bot commented May 1, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment May 1, 2026 6:26pm

Request Review

- Fix Settings menu path: `Settings > Warpify` (not `Settings > Features
  > Warpify`) in three places (`terminal/warpify/ssh.mdx` lines 45 + 69
  and `changelog/index.mdx`). Warpify is its own top-level Settings nav
  item per `app/src/settings_view/mod.rs:1210`, matching existing usage
  in `terminal/warpify/ssh-legacy.mdx:59` and
  `terminal/warpify/subshells.mdx:36`.
- Replace fabricated `2026.04.29 (v0.2026.04.29.08.45)` changelog heading
  with a `### TBD (Preview)` placeholder + MDX comment pointing at the
  `update-changelog` skill so the real version stamp is added on release
  day instead of being merged as a guess.
- Use descriptive `[SSH roadmap](...)` link text in
  `code/code-review.mdx` instead of `[SSH](...)`.
- Lead the Codebase Context caution block with the specific feature
  that doesn't work ("semantic indexing and search") so the SSH-extension
  follow-up doesn't read as contradictory.
- Lowercase `tmux` in the `**tmux fallback**` bullet of
  `code/ssh-feature-support.mdx` to match the rest of the docs.
- Replace non-descriptive alt text (`SSH`) on the warpify prompt image
  with a descriptive alt text per the style guide.

Co-Authored-By: Oz <oz-agent@warp.dev>
@hongyi-chen hongyi-chen marked this pull request as ready for review May 1, 2026 01:26
Co-Authored-By: Oz <oz-agent@warp.dev>
Co-Authored-By: Oz <oz-agent@warp.dev>
Co-Authored-By: Oz <oz-agent@warp.dev>
:::caution
**Codebase Context (semantic indexing and search) is not yet available in SSH or WSL sessions.**

Other coding features over SSH on macOS and Linux — file tree, native file reads, and native code diffs — already work via Warp's [SSH extension](/terminal/warpify/ssh/#installing-the-ssh-extension), and Codebase Context is on the SSH roadmap. See [Feature support over SSH](/code/ssh-feature-support/) for the current matrix.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oo1 I don't think we need to add a section about codebase context, code review and LSP not working over SSH. They are all coming very soon

This page documents which features are available based on which path you're on:

* **SSH extension** - Installed on first connect when you choose **Install Warp's SSH extension**. Available on macOS and Linux remote hosts.
* **tmux fallback** - Used when you choose **Continue without installing**, when the extension hasn't shipped to your build (for example, Windows clients), or when the install fails.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tmux is not used as a fallback when user chooses to continue without installing.

It's a legacy alternative way to warpify. I think we should mention that this is not recommended anymore and is going to be deprecated


:::note
Some coding features — including Codebase Context, code diffs, the code editor, and the file tree — are not yet available over SSH. See [Feature support over SSH](/code/ssh-feature-support/) for the full list.
The extension binary tracks your client's release channel. Stable Warp installs `~/.warp/remote-server`, Preview installs `~/.warp-preview/remote-server`, and Dev installs `~/.warp-dev/remote-server`, so multiple channels can coexist on the same remote host.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't need to mention Dev here


On the first SSH connection to a host that doesn't already have the SSH extension installed, Warp shows an in-block prompt with two options:

* **Install Warp's SSH extension** - Recommended. Warp downloads the matching `oz` binary for the remote OS and architecture, installs it under `~/.warp/remote-server` (or `~/.warp-preview/remote-server` on Preview builds), launches it, and completes the handshake. Subsequent connections to the same host skip the prompt and reuse the installed binary.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should mention call this remote server extension instead of oz binary

- Use 'remote server extension' instead of 'oz binary' in ssh.mdx
- Drop Dev channel mention from extension install path note
- Clarify that 'Continue without installing' does not fall back to tmux
- Reframe tmux-based Warpification as a legacy, deprecated alternative
- Stop documenting Codebase Context, Code Review, and LSP as not yet
  available over SSH (these are coming very soon)

Co-Authored-By: Oz <oz-agent@warp.dev>
@hongyi-chen hongyi-chen merged commit 9d837ad into main May 1, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants