-
Notifications
You must be signed in to change notification settings - Fork 10
docs: Document Warp's SSH extension and feature support over SSH #9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
5e1c3b8
docs: Document Warp's SSH extension and feature support over SSH
hongyi-chen 873b655
docs: address self-review feedback on SSH PR
hongyi-chen 54cdbab
Remove TODO comment from changelog entry
hongyi-chen 0a5ea25
Remove TBD (Preview) changelog entry
hongyi-chen a9733c5
Remove preview/roadmap messaging from SSH docs
hongyi-chen 3409833
docs: address PR review feedback on SSH extension docs
oz-agent File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,34 +5,44 @@ description: >- | |
| are limited to local sessions. | ||
| --- | ||
|
|
||
| When you [Warpify an SSH session](/terminal/warpify/ssh/), Warp's core terminal features — the input editor, completions, blocks, history search, and more — work the same as they do locally. However, several coding-specific features are **not yet available** in remote sessions because the Agent cannot directly access the remote filesystem. | ||
| When you [Warpify an SSH session](/terminal/warpify/ssh/), Warp's core terminal features — the input editor, completions, blocks, history search, and more — work the same as they do locally. With Warp's [SSH extension](/terminal/warpify/ssh/#installing-the-ssh-extension) installed on the remote host, additional coding features such as the file tree, native file reading, and native code diffs also work over SSH on macOS and Linux. | ||
|
|
||
| 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. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||
| When a native tool is unavailable, the Agent automatically falls back to terminal commands (e.g. `cat`, `sed`, `grep`) to read and edit files. You can still accomplish most coding tasks over SSH, but the experience may be less seamless than working locally. | ||
| In the tmux fallback path, the Agent automatically falls back to terminal commands (e.g. `cat`, `sed`, `grep`) when a native tool is unavailable. You can still accomplish most coding tasks, but the experience is less seamless than working locally or through the SSH extension. | ||
| ::: | ||
|
|
||
| ## Features that work over SSH | ||
|
|
||
| The following features are fully available in Warpified remote sessions: | ||
| The following features work in Warpified remote sessions on both paths: | ||
|
|
||
| * **Agent Mode conversations** — You can chat with the Agent, ask questions, and request code changes. The Agent will use terminal commands to interact with the remote filesystem. | ||
| * **Agent Mode conversations** — Chat with the Agent, ask questions, and request code changes on the remote host. | ||
| * **Running shell commands** — The Agent can execute commands on the remote machine on your behalf. | ||
| * **Grep and file glob** — The Agent can search for files and patterns using terminal-based grep and glob tools. | ||
| * **MCP tools** — Model Context Protocol integrations remain available. | ||
| * **Terminal features** — The input editor, command completions, autosuggestions, command history, blocks, and all other core terminal features work as expected. | ||
|
|
||
| The following features require the **SSH extension**: | ||
|
|
||
| * **File tree (Project Explorer)** — The [file tree sidebar](/code/code-editor/file-tree/) reflects the remote project structure and updates as you navigate or change files. | ||
| * **Native file reading** — The Agent reads remote files through Warp's built-in file reading tool instead of shelling out to `cat`. | ||
| * **Native code diffs** — The Agent applies edits as inline [code diffs](/agent-platform/local-agents/code-diffs/) you can review and approve, instead of using `sed` or other shell commands. | ||
| * **Reliable, parallel completions** — Generators run in parallel over a single multiplexed connection, so completions stop hitting the remote host's `MaxSessions` ceiling and stop occasionally injecting errors into your blocks. | ||
|
|
||
| ## Features not yet available over SSH | ||
|
|
||
| The following features require local filesystem access and are not yet available in Warpified remote (SSH) sessions: | ||
| The following features require local filesystem access and are not yet available in Warpified remote (SSH) sessions on either path: | ||
|
|
||
| * **Codebase Context (indexing and search)** — Warp cannot index or semantically search a remote codebase. The Agent will not have access to your full project context when generating responses. Feature request: [GitHub #6831](https://github.com/warpdotdev/Warp/issues/6831) | ||
| * **Native file reading** — The Agent cannot read files through Warp's built-in file reading tool. It falls back to terminal commands like `cat` to read file contents. | ||
| * **Code diffs** — The Agent cannot apply code diffs natively. It falls back to terminal commands like `sed` to make file edits. | ||
| * **Code editor** — Warp's [native code editor](/code/code-editor/) is not yet available in remote sessions. You cannot open, view, or edit files in Warp's built-in editor over SSH. | ||
| * **File tree (Project Explorer)** — The [file tree sidebar](/code/code-editor/file-tree/) is not yet available in remote sessions. | ||
| * **Code review panel** — The [Code Review](/code/code-review/) panel for reviewing Git diffs is not yet available for remote repos. | ||
| * **Codebase Context (indexing and search)** — Warp cannot yet index or semantically search a remote codebase. The Agent does not have access to your full project context when generating responses. Tracked in [GitHub #6831](https://github.com/warpdotdev/Warp/issues/6831). | ||
| * **Code Review panel** — The [Code Review](/code/code-review/) panel for reviewing Git diffs is not yet available for remote repos. | ||
| * **Language Server Protocol (LSP)** — Warp's [LSP integration](/code/code-editor/language-server-protocol/) (hover info, go-to-definition, diagnostics, format-on-save) is local-only. | ||
| * **Code editor (file open/edit UI)** — Warp's [native code editor](/code/code-editor/) is not yet available in remote sessions. You cannot open, view, or edit remote files in Warp's built-in editor. | ||
| * **Computer use** — The Agent cannot take screenshots or interact with the remote machine's desktop. | ||
|
|
||
| :::note | ||
| WSL sessions have the same limitations as SSH. Feature request for WSL support: [GitHub #6744](https://github.com/warpdotdev/Warp/issues/6744) | ||
| WSL sessions have the same limitations as SSH and are not currently covered by the SSH extension. Feature request for WSL support: [GitHub #6744](https://github.com/warpdotdev/Warp/issues/6744). | ||
| ::: | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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