diff --git a/.agents/skills/missing_docs/SKILL.md b/.agents/skills/missing_docs/SKILL.md index ea25c4480..fba2dec8a 100644 --- a/.agents/skills/missing_docs/SKILL.md +++ b/.agents/skills/missing_docs/SKILL.md @@ -217,6 +217,17 @@ For each gap to address (prioritize high → medium → low): map is how gaps get lost. 9. Run `--update-snapshot` and commit the refreshed snapshot with the same PR. +### Resolution patterns + +Not every finding needs a new doc page — pick the lightest correct fix and verify it against source before applying: + +- **User-facing setting** — document it in `terminal/settings/all-settings.mdx` under its TOML section (type/default/options come from the `toml_path` registration). +- **Internal or state-only setting** (one-time banners, migration flags, telemetry-modeled state) — map `section.key -> internal` in the surface map instead of documenting it. +- **Feature flag with a dedicated doc page** — map the flag to that page. +- **Feature flag whose only user-facing surface is an already-documented setting** — map the flag to that setting's doc page rather than writing a new page (for example, a tab-bar visibility flag maps to the all-settings reference). +- **Preview or pre-launch feature with no docs yet** — add it to the surface-map ignore list with a comment; the snapshot diff re-flags it when it promotes to GA. +- **Stale map entry or doc reference** (map hygiene) — confirm the surface is gone from code, then prune the dead entry. + ### Drift-watch mode (recurring scheduled agent) This is the end-to-end workflow for the scheduled cloud agent that keeps docs in sync diff --git a/.agents/skills/missing_docs/references/feature_surface_map.md b/.agents/skills/missing_docs/references/feature_surface_map.md index 1414fcf94..3fb930716 100644 --- a/.agents/skills/missing_docs/references/feature_surface_map.md +++ b/.agents/skills/missing_docs/references/feature_surface_map.md @@ -107,6 +107,8 @@ CLIAgentRichInput -> src/content/docs/agent-platform/cli-agents/rich-input.md HOANotifications -> src/content/docs/agent-platform/capabilities/agent-notifications.mdx OpenCodeNotifications -> src/content/docs/agent-platform/cli-agents/opencode.md CodexNotifications -> src/content/docs/agent-platform/cli-agents/codex.md +# Codex Warp plugin marketplace integration; documented alongside Codex notifications. +CodexPlugin -> src/content/docs/agent-platform/cli-agents/codex.md HOARemoteControl -> src/content/docs/agent-platform/cli-agents/remote-control.md GlobalSearch -> src/content/docs/code/overview.md FileBasedMcp -> src/content/docs/agent-platform/capabilities/mcp.mdx @@ -125,6 +127,38 @@ ConfigurableToolbar -> src/content/docs/terminal/windows/configurable-toolbar.md SettingsFile -> src/content/docs/terminal/settings/index.mdx Changelog -> src/content/docs/changelog/index.mdx Autoupdate -> src/content/docs/support-and-community/troubleshooting-and-support/updating-warp.mdx +ShellSelector -> src/content/docs/getting-started/supported-shells.mdx +WorkflowAliases -> src/content/docs/terminal/entry/yaml-workflows.mdx +KittyImages -> src/content/docs/terminal/more-features/full-screen-apps.mdx +UndoClosedPanes -> src/content/docs/terminal/windows/tabs.mdx +RevertDiffHunk -> src/content/docs/code/code-review.mdx +SshRemoteServer -> src/content/docs/terminal/warpify/ssh.mdx + +# Feature flags whose only user-facing surface is a documented setting in the +# all-settings reference (terminal/settings/all-settings.mdx). +# - FullScreenZenMode: the "zen mode" tab-bar visibility knob appearance.tabs.workspace_decoration_visibility +# - AsyncFind: experimental.async_find_enabled +FullScreenZenMode -> src/content/docs/terminal/settings/all-settings.mdx +AsyncFind -> src/content/docs/terminal/settings/all-settings.mdx + +# Session sharing (viewing + ACLs are part of the documented session sharing feature) +ViewingSharedSessions -> src/content/docs/knowledge-and-collaboration/session-sharing/index.mdx +SessionSharingAcls -> src/content/docs/knowledge-and-collaboration/session-sharing/index.mdx +SharedSessionWriteToLongRunningCommands -> src/content/docs/knowledge-and-collaboration/session-sharing/index.mdx + +# CLI-gated features documented in the CLI reference +ArtifactCommand -> src/content/docs/reference/cli/artifacts.mdx +OzIdentityFederation -> src/content/docs/reference/cli/federate.mdx + +# Third-party harness support +AgentHarness -> src/content/docs/agent-platform/cloud-agents/harnesses/index.mdx + +# Image context for cloud agents +AmbientAgentsImageUpload -> src/content/docs/agent-platform/local-agents/agent-context/images-as-context.mdx +CloudModeImageContext -> src/content/docs/agent-platform/local-agents/agent-context/images-as-context.mdx + +# Skills on the Oz platform +OzPlatformSkills -> src/content/docs/agent-platform/capabilities/skills.mdx # Handoff (local <-> cloud, cloud <-> cloud) and snapshots OzHandoff -> src/content/docs/agent-platform/cloud-agents/handoff/index.mdx @@ -144,6 +178,10 @@ NamedAgents -> src/content/docs/agent-platform/cloud-agents/agents.mdx # Inference: BYOK and custom endpoints SoloUserByok -> src/content/docs/agent-platform/inference/bring-your-own-api-key.mdx CustomInferenceEndpoints -> src/content/docs/agent-platform/inference/custom-inference-endpoint.mdx +# Connect a SuperGrok subscription instead of pasting an xAI API key. +SuperGrok -> src/content/docs/agent-platform/inference/bring-your-own-api-key.mdx +# Custom model routers (Settings > AI > Custom Routers) surface in the model picker. +CustomModelRouters -> src/content/docs/agent-platform/inference/model-choice.mdx # Billing & Usage settings page (redesigned) BillingAndUsagePageV2 -> src/content/docs/support-and-community/plans-and-billing/index.mdx @@ -229,10 +267,17 @@ POST /harness-support/upload-snapshot -> internal # for exceptions: settings documented on another page (`section.key -> path`) # or intentionally undocumented (`section.key -> internal`). +# One-time internal state for the deprecated tmux SSH wrapper migration banner; +# not a user-configurable setting. +warpify.ssh.ssh_tmux_deprecation_notice_pending -> internal + ## Unlisted docs pages to ignore # Pages intentionally absent from src/sidebar.ts (one slug per line, e.g. # `guides/some-page`). Everything else on disk must be reachable via the sidebar. +# Per the page's frontmatter comment: not in the Guides sidebar yet, pending +# team feedback. +guides/agent-workflows/warp-vs-claude-code ## Flags to ignore (internal-only, not user-facing) @@ -280,7 +325,6 @@ DefaultAdeberryTheme AutoupdateUIRevamp MinimalistUI AvatarInTabBar -SessionSharingAcls ImeMarkedText NewTabStyling AmbientAgentsRTC @@ -297,9 +341,9 @@ CreateProjectFlow CodeLaunchModal ValidateAutosuggestions ClearAutosuggestionOnEscape -OzPlatformSkills -# Rendering detail for markdown tables in notebooks/AI output; no dedicated doc surface. +# Rendering details for markdown tables/Mermaid in notebooks/AI output; no dedicated doc surface. MarkdownTables +MarkdownMermaid # UI implementation details (not user-facing features) FallbackModelLoadOutputMessaging @@ -321,7 +365,6 @@ HOAOnboardingFlow AgentViewConversationListView BuildPlanAutoReloadBannerToggle BuildPlanAutoReloadPostPurchaseModal -FreeUserNoAi ForceLogin SimulateGithubUnauthed ConversationApi @@ -338,39 +381,33 @@ GitCredentialRefresh OrchestrationViewerStreamer OwnerOrchestrationAncestorStreamer -# Non-GA flags in dogfood/preview only +# Sub-feature toggles and pre-launch flags. Section placement does NOT assert +# rollout status (the audit computes that from code); entries here are ignored +# because the toggle itself isn't a documentable surface, or because the +# feature isn't user-facing yet — the snapshot diff flags promotions. +# Grouped Tabs is a macOS-only Preview feature (organize tabs into named, +# collapsible groups); public docs are pending GA promotion, which the snapshot +# diff will flag. +GroupedTabs LSPAsATool -SshRemoteServer EmbeddedCodeReviewComments InteractiveConversationManagementView MarkdownImages -MarkdownMermaid EditableMarkdownMermaid -OzIdentityFederation -AgentHarness +# Directory-based tab colors: the user-facing knob is the setting +# appearance.tabs.directory_tab_colors, documented in the all-settings reference. DirectoryTabColors -ArtifactCommand -CloudModeImageContext CloudModeHostSelector -AmbientAgentsImageUpload CodebaseIndexSpeedbump CodebaseIndexPersistence -SharedSessionWriteToLongRunningCommands AgentTips AgentViewPromptChip AllowOpeningFileLinksUsingEditorEnv AllowIgnoringInputSuggestions CodeModeChip -UndoClosedPanes -RevertDiffHunk -ViewingSharedSessions -ShellSelector -FullScreenZenMode -WorkflowAliases -KittyImages +# Internal agent file-search tool plumbing (read tools are not individually documented). GrepTool NativeShellCompletions -WelcomeTab DragTabsToWindows SshDragAndDrop ITermImages @@ -384,5 +421,7 @@ PredictAMQueries UseTantivySearch CommandCorrectionsHistoryRule SuggestedAgentModeWorkflows +# Implementation toggle choosing skill-based vs slash-command PR comments; +# the user-facing /pr-comments command is mapped via PRCommentsSlashCommand. PRCommentsSkill FigmaDetection diff --git a/src/content/docs/agent-platform/capabilities/slash-commands.mdx b/src/content/docs/agent-platform/capabilities/slash-commands.mdx index 4f6190c43..5d212c8d4 100644 --- a/src/content/docs/agent-platform/capabilities/slash-commands.mdx +++ b/src/content/docs/agent-platform/capabilities/slash-commands.mdx @@ -18,7 +18,7 @@ As you type, the menu filters results in real time, making it easy to find and r Warp currently supports the following built-in Slash Commands: -
Slash CommandDescription
/add-mcpAdd a new MCP server.
/add-promptAdd a new Agent Prompt in Warp Drive.
/add-ruleAdd a new Global Rule for the Agent.
/agentStart a new agent conversation. Optionally include a prompt to send immediately.
/changelogOpen the latest Warp changelog.
/cloud-agentStart a new cloud agent conversation. {'*'}
/compactFree up context by summarizing conversation history.
/compact-andCompact the current conversation and then send a follow-up prompt.
/conversationsOpen conversation history.
/costToggle credit usage details in the current conversation.
/create-environmentCreate a Warp Environment (Docker image + repos) via guided setup. {'*'}
/create-new-projectHave the Agent walk you through creating a new coding project. {'*'}
/export-to-clipboardExport the current conversation to clipboard in markdown format.
/export-to-fileExport the current conversation to a markdown file.
/feedbackOpen the static feedback experience. See Using /feedback in Warp for details.
/forkForks the current conversation into a new thread with the full context and history of the original.

You can optionally include a prompt that will be sent immediately in the forked conversation.
/fork-and-compactForks the current conversation and automatically compacts the forked version.

Useful when you want a fresh, summarized starting point that preserves relevant context while trimming the rest.
/fork-fromOpen a searchable menu to fork the conversation from a specific query. Select a query to create a fork that includes everything up to that point.
/indexIndex the current codebase using Codebase Context.
/initIndex the current codebase and generate an AGENTS.md file. {'*'}
/modelSwitch the base agent model for the current conversation.
/newStart a new agent conversation (alias for /agent).
/open-code-reviewOpen the code review pane.
/open-fileOpen a file for editing in Warp's code editor.
/open-mcp-serversView the status of your MCP servers.
/open-project-rulesOpen the Project Rules file (AGENTS).
/open-repoSwitch to another indexed repository.
/open-rulesView all of your global and project rules.
/open-settings-fileOpen the Warp settings file (settings.toml) in Warp's code editor.
/open-skillOpen an interactive menu to browse and edit project or global skills.
/orchestrateBreak a task into subtasks and run them in parallel with multiple agents. {'*'}
/planPrompt the Agent to do some research and create a plan for a task.
/pr-commentsPull GitHub PR review comments into Warp. {'*'}
/profileSwitch the active execution profile.
/promptsSearch saved prompts.
/queueQueue a prompt to send after the agent finishes responding. See Prompt Queueing.
/rename-tabRename the current tab. Include the new tab name as an argument (for example, /rename-tab deploy).
/rewindRewind to a previous point in the conversation.
/skillsInvoke a skill from a searchable menu.
/usageOpen billing and usage settings.
+
Slash CommandDescription
/add-mcpAdd a new MCP server.
/add-promptAdd a new Agent Prompt in Warp Drive.
/add-ruleAdd a new Global Rule for the Agent.
/agentStart a new agent conversation. Optionally include a prompt to send immediately.
/changelogOpen the latest Warp changelog.
/cloud-agentStart a new cloud agent conversation. {'*'}
/compactFree up context by summarizing conversation history.
/compact-andCompact the current conversation and then send a follow-up prompt.
/conversationsOpen conversation history.
/costToggle credit usage details in the current conversation.
/create-environmentCreate a Warp Environment (Docker image + repos) via guided setup. {'*'}
/create-new-projectHave the Agent walk you through creating a new coding project. {'*'}
/environmentSwitch the environment for the current cloud agent conversation.
/export-to-clipboardExport the current conversation to clipboard in markdown format.
/export-to-fileExport the current conversation to a markdown file.
/feedbackOpen the static feedback experience. See Using /feedback in Warp for details.
/forkForks the current conversation into a new thread with the full context and history of the original.

You can optionally include a prompt that will be sent immediately in the forked conversation.
/fork-and-compactForks the current conversation and automatically compacts the forked version.

Useful when you want a fresh, summarized starting point that preserves relevant context while trimming the rest.
/fork-fromOpen a searchable menu to fork the conversation from a specific query. Select a query to create a fork that includes everything up to that point.
/harnessSwitch the harness for the current cloud agent conversation.
/hostSwitch the execution host for the current cloud agent conversation.
/indexIndex the current codebase using Codebase Context.
/initIndex the current codebase and generate an AGENTS.md file. {'*'}
/modelSwitch the base agent model for the current conversation.
/newStart a new agent conversation (alias for /agent).
/open-code-reviewOpen the code review pane.
/open-fileOpen a file for editing in Warp's code editor.
/open-mcp-serversView the status of your MCP servers.
/open-project-rulesOpen the Project Rules file (AGENTS).
/open-repoSwitch to another indexed repository.
/open-rulesView all of your global and project rules.
/open-settings-fileOpen the Warp settings file (settings.toml) in Warp's code editor.
/open-skillOpen an interactive menu to browse and edit project or global skills.
/orchestrateBreak a task into subtasks and run them in parallel with multiple agents. {'*'}
/planPrompt the Agent to do some research and create a plan for a task.
/pr-commentsPull GitHub PR review comments into Warp. {'*'}
/profileSwitch the active execution profile.
/promptsSearch saved prompts.
/queueQueue a prompt to send after the agent finishes responding. See Prompt Queueing.
/rename-conversationRename the current conversation.
/rename-tabRename the current tab. Include the new tab name as an argument (for example, /rename-tab deploy).
/rewindRewind to a previous point in the conversation.
/skillsInvoke a skill from a searchable menu.
/usageOpen billing and usage settings.
:::caution Slash commands marked with a `*` consume credits to complete the task. diff --git a/src/content/docs/agent-platform/inference/bring-your-own-api-key.mdx b/src/content/docs/agent-platform/inference/bring-your-own-api-key.mdx index d959e6c1d..1681efc2e 100644 --- a/src/content/docs/agent-platform/inference/bring-your-own-api-key.mdx +++ b/src/content/docs/agent-platform/inference/bring-your-own-api-key.mdx @@ -11,6 +11,8 @@ This lets you use your own API keys for model access, giving you control over mo BYOK provides greater flexibility in model access and ensures Warp **never consumes your** [AI credits](/support-and-community/plans-and-billing/credits/) for requests routed through your own keys. +For xAI's Grok models, you can also connect your SuperGrok subscription instead of entering an API key. In the Warp app, go to **Settings** > **AI** and choose to connect your SuperGrok subscription — Warp opens your browser to complete the connection. + :::note BYOK is available on Free and all eligible paid plans for individual users and organizations with 10 or fewer employees, subject to Warp's [Terms of Service](https://www.warp.dev/legal/terms-of-service). Larger organizations need a Business or Enterprise plan. See [Warp pricing](https://www.warp.dev/pricing) for current availability. ::: diff --git a/src/content/docs/agent-platform/inference/model-choice.mdx b/src/content/docs/agent-platform/inference/model-choice.mdx index 3c0651e9f..3321d23ba 100644 --- a/src/content/docs/agent-platform/inference/model-choice.mdx +++ b/src/content/docs/agent-platform/inference/model-choice.mdx @@ -122,6 +122,12 @@ You can configure the base model for each [Agent Profile](/agent-platform/capabi Edit your default profile or any other profile directly in **Settings** > **Agents** > **Profiles**. +### Custom routers + +Custom model routers automatically route each task to a specific model based on task complexity or rules you define, instead of using a single fixed model for every prompt. Your custom routers appear in the [model selector](#how-to-change-models) alongside Warp's built-in models. + +Add and manage custom routers in **Settings** > **AI** > **Custom Routers**. + ### Zero data retention policies Warp integrates with multiple large language model (LLM) providers to power its AI-driven features. diff --git a/src/content/docs/getting-started/keyboard-shortcuts.mdx b/src/content/docs/getting-started/keyboard-shortcuts.mdx index 9c2e767e2..8e116a41f 100644 --- a/src/content/docs/getting-started/keyboard-shortcuts.mdx +++ b/src/content/docs/getting-started/keyboard-shortcuts.mdx @@ -43,8 +43,8 @@ Keybinds that conflict with others are highlighted with an orange border. | `CTRL-SHIFT-R` | Workflows | `input:toggle_workflows` | | `` CTRL-` `` | Generate | `input:toggle_natural_language_command_search` | | `CMD-L` | Focus Terminal Input | `terminal:focus_input` | - | `CTRL-I` | Warpify Subshell | `terminal:trigger_subshell_bootstrap` | - | `CMD-\` | Warp Drive | `terminal:toggle_warp_drive` | + | `CTRL-I` | Warpify Subshell | `terminal:warpify_subshell` | + | `CMD-\` | Warp Drive | `workspace:toggle_warp_drive` | | `CMD-O` | File search | | | `CMD-P` | Open Command Palette | @@ -64,7 +64,7 @@ Keybinds that conflict with others are highlighted with an orange border. | `CTRL-M` | Open Block Context Menu | `terminal:open_block_list_context_menu_via_keybinding` | | `SHIFT-CMD-C` | Copy Command | `terminal:copy_commands` | | `SHIFT-CMD-I` | Reinput Selected Commands as Root | `terminal:reinput_commands_with_sudo` | - | `SHIFT-CMD-S` | Share Selected Block | `terminal:open_share_modal` | + | `SHIFT-CMD-S` | Share Selected Block | `terminal:open_share_block_modal` | | `SHIFT-DOWN` | Expand Selected Blocks Below | `terminal:expand_block_selection_below` | | `SHIFT-UP` | Expand Selected Blocks Above | `terminal:expand_block_selection_above` | @@ -72,10 +72,10 @@ Keybinds that conflict with others are highlighted with an orange border. | Shortcut | Command | Action | | ---------------- | -------------------------------------------- | --------------------------------------------------------- | - | `PAGE UP` | Scroll Up One Page | `terminal:page_up` | - | `PAGE DOWN` | Scroll Down One Page | `terminal:page_down` | - | `HOME` | Scroll to Top | `terminal:home` | - | `END` | Scroll to Bottom | `terminal:end` | + | `PAGE UP` | Scroll Up One Page | `terminal:scroll_up_one_page` | + | `PAGE DOWN` | Scroll Down One Page | `terminal:scroll_down_one_page` | + | `HOME` | Scroll to Top | | + | `END` | Scroll to Bottom | | | `SHIFT-CMD-UP` | Scroll to Top of Selected Block | `terminal:scroll_to_top_of_selected_block` | | `SHIFT-CMD-DOWN` | Scroll to Bottom of Selected Block | `terminal:scroll_to_bottom_of_selected_block` | | | Scroll Terminal Output Up One Line | `terminal:scroll_up_one_line` | @@ -98,7 +98,7 @@ Keybinds that conflict with others are highlighted with an orange border. | `CMD-BACKSPACE` | Delete All Left | `editor_view:delete_all_left` | | `CMD-DELETE` | Delete All Right | `editor_view:delete_all_right` | | `CMD-DOWN` | Move Cursor to the Bottom | `editor_view:cmd_down` | - | `CMD-I` | Inspect Command | `editor_view:cmd_i` | + | `CMD-I` | Inspect Command | `editor_view:inspect_command` | | `CMD-LEFT` | Home | `editor_view:home` | | `CMD-RIGHT` | End | `editor_view:end` | | `CTRL-A` | Move to Start of Line | `editor_view:move_to_line_start` | @@ -118,9 +118,9 @@ Keybinds that conflict with others are highlighted with an orange border. | `CTRL-SHIFT-B` | Select One Character to the Left | `editor_view:select_left` | | `CTRL-SHIFT-DOWN` | Add Cursor Below | `editor_view:add_cursor_below` | | `CTRL-SHIFT-E` | Select to End of Line | `editor:select_to_line_end` | - | `CMD-Z` | Undo | `editor:undo` | - | `CMD-SHIFT-Z` | Redo | `editor:redo` | - | `CTRL-SHIFT-F` | Select One Character to the Right | `editor:select_right` | + | `CMD-Z` | Undo | | + | `CMD-SHIFT-Z` | Redo | | + | `CTRL-SHIFT-F` | Select One Character to the Right | `editor_view:select_right` | | `CTRL-SHIFT-N` | Select Down | `editor_view:select_down` | | `CTRL-SHIFT-P` | Select Up | `editor_view:select_up` | | `CTRL-SHIFT-UP` | Add Cursor Above | `editor_view:add_cursor_above` | @@ -150,7 +150,7 @@ Keybinds that conflict with others are highlighted with an orange border. | `ALT-CMD-UP` | Switch Panes Up | `pane_group:navigate_up` | | `ALT-CMD-V` | \[a11y] Set Concise Accessibility Announcements | `workspace:set_a11y_concise_verbosity_level` | | `ALT-CMD-V` | \[a11y] Set Verbose Accessibility Announcements | `workspace:set_a11y_verbose_verbosity_level` | - | `CMD-,` | Open Settings | `workspace:show_settings_modal` | + | `CMD-,` | Open Settings | `workspace:show_settings` | | `CMD-,` | Open Settings: Account | `workspace:show_settings_account_page` | | `CMD-G` | Find the Next Occurrence of Your Search Query | `find:find_next_occurrence` | | `CMD-P` | Toggle Command Palette | `workspace:toggle_command_palette` | @@ -187,8 +187,8 @@ Keybinds that conflict with others are highlighted with an orange border. | `CMD-C` | Copy | `terminal:copy` | | `CMD-F` | Find | `terminal:find` | | `CMD-V` | Paste | `terminal:paste` | - | `CMD-T` | Open New Tab | `workspace:open_new_tab` | - | `SHIFT-CMD-T` | Reopen Closed Tab | `workspace:reopen_closed_tab` | + | `CMD-T` | Open New Tab | `workspace:new_tab` | + | `SHIFT-CMD-T` | Reopen Closed Tab | `app:reopen_closed_session` | | `CTRL-SHIFT-LEFT` | Move Tab Left | `workspace:move_tab_left` | | `CTRL-SHIFT-RIGHT` | Move Tab Right | `workspace:move_tab_right` | | `SHIFT-CMD-{` | Activate Previous Tab | `workspace:activate_prev_tab` | @@ -206,8 +206,8 @@ Keybinds that conflict with others are highlighted with an orange border. | `CTRL-SHIFT-R` | Workflows | `input:toggle_workflows` | | `` CTRL-` `` | Generate | `input:toggle_natural_language_command_search` | | `CTRL-SHIFT-L` | Focus Terminal Input | `terminal:focus_input` | - | `CTRL-I` | Warpify Subshell | `terminal:trigger_subshell_bootstrap` | - | `CTRL-SHIFT-\` | Warp Drive | `terminal:toggle_warp_drive` | + | `CTRL-I` | Warpify Subshell | `terminal:warpify_subshell` | + | `CTRL-SHIFT-\` | Warp Drive | `workspace:toggle_warp_drive` | **Blocks** @@ -225,7 +225,7 @@ Keybinds that conflict with others are highlighted with an orange border. | | Open Block Context Menu | `terminal:open_block_list_context_menu_via_keybinding` | | `CTRL-SHIFT-C` | Copy Command | `terminal:copy_commands` | | | Reinput Selected Commands as Root | `terminal:reinput_commands_with_sudo` | - | `CTRL-SHIFT-S` | Share Selected Block | `terminal:open_share_modal` | + | `CTRL-SHIFT-S` | Share Selected Block | `terminal:open_share_block_modal` | | `SHIFT-DOWN` | Expand Selected Blocks Below | `terminal:expand_block_selection_below` | | `SHIFT-UP` | Expand Selected Blocks Above | `terminal:expand_block_selection_above` | @@ -233,10 +233,10 @@ Keybinds that conflict with others are highlighted with an orange border. | Shortcut | Command | Action | | ------------------ | -------------------------------------------- | --------------------------------------------------------- | - | `PAGE UP` | Scroll Up One Page | `terminal:page_up` | - | `PAGE DOWN` | Scroll Down One Page | `terminal:page_down` | - | `HOME` | Scroll to Top | `terminal:home` | - | `END` | Scroll to Bottom | `terminal:end` | + | `PAGE UP` | Scroll Up One Page | `terminal:scroll_up_one_page` | + | `PAGE DOWN` | Scroll Down One Page | `terminal:scroll_down_one_page` | + | `HOME` | Scroll to Top | | + | `END` | Scroll to Bottom | | | `CTRL-SHIFT-UP` | Scroll to Top of Selected Block | `terminal:scroll_to_top_of_selected_block` | | `CTRL-SHIFT-DOWN` | Scroll to Bottom of Selected Block | `terminal:scroll_to_bottom_of_selected_block` | | | Scroll Terminal Output Up One Line | `terminal:scroll_up_one_line` | @@ -259,7 +259,7 @@ Keybinds that conflict with others are highlighted with an orange border. | `CTRL-Y` | Delete All Left | `editor_view:delete_all_left` | | | Delete All Right | `editor_view:delete_all_right` | | `CTRL-END` | Move Cursor to the Bottom | `editor_view:cmd_down` | - | `CTRL-I` | Inspect Command | `editor_view:cmd_i` | + | `CTRL-I` | Inspect Command | `editor_view:inspect_command` | | `HOME` | Home | `editor_view:home` | | `END` | End | `editor_view:end` | | `CTRL-A` | Move to Start of Line | `editor_view:move_to_line_start` | @@ -279,9 +279,9 @@ Keybinds that conflict with others are highlighted with an orange border. | `CTRL-SHIFT-B` | Select One Character to the Left | `editor_view:select_left` | | `CTRL-SHIFT-DOWN` | Add Cursor Below | `editor_view:add_cursor_below` | | | Select to End of Line | `editor:select_to_line_end` | - | `CTRL-Z` | Undo | `editor:undo` | - | `CTRL-SHIFT-Z` | Redo | `editor:redo` | - | `CTRL-SHIFT-F` | Select One Character to the Right | `editor:select_right` | + | `CTRL-Z` | Undo | | + | `CTRL-SHIFT-Z` | Redo | | + | `CTRL-SHIFT-F` | Select One Character to the Right | `editor_view:select_right` | | | Select Down | `editor_view:select_down` | | `CTRL-SHIFT-P` | Select Up | `editor_view:select_up` | | `CTRL-SHIFT-UP` | Add Cursor Above | `editor_view:add_cursor_above` | @@ -310,7 +310,7 @@ Keybinds that conflict with others are highlighted with an orange border. | `CTRL-ALT-UP` | Switch Panes Up | `pane_group:navigate_up` | | `CTRL-ALT-V` | \[a11y] Set Concise Accessibility Announcements | `workspace:set_a11y_concise_verbosity_level` | | `CTRL-ALT-V` | \[a11y] Set Verbose Accessibility Announcements | `workspace:set_a11y_verbose_verbosity_level` | - | `CTRL-,` | Open Settings | `workspace:show_settings_modal` | + | `CTRL-,` | Open Settings | `workspace:show_settings` | | `CTRL-,` | Open Settings: Account | `workspace:show_settings_account_page` | | `F3` | Find the Next Occurrence of Your Search Query | `find:find_next_occurrence` | | `CTRL-SHIFT-P` | Toggle Command Palette | `workspace:toggle_command_palette` | @@ -347,8 +347,8 @@ Keybinds that conflict with others are highlighted with an orange border. | `CTRL-SHIFT-C` | Copy | `terminal:copy` | | `CTRL-SHIFT-F` | Find | `terminal:find` | | `CTRL-SHIFT-V` | Paste | `terminal:paste` | - | `CTRL-SHIFT-T` | Open New Tab | `workspace:open_new_tab` | - | `CTRL-ALT-T` | Reopen Closed Tab | `workspace:reopen_closed_tab` | + | `CTRL-SHIFT-T` | Open New Tab | `workspace:new_tab` | + | `CTRL-ALT-T` | Reopen Closed Tab | `app:reopen_closed_session` | | `CTRL-SHIFT-LEFT` | Move Tab Left | `workspace:move_tab_left` | | `CTRL-SHIFT-RIGHT` | Move Tab Right | `workspace:move_tab_right` | | `CTRL-PAGEUP` | Activate Previous Tab | `workspace:activate_prev_tab` | @@ -366,8 +366,8 @@ Keybinds that conflict with others are highlighted with an orange border. | `CTRL-SHIFT-R` | Workflows | `input:toggle_workflows` | | `` CTRL-` `` | Generate | `input:toggle_natural_language_command_search` | | `CTRL-SHIFT-L` | Focus Terminal Input | `terminal:focus_input` | - | `CTRL-I` | Warpify Subshell | `terminal:trigger_subshell_bootstrap` | - | `CTRL-SHIFT-\` | Warp Drive | `terminal:toggle_warp_drive` | + | `CTRL-I` | Warpify Subshell | `terminal:warpify_subshell` | + | `CTRL-SHIFT-\` | Warp Drive | `workspace:toggle_warp_drive` | **Blocks** @@ -385,7 +385,7 @@ Keybinds that conflict with others are highlighted with an orange border. | | Open Block Context Menu | `terminal:open_block_list_context_menu_via_keybinding` | | `CTRL-SHIFT-C` | Copy Command | `terminal:copy_commands` | | | Reinput Selected Commands as Root | `terminal:reinput_commands_with_sudo` | - | `CTRL-SHIFT-S` | Share Selected Block | `terminal:open_share_modal` | + | `CTRL-SHIFT-S` | Share Selected Block | `terminal:open_share_block_modal` | | `SHIFT-DOWN` | Expand Selected Blocks Below | `terminal:expand_block_selection_below` | | `SHIFT-UP` | Expand Selected Blocks Above | `terminal:expand_block_selection_above` | @@ -393,10 +393,10 @@ Keybinds that conflict with others are highlighted with an orange border. | Shortcut | Command | Action | | ------------------ | -------------------------------------------- | --------------------------------------------------------- | - | `PAGE UP` | Scroll Up One Page | `terminal:page_up` | - | `PAGE DOWN` | Scroll Down One Page | `terminal:page_down` | - | `HOME` | Scroll to Top | `terminal:home` | - | `END` | Scroll to Bottom | `terminal:end` | + | `PAGE UP` | Scroll Up One Page | `terminal:scroll_up_one_page` | + | `PAGE DOWN` | Scroll Down One Page | `terminal:scroll_down_one_page` | + | `HOME` | Scroll to Top | | + | `END` | Scroll to Bottom | | | `CTRL-SHIFT-UP` | Scroll to Top of Selected Block | `terminal:scroll_to_top_of_selected_block` | | `CTRL-SHIFT-DOWN` | Scroll to Bottom of Selected Block | `terminal:scroll_to_bottom_of_selected_block` | | | Scroll Terminal Output Up One Line | `terminal:scroll_up_one_line` | @@ -419,7 +419,7 @@ Keybinds that conflict with others are highlighted with an orange border. | `CTRL-Y` | Delete All Left | `editor_view:delete_all_left` | | | Delete All Right | `editor_view:delete_all_right` | | `CTRL-END` | Move Cursor to the Bottom | `editor_view:cmd_down` | - | `CTRL-I` | Inspect Command | `editor_view:cmd_i` | + | `CTRL-I` | Inspect Command | `editor_view:inspect_command` | | `HOME` | Home | `editor_view:home` | | `END` | End | `editor_view:end` | | `CTRL-A` | Move to Start of Line | `editor_view:move_to_line_start` | @@ -439,9 +439,9 @@ Keybinds that conflict with others are highlighted with an orange border. | `CTRL-SHIFT-B` | Select One Character to the Left | `editor_view:select_left` | | `CTRL-SHIFT-DOWN` | Add Cursor Below | `editor_view:add_cursor_below` | | | Select to End of Line | `editor:select_to_line_end` | - | `CTRL-Z` | Undo | `editor:undo` | - | `CTRL-SHIFT-Z` | Redo | `editor:redo` | - | `CTRL-SHIFT-F` | Select One Character to the Right | `editor:select_right` | + | `CTRL-Z` | Undo | | + | `CTRL-SHIFT-Z` | Redo | | + | `CTRL-SHIFT-F` | Select One Character to the Right | `editor_view:select_right` | | | Select Down | `editor_view:select_down` | | `CTRL-SHIFT-P` | Select Up | `editor_view:select_up` | | `CTRL-SHIFT-UP` | Add Cursor Above | `editor_view:add_cursor_above` | @@ -470,7 +470,7 @@ Keybinds that conflict with others are highlighted with an orange border. | `CTRL-ALT-UP` | Switch Panes Up | `pane_group:navigate_up` | | `CTRL-ALT-V` | \[a11y] Set Concise Accessibility Announcements | `workspace:set_a11y_concise_verbosity_level` | | `CTRL-ALT-V` | \[a11y] Set Verbose Accessibility Announcements | `workspace:set_a11y_verbose_verbosity_level` | - | `CTRL-,` | Open Settings | `workspace:show_settings_modal` | + | `CTRL-,` | Open Settings | `workspace:show_settings` | | `CTRL-,` | Open Settings: Account | `workspace:show_settings_account_page` | | `F3` | Find the Next Occurrence of Your Search Query | `find:find_next_occurrence` | | `CTRL-SHIFT-P` | Toggle Command Palette | `workspace:toggle_command_palette` | @@ -507,8 +507,8 @@ Keybinds that conflict with others are highlighted with an orange border. | `CTRL-SHIFT-C` | Copy | `terminal:copy` | | `CTRL-SHIFT-F` | Find | `terminal:find` | | `CTRL-SHIFT-V` | Paste | `terminal:paste` | - | `CTRL-SHIFT-T` | Open New Tab | `workspace:open_new_tab` | - | `CTRL-ALT-T` | Reopen Closed Tab | `workspace:reopen_closed_tab` | + | `CTRL-SHIFT-T` | Open New Tab | `workspace:new_tab` | + | `CTRL-ALT-T` | Reopen Closed Tab | `app:reopen_closed_session` | | `CTRL-SHIFT-LEFT` | Move Tab Left | `workspace:move_tab_left` | | `CTRL-SHIFT-RIGHT` | Move Tab Right | `workspace:move_tab_right` | | `CTRL-PAGEUP` | Activate Previous Tab | `workspace:activate_prev_tab` | diff --git a/src/content/docs/terminal/settings/all-settings.mdx b/src/content/docs/terminal/settings/all-settings.mdx index b8bdbbfa6..23704ac10 100644 --- a/src/content/docs/terminal/settings/all-settings.mdx +++ b/src/content/docs/terminal/settings/all-settings.mdx @@ -21,6 +21,7 @@ Top-level settings that control Warp's startup behavior, session management, and * `login_item` — Whether to launch Warp automatically when you log in. Type: boolean. Default: `true`. * `mouse_scroll_multiplier` — The scroll speed multiplier for mouse scroll events. Type: number. Default: `3.0`. * `new_tab_placement` — Where new tabs are placed in the tab bar. Type: string. Default: `"after_current_tab"`. Options: `"after_current_tab"`, `"after_all_tabs"`. +* `preserve_input_focus_on_block_selection` — Whether the input box keeps focus when you select a block. Type: boolean. Default: `false`. * `quit_on_last_window_closed` — Whether to quit Warp when the last window is closed. Type: boolean. Default: `false`. * `restore_session` — Whether to restore the previous session when Warp starts up. Type: boolean. Default: `true`. * `should_confirm_close_session` — Whether to show a confirmation dialog when closing a session. Type: boolean. Default: `true`. @@ -100,6 +101,7 @@ theme = { custom = { name = "My Theme", path = "~/.warp/themes/my-theme.yaml" } * `tab_close_button_position` — Position of the close button on tabs. Type: string. Default: `"right"`. Options: `"right"`, `"left"`. * `show_indicators_button` — Whether to show activity indicators on tabs. Type: boolean. Default: `true`. * `preserve_active_tab_color` — Whether to preserve the active tab's color when switching tabs. Type: boolean. Default: `false`. +* `directory_tab_colors` — Mapping of directory paths to their tab color assignments, populated when you assign tab colors by directory. Type: object. Default: `{}`. * `header_toolbar_chip_selection` — Configuration for the header toolbar chips in the vertical tab panel header. Type: string or object. Default: `"default"`. ### Vertical tabs @@ -116,6 +118,8 @@ theme = { custom = { name = "My Theme", path = "~/.warp/themes/my-theme.yaml" } * `show_diff_stats` — Whether to show diff stats on vertical tabs. Type: boolean. Default: `true`. * `show_pr_link` — Whether to show PR links on vertical tabs. Type: boolean. Default: `true`. * `use_latest_prompt_as_title` — Whether vertical tab names for agent conversations use the latest user prompt. Type: boolean. Default: `false`. +* `hide_title_bar_search_bar` — Whether to hide the title bar search bar when using the vertical tab layout. Search stays available via the Command Palette and keyboard shortcuts. Type: boolean. Default: `false`. +* `show_panel_in_restored_windows` — Whether restored windows open the vertical tabs panel even if it was closed when the session was saved. Type: boolean. Default: `false`. ### Panes @@ -141,6 +145,7 @@ theme = { custom = { name = "My Theme", path = "~/.warp/themes/my-theme.yaml" } **Section**: `[appearance.icon]` * `app_icon` — The app icon displayed in the dock. Type: string. Default: `"default"`. Options: `"default"`, `"aurora"`, `"classic1"`, `"classic2"`, `"classic3"`, `"comets"`, `"cow"`, `"glass_sky"`, `"glitch"`, `"glow"`, `"holographic"`, `"mono"`, `"neon"`, `"original"`, `"starburst"`, `"sticker"`, `"warp_one"`. +* `show_dock_icon` — Whether Warp is shown in the macOS Dock and `Cmd-Tab` switcher. Type: boolean. Default: `true`. macOS only. ### Window @@ -166,6 +171,7 @@ Settings that control terminal behavior, input, and event handling. * `mouse_reporting_enabled` — Whether to forward mouse events to full-screen terminal applications. Type: boolean. Default: `true`. * `scroll_reporting_enabled` — Whether to forward scroll events to full-screen terminal applications. Type: boolean. Default: `true`. * `maximum_grid_size` — The maximum number of rows in the terminal grid. Type: integer. Default: `50000`. +* `osc52_clipboard_access` — Whether terminal programs can access the system clipboard via OSC 52 escape sequences. Type: string. Default: `"deny"`. Options: `"deny"`, `"write_only"`, `"read_write"`. * `use_audible_bell` — Whether to play an audible bell sound on terminal bell events. Type: boolean. Default: `false`. * `show_terminal_zero_state_block` — Whether to show the AI zero-state block in new terminal sessions. Type: boolean. Default: `true`. @@ -293,6 +299,8 @@ Settings for Warp's agents, including model behavior, permissions, knowledge, MC * `code_suggestions_enabled` — Controls whether AI code suggestions are enabled. Type: boolean. Default: `true`. * `intelligent_autosuggestions_enabled` — Controls whether AI-powered intelligent autosuggestions are enabled. Type: boolean. Default: `true`. * `agent_mode_query_suggestions_enabled` — Controls whether prompt suggestions are shown in Agent Mode. Type: boolean. Default: `true`. +* `git_operations_autogen_enabled` — Whether AI auto-generates commit messages and PR titles and bodies in the code review dialogs. Type: boolean. Default: `true`. +* `rule_suggestions_enabled` — Whether the agent suggests rules to save after responses. Type: boolean. Default: `true`. * `shared_block_title_generation_enabled` — Controls whether titles are auto-generated when sharing blocks. Type: boolean. Default: `true`. #### Input @@ -318,14 +326,13 @@ Settings for Warp's agents, including model behavior, permissions, knowledge, MC * `should_show_oz_updates_in_zero_state` — Whether the "What's new" section is shown in the agent view. Type: boolean. Default: `true`. * `should_render_use_agent_toolbar_for_user_commands` — Whether to show the "Use Agent" footer for terminal commands. Type: boolean. Default: `true`. * `cloud_agent_computer_use_enabled` — Whether computer use is enabled for cloud agent conversations. Type: boolean. Default: `false`. - -### Code review autogeneration - -Controls AI-driven autogeneration in the code review dialogs. This setting currently lives under `[agents.oz.active_ai]` rather than alongside the other `[agents.warp_agent.active_ai]` settings. - -**Section**: `[agents.oz.active_ai]` - -* `git_operations_autogen_enabled` — Controls whether AI auto-generates commit messages and PR title and body in the code review dialogs. Type: boolean. Default: `true`. +* `agent_attribution_enabled` — Whether the Warp Agent adds an attribution co-author line to commit messages and pull requests it creates. Type: boolean. Default: `true`. +* `auto_handoff_on_sleep_enabled` — Whether Warp automatically hands off local agent conversations to the cloud when your computer is about to sleep (macOS). See [local-to-cloud handoff](/agent-platform/cloud-agents/handoff/local-to-cloud/). Type: boolean. Default: `false`. +* `default_prompt_submission_mode` — Default behavior when submitting a new prompt while the agent is still responding. See [Prompt Queueing](/agent-platform/local-agents/interacting-with-agents/prompt-queueing/). Type: string. Default: `"interrupt"`. Options: `"interrupt"`, `"queue"`. +* `long_running_command_submission_mode` — What happens when you submit a prompt while the agent is running an agent-requested long-running command. Only applies when `default_prompt_submission_mode` is `"interrupt"`. See [Prompt Queueing](/agent-platform/local-agents/interacting-with-agents/prompt-queueing/). Type: string. Default: `"queue_until_command_completes"`. Options: `"send_immediately"`, `"queue_until_command_completes"`. +* `orchestration_message_display_mode` — How child-agent message bodies are displayed during [multi-agent runs](/agent-platform/cloud-agents/orchestration/multi-agent-runs/). Type: string. Default: `"always_collapse"`. Options: `"show_and_collapse"`, `"always_show"`, `"always_collapse"`. +* `should_force_disable_cloud_handoff` — Whether to force-disable [local-to-cloud handoff](/agent-platform/cloud-agents/handoff/local-to-cloud/). Type: boolean. Default: `false`. +* `should_force_disable_ampersand_handoff` — Whether to force-disable the `&` prefix that composes a prompt for cloud handoff. Type: boolean. Default: `false`. ### Third-party (CLI agents) @@ -337,6 +344,7 @@ Controls AI-driven autogeneration in the code review dialogs. This setting curre * `auto_dismiss_composer_after_submit` — Whether CLI agent Rich Input automatically closes after the user submits a prompt. Type: boolean. Default: `false`. * `cli_agent_toolbar_chip_selection_setting` — Controls the layout of context chips in the CLI Agent toolbar. Type: string or object. Default: `"default"`. * `cli_agent_toolbar_enabled_commands` — Maps custom toolbar command patterns to specific CLI agents. Type: object. Default: `{}`. +* `submit_on_ctrl_enter` — Whether the CLI agent Rich Input editor submits on `Ctrl+Enter` instead of `Enter` (with `Enter` inserting a newline). Type: boolean. Default: `false`. ### Voice @@ -365,7 +373,9 @@ Settings for Warp's built-in code editor, file handling, and codebase indexing. * `show_code_review_diff_stats` — Whether to show lines added/removed counts on the code review button. Type: boolean. Default: `true`. * `show_project_explorer` — Whether the project explorer is shown in the tools panel. Type: boolean. Default: `true`. * `show_global_search` — Whether global file search is shown in the tools panel. Type: boolean. Default: `true`. +* `show_hidden_files` — Whether hidden files (dotfiles) are shown in the project explorer. Type: boolean. Default: `false`. * `use_warp_as_default_editor` — Whether Warp is used as the default code editor. Type: boolean. Default: `false`. +* `format_on_save` — Whether the language server automatically formats the file on save. Other LSP features (hover, go-to-definition, references, diagnostics) are unaffected. Type: boolean. Default: `true`. ### Indexing @@ -437,6 +447,7 @@ Low-level system and rendering settings. * `prefer_low_power_gpu` — Whether to prefer the integrated (low-power) GPU. Type: boolean. Default: `false`. * `preferred_graphics_backend` — The preferred graphics backend (Windows). Type: string or null. Default: `null`. Options: `"dx12"`, `"vulkan"`, `"gl"`, `"metal"`, `null`. * `linux_selection_clipboard` — Whether the Linux primary selection clipboard is used. Type: boolean. Default: `true`. +* `force_x11` — Whether to force X11 instead of Wayland on Linux. Type: boolean. Default: `true` (`false` under WSL). ## Text editing @@ -444,11 +455,20 @@ Settings that control text editing behavior in the input editor. **Section**: `[text_editing]` +* `code_editor_line_number_mode` — How line numbers are displayed in code editors. Type: string. Default: `"absolute"`. Options: `"absolute"`, `"relative"`. * `vim_mode_enabled` — Whether Vim keybindings are enabled. Type: boolean. Default: `false`. * `vim_status_bar` — Whether the Vim status bar is displayed. Type: boolean. Default: `true`. * `vim_unnamed_system_clipboard` — Whether the Vim unnamed register uses the system clipboard. Type: boolean. Default: `false`. * `autocomplete_symbols` — Whether matching symbols like brackets and quotes are auto-completed. Type: boolean. Default: `true`. +## Experimental + +Opt-in settings for features that are still being refined. + +**Section**: `[experimental]` + +* `async_find_enabled` — Use an improved implementation of find that keeps the UI responsive while searching large outputs. Type: boolean. Default: `false`. + ## Warp Drive Settings for Warp Drive (shared workflows, notebooks, and prompts). @@ -469,6 +489,7 @@ Settings for Warp features in SSH sessions and subshells. * `enable_ssh_warpification` — Whether to enable Warp features in SSH sessions. Type: boolean. Default: `true`. * `enable_legacy_ssh_wrapper` — Whether the legacy SSH wrapper is enabled for SSH sessions. Type: boolean. Default: `true`. * `use_ssh_tmux_wrapper` — Whether to use a tmux-based wrapper for SSH warpification. Type: boolean. Default: `false`. +* `reuse_existing_control_master` — Whether the legacy SSH wrapper attaches to an existing SSH `ControlMaster` for the destination host instead of always creating its own. Type: boolean. Default: `false`. * `ssh_extension_install_mode` — Controls SSH extension installation behavior. Type: string. Default: `"always_ask"`. Options: `"always_ask"` (always prompt before installing), `"always_install"` (auto-install and connect without prompting), `"never_install"` (fall back to legacy warpification). * `ssh_hosts_denylist` — SSH hosts that should not trigger the warpification prompt. Type: array of strings. Default: `[]`. @@ -515,6 +536,7 @@ Settings for third-party API key integration and cloud model configuration. * `aws_bedrock_profile` — The AWS profile name to use for Bedrock credentials. Type: string. Default: `"default"`. * `aws_bedrock_auto_login` — Whether to automatically run the AWS login command when Bedrock credentials expire. Type: boolean. Default: `false`. * `aws_bedrock_auth_refresh_command` — The command to run to refresh AWS credentials for Bedrock. Type: string. Default: `"aws login"`. +* `gemini_enterprise_credentials_enabled` — Whether Warp routes eligible requests through your workspace's Gemini Enterprise Google Cloud project. Requires a workspace admin to configure Gemini Enterprise. Type: boolean. Default: `false`. * `can_use_warp_credits_with_byok` — Whether Warp credits can be used even when providing your own API key. Type: boolean. Default: `false`. ## Global hotkey