diff --git a/src/content/docs/agent-platform/capabilities/agent-notifications.mdx b/src/content/docs/agent-platform/capabilities/agent-notifications.mdx index db53795d..57f1e9c5 100644 --- a/src/content/docs/agent-platform/capabilities/agent-notifications.mdx +++ b/src/content/docs/agent-platform/capabilities/agent-notifications.mdx @@ -52,7 +52,7 @@ The mailbox includes: * `↑` / `↓` - select previous / next notification * `Enter` - open the selected notification's session -* `Shift-Tab` - cycle through filter tabs +* `Shift+Tab` - cycle through filter tabs * `Esc` - close the mailbox ### Tab status indicators @@ -114,7 +114,7 @@ That means: * [Desktop Notifications](/terminal/more-features/notifications/) - configure system-level notification permissions and troubleshoot delivery * [Managing Agents](/agent-platform/cloud-agents/managing-cloud-agents/) - monitor all agent conversations, filter by status, and inspect sessions * [Multi-agent orchestration](/agent-platform/cloud-agents/orchestration/) - parent/child model, run state transitions, and the orchestration pill bar -* [Third-Party CLI Agents](/agent-platform/cli-agents/overview/) - overview of supported CLI agents and Warp features +* [Third-party CLI agents](/agent-platform/cli-agents/overview/) - overview of supported CLI agents and Warp features * [Claude Code](/agent-platform/cli-agents/claude-code/) - setup and notification plugin installation * [Codex](/agent-platform/cli-agents/codex/) - setup and notification configuration * [OpenCode](/agent-platform/cli-agents/opencode/) - setup and notification plugin installation diff --git a/src/content/docs/agent-platform/capabilities/codebase-context.mdx b/src/content/docs/agent-platform/capabilities/codebase-context.mdx index 3d2eebb0..b864ca79 100644 --- a/src/content/docs/agent-platform/capabilities/codebase-context.mdx +++ b/src/content/docs/agent-platform/capabilities/codebase-context.mdx @@ -32,7 +32,7 @@ git clone https://github.com/vercel/next.js.git && cd next.js ## Indexing your codebase -When you open a directory in Warp, we check if it is part of a Git repository. If it is, Warp begins indexing the source code to provide rich context for Agents. Warp also detects [Git worktree](/code/git-worktrees/) checkouts — each worktree is indexed as its own repository, so Agents always have accurate context for the branch you're working on. +When you open a directory in Warp, we check if it is part of a Git repository. If it is, Warp begins indexing the source code to provide rich context for Agents. Warp also detects [Git worktree](/code/git-worktrees/) checkouts — each worktree is indexed as its own repository, so Agents always have accurate context for the branch you're working on. :::note Code indexed with Codebase Context is never stored on our servers. Codebase Context works with both local agent sessions and [cloud agent runs](/agent-platform/cloud-agents/overview/). Without Codebase Context enabled, agents will still be able use terminal commands (i.e. `grep`, `sed`) to navigate your code. @@ -73,7 +73,7 @@ You can view and manage your indexed codebases in **Settings** > **Code** > **In -### **Codebase indexing states** +### Codebase indexing states When viewing indexed codebases in Warp under **Settings** > **Code** > **Indexing and projects**, you may see different status indicators: @@ -127,7 +127,7 @@ Codebase Context is available in all cloud agent runs — including runs trigger ## Multi-repo context -Warp supports referencing context across multiple indexed repositories. Note that you don’t need to be inside a specific repo for agents to use its context. +Warp supports referencing context across multiple indexed repositories. Note that you don’t need to be inside a specific repo for agents to use its context. **This is especially useful when:** diff --git a/src/content/docs/agent-platform/capabilities/full-terminal-use.mdx b/src/content/docs/agent-platform/capabilities/full-terminal-use.mdx index 9082097f..8245a4c4 100644 --- a/src/content/docs/agent-platform/capabilities/full-terminal-use.mdx +++ b/src/content/docs/agent-platform/capabilities/full-terminal-use.mdx @@ -31,7 +31,7 @@ You can either ask the agent to run an interactive command, or start one manuall * “Start the dev server and debug this 500 error.” * **Or start the command yourself, then tag the agent in** * Example: - * If you’ve already launched an interactive tool (for example `psql` or `npm run dev`), you can bring the agent into the running session using the "Use Agent" button in the terminal footer or via `CMD + I` . + * If you’ve already launched an interactive tool (for example `psql` or `npm run dev`), you can bring the agent into the running session using the **Use Agent** button in the terminal footer or via `Cmd+I`.
![Option to tag the agent into a running command.](../../../../assets/agent-platform/full-terminal-use-tag-hint.png) diff --git a/src/content/docs/agent-platform/capabilities/mcp.mdx b/src/content/docs/agent-platform/capabilities/mcp.mdx index 5ba7549a..df016e3a 100644 --- a/src/content/docs/agent-platform/capabilities/mcp.mdx +++ b/src/content/docs/agent-platform/capabilities/mcp.mdx @@ -7,7 +7,7 @@ description: >- import { Tabs, TabItem } from '@astrojs/starlight/components'; import DemoVideo from '@components/DemoVideo.astro'; -MCP servers extend Warp's [local agents](/agent-platform/local-agents/interacting-with-agents/) in a modular, flexible way by exposing custom tools or data sources through a standardized interface — essentially acting as plugins for Warp. Warp supports a variety of connection protocols, including Streamable HTTPS and SSE, along with custom headers and environment variables. +MCP servers extend Warp's [local agents](/agent-platform/local-agents/interacting-with-agents/) in a modular, flexible way by exposing custom tools or data sources through a standardized interface — essentially acting as plugins for Warp. Warp supports a variety of connection protocols, including Streamable HTTP and SSE, along with custom headers and environment variables. MCP is an open source protocol. Check out the official [MCP documentation](https://modelcontextprotocol.io/introduction) for more detailed information on how this protocol is engineered. @@ -33,7 +33,7 @@ This will show a list of all configured MCP servers, including which are current ### Adding an MCP Server -To add a new MCP server, you can click the **+ Add** button. Configurations from most MCP Clients can be directly copied and pasted. +To add a new MCP server, you can click the **+ Add** button. Configurations from most MCP clients can be directly copied and pasted. MCP server types you can add: @@ -78,9 +78,9 @@ MCP server types you can add: ### Adding multiple MCP servers -Warp supports configuring **multiple MCP servers** using a JSON snippet. Each entry under `mcpServers` is keyed by a unique name (`filesystem`, `github`, `notes`, etc). All servers defined in the example are added automatically — no manual setup required. +Warp supports configuring **multiple MCP servers** using a JSON snippet. Each entry under `mcpServers` is keyed by a unique name (`filesystem`, `github`, `notes`, etc.). All servers defined in the example are added automatically — no manual setup required. -To add a multiple MCP servers, you can click the **+ Add** button then paste in a JSON snippet like the example below: +To add multiple MCP servers, you can click the **+ Add** button then paste in a JSON snippet like the example below: ```json { @@ -167,15 +167,15 @@ File-based servers that require OAuth show an authentication modal on their firs After MCP servers are registered in Warp, you can **Start** or **Stop** them from the MCP servers page. Each running server will have a list of available tools and resources. -You can rename and edit a server's name, as well as delete the server. If you are a part of a Team, you can also share a MCP with your teammates. +You can rename and edit a server's name, as well as delete the server. If you are a part of a Team, you can also share an MCP server with your teammates. ### Sharing MCP servers MCP servers can be shared with your teammates by clicking the share icon. When sharing, sensitive values in the `env` configuration will be automatically scrubbed and replaced with variables.
-![Sharing a MCP Server](../../../../assets/agent-platform/mcp-servers-share.png) -
Sharing a MCP Server.
+![Sharing an MCP Server](../../../../assets/agent-platform/mcp-servers-share.png) +
Sharing an MCP Server.
Your teammates can find shared MCP servers under the `Shared` section of their MCP settings. When your teammates install your server configuration, they will be prompted to enter any scrubbed `env` values. @@ -194,7 +194,7 @@ Most MCP servers require authentication to connect to external services. Warp su ### Debugging MCP -If you're having trouble with an MCP server, you can check the logs for any errors or messages to help you diagnose the problem by clicking the `View Logs` button on a server from the MCP servers page. +If you're having trouble with an MCP server, you can check the logs for any errors or messages to help you diagnose the problem by clicking the **View Logs** button on a server from the MCP servers page. :::caution If you choose to share your MCP server logs with anybody, **make sure to remove any sensitive information before sharing**, as they may contain API keys. @@ -206,9 +206,9 @@ Many SSE based MCP servers will state that your URL should be treated like a pas Tip: We've noticed that some models often work better with MCP servers than others. If you're having trouble calling or using an MCP server, try using a different model. ::: -#### Debugging MCP Authentication issues +#### Debugging MCP authentication issues -In some cases you may need to reset the auth token for some MCP servers. To do this delete the local MCP auth files by running the following: `rm -rf ~/.mcp-auth` +In some cases you may need to reset the auth token for some MCP servers. To do this, delete the local MCP auth files by running the following: `rm -rf ~/.mcp-auth` :::caution Note this will delete all your MCP auth tokens stored locally so you will need to login and re-authenticate. diff --git a/src/content/docs/agent-platform/capabilities/rules.mdx b/src/content/docs/agent-platform/capabilities/rules.mdx index cf14c2c4..9eb1ac08 100644 --- a/src/content/docs/agent-platform/capabilities/rules.mdx +++ b/src/content/docs/agent-platform/capabilities/rules.mdx @@ -24,6 +24,7 @@ Global Rules apply across all projects and contexts. They're ideal for: * Tool configurations or preferences you want applied everywhere Warp may also suggest Global Rules based on your usage patterns to make future interactions smarter and more consistent. + ## Project Rules Project Rules live in your codebase and apply automatically when working within that project. They're stored in an `AGENTS.md` file (or `WARP.md` for backwards compatibility) and can be: @@ -66,7 +67,7 @@ How Warp applies these Project Rules: * Automatically applied: `project/AGENTS.md` and `project/api/AGENTS.md` * Best effort: `project/ui/AGENTS.md` if editing files there -### **Rules precedence** +### Rules precedence When multiple rules apply, Warp follows this order of precedence: @@ -84,8 +85,8 @@ This ensures the most specific, project-relevant rules take priority over broade * From the [Command Palette](/terminal/command-palette/): search for "Open AI Rules" * From the Settings panel: **Settings** > **Agents** > **Knowledge** > **Manage Rules** * Here, you can manage both Global as well as Project Rules. -* From the macOS Menu: `AI > Open Rules` -* From the Slash Commands menu: `/open-project-rules` to open Project Rules directly in Warp's code editor +* From the Warp menu bar: **AI** > **Open Rules** +* From the Slash Commands menu: `/open-project-rules` to open Project Rules directly in Warp's code editor
![Project Rules UI open in a Rules pane](../../../../assets/agent-platform/project-scoped-rules-pane.png) @@ -110,7 +111,7 @@ This ensures the most specific, project-relevant rules take priority over broade * Begin indexing your codebase or display indexing status * Generate an `AGENTS.md` file with initial context, or * Link an existing Rules file to `AGENTS.md` - * Warp currently supports linking the following external Rules files: `CLAUDE.md`, `.cursorrules`, `AGENT.md`, `GEMINI.md`, `.clinerules`, `.windsurfrules`, `.github/copilot-instructions.md` + * Warp currently supports linking the following external Rules files: `CLAUDE.md`, `.cursorrules`, `AGENT.md`, `GEMINI.md`, `.clinerules`, `.windsurfrules`, `.github/copilot-instructions.md` To view all Project Rules and open them in Warp, access it via the Warp Drive Rules pane: **Personal** > **Rules** > **Project-based** @@ -130,4 +131,4 @@ When relevant, Agents automatically pull in applicable rules to guide their resp ### Rules privacy -See our [Privacy Page](/support-and-community/privacy-and-security/privacy/) for more information on how we handle data with Rules. +See our [Privacy page](/support-and-community/privacy-and-security/privacy/) for more information on how we handle data with Rules. diff --git a/src/content/docs/agent-platform/capabilities/web-search.mdx b/src/content/docs/agent-platform/capabilities/web-search.mdx index 8d6aada0..49c3fbb1 100644 --- a/src/content/docs/agent-platform/capabilities/web-search.mdx +++ b/src/content/docs/agent-platform/capabilities/web-search.mdx @@ -22,7 +22,7 @@ Models initiate a web search when it improves the quality or accuracy of an answ * Retrieving official documentation or API references * Getting the latest version of a library or tool -* Checking error messages, GitHub issues, or StackOverflow discussions +* Checking error messages, GitHub issues, or Stack Overflow discussions * Looking up ongoing incidents or recent changes * Answering questions where recency matters (e.g., “best approach in 2025 to…”) diff --git a/src/content/docs/agent-platform/cli-agents/claude-code.mdx b/src/content/docs/agent-platform/cli-agents/claude-code.mdx index 1707dd17..4094ff79 100644 --- a/src/content/docs/agent-platform/cli-agents/claude-code.mdx +++ b/src/content/docs/agent-platform/cli-agents/claude-code.mdx @@ -73,7 +73,7 @@ Claude Code supports the full set of Warp's agent integration features: * [How to set up Claude Code](/guides/external-tools/how-to-set-up-claude-code/) — step-by-step setup guide * [Claude Code in Warp](https://www.warp.dev/agents/claude-code) — product overview -* [Third-Party CLI Agents Overview](/agent-platform/cli-agents/overview/) — supported CLI agent integrations +* [Third-party CLI agents overview](/agent-platform/cli-agents/overview/) — supported CLI agent integrations * [Claude Code with Oz](/agent-platform/cloud-agents/harnesses/claude-code/) — Claude Code as a cloud harness * [OpenCode](/agent-platform/cli-agents/opencode/) — OpenCode in Warp * [Codex](/agent-platform/cli-agents/codex/) — Codex in Warp diff --git a/src/content/docs/agent-platform/cli-agents/codex.mdx b/src/content/docs/agent-platform/cli-agents/codex.mdx index 530918be..068e254b 100644 --- a/src/content/docs/agent-platform/cli-agents/codex.mdx +++ b/src/content/docs/agent-platform/cli-agents/codex.mdx @@ -48,7 +48,7 @@ Codex supports the full set of Warp's agent integration features: * [How to set up Codex CLI](/guides/external-tools/how-to-set-up-codex-cli/) — step-by-step setup guide * [Codex in Warp](https://www.warp.dev/agents/codex) — product overview -* [Third-Party CLI Agents Overview](/agent-platform/cli-agents/overview/) — supported CLI agent integrations +* [Third-party CLI agents overview](/agent-platform/cli-agents/overview/) — supported CLI agent integrations * [Codex with Oz](/agent-platform/cloud-agents/harnesses/codex/) — Codex as a cloud harness * [Claude Code](/agent-platform/cli-agents/claude-code/) — Claude Code in Warp * [OpenCode](/agent-platform/cli-agents/opencode/) — OpenCode in Warp diff --git a/src/content/docs/agent-platform/cli-agents/opencode.mdx b/src/content/docs/agent-platform/cli-agents/opencode.mdx index c0111866..e4c94a96 100644 --- a/src/content/docs/agent-platform/cli-agents/opencode.mdx +++ b/src/content/docs/agent-platform/cli-agents/opencode.mdx @@ -45,6 +45,6 @@ OpenCode supports the full set of Warp's agent integration features: * [How to set up OpenCode](/guides/external-tools/how-to-set-up-opencode/) — step-by-step setup guide * [OpenCode in Warp](https://www.warp.dev/agents/opencode) — product overview -* [Third-Party CLI Agents Overview](/agent-platform/cli-agents/overview/) +* [Third-party CLI agents overview](/agent-platform/cli-agents/overview/) * [Claude Code](/agent-platform/cli-agents/claude-code/) * [Codex](/agent-platform/cli-agents/codex/) diff --git a/src/content/docs/agent-platform/cli-agents/remote-control.mdx b/src/content/docs/agent-platform/cli-agents/remote-control.mdx index 1f092af8..f1cdc009 100644 --- a/src/content/docs/agent-platform/cli-agents/remote-control.mdx +++ b/src/content/docs/agent-platform/cli-agents/remote-control.mdx @@ -6,7 +6,7 @@ description: >- --- import VideoEmbed from '@components/VideoEmbed.astro'; -Remote Control lets you publish a running third-party agent session — such as Claude Code, Codex, or OpenCode — to the cloud with a single click. Once published, you can monitor progress, review output, and steer the agent from your phone, a web browser, or another computer without staying at the original machine. See [Third-Party CLI Agents](/agent-platform/cli-agents/overview/) for the full list of supported agents. +Remote Control lets you publish a running third-party agent session — such as Claude Code, Codex, or OpenCode — to the cloud with a single click. Once published, you can monitor progress, review output, and steer the agent from your phone, a web browser, or another computer without staying at the original machine. See [Third-party CLI agents](/agent-platform/cli-agents/overview/) for the full list of supported agents. This is especially useful for long-running agent tasks. Start a coding agent, publish the session, and check back whenever you want. @@ -67,5 +67,5 @@ Only you (the publisher) can revoke access or stop publishing the session. ## Related pages * [Agent Session Sharing](/agent-platform/local-agents/session-sharing/) -* [Third-Party CLI Agents](/agent-platform/cli-agents/overview/) +* [Third-party CLI agents](/agent-platform/cli-agents/overview/) * [Viewing Cloud Agent Runs](/agent-platform/cloud-agents/viewing-cloud-agent-runs/) diff --git a/src/content/docs/agent-platform/cli-agents/rich-input.mdx b/src/content/docs/agent-platform/cli-agents/rich-input.mdx index c12e1c92..f26ab488 100644 --- a/src/content/docs/agent-platform/cli-agents/rich-input.mdx +++ b/src/content/docs/agent-platform/cli-agents/rich-input.mdx @@ -56,7 +56,7 @@ In the Warp app, go to **Settings** > **Agents** > **Third party CLI agents** to ## Related pages -* [Third-Party CLI Agents Overview](/agent-platform/cli-agents/overview/) +* [Third-party CLI agents overview](/agent-platform/cli-agents/overview/) * [Remote Control](/agent-platform/cli-agents/remote-control/) * [Voice](/agent-platform/local-agents/interacting-with-agents/voice/) * [Slash Commands](/agent-platform/capabilities/slash-commands/) diff --git a/src/content/docs/agent-platform/cloud-agents/environments.mdx b/src/content/docs/agent-platform/cloud-agents/environments.mdx index cdd1440b..b4271395 100644 --- a/src/content/docs/agent-platform/cloud-agents/environments.mdx +++ b/src/content/docs/agent-platform/cloud-agents/environments.mdx @@ -42,7 +42,7 @@ Use the Docker image for language runtimes, package managers, system libraries, :::note Configuring runtime settings: -* **Environment variables**: Configure these in your Dockerfile using Docker’s \`ENV\` directives or pass them when running the container. +* **Environment variables**: Configure these in your Dockerfile using Docker’s `ENV` directives or pass them when running the container. * **Secrets**: For credentials and sensitive data, use [Agent Secrets](/agent-platform/cloud-agents/secrets/). These are configured separately from environments and injected securely at runtime. ::: @@ -118,13 +118,13 @@ Choose an environment if any of the following apply: * Runs must be consistent across triggers/hosts. The workflow should behave the same regardless of where it is triggered from. * The toolchain must be fixed. You need a known image and deterministic setup steps to avoid “it works on my machine” drift. -* The workflow is shared across a team. Multiple people, or systems, will run the workflow and expect repeatable results. +* The workflow is shared across a team. Multiple people, or systems, will run the workflow and expect repeatable results. **Example:** -If your team tags @Oz in Slack to fix a failing CI job, an environment ensures every run uses the same Docker image, clones the same repos, and runs the same setup commands. +If your team tags @Oz in Slack to fix a failing CI job, an environment ensures every run uses the same Docker image, clones the same repos, and runs the same setup commands. -The fix the agent applies matches what runs in CI and what your teammates see when they review the PR. +The fix the agent applies matches what runs in CI and what your teammates see when they review the PR. ### Where to configure environments @@ -155,7 +155,7 @@ Create one environment per codebase, then reuse it across triggers like Slack, L Use [`/create-environment`](warp://action/create_environment) when you want Warp to inspect your repos and recommend an environment configuration automatically. This is the fastest way to get started: Warp detects your languages, frameworks, and tools, then suggests appropriate images and setup commands. -You can run the command inside a Git repo directory with no argument, or with one or more repo paths or URLs. +You can run the command inside a Git repo directory with no argument, or with one or more repo paths or URLs. ```shellscript # Local file paths @@ -263,12 +263,12 @@ For end-to-end setup, see the [Integration setup](/reference/cli/integration-set ## Environment design and best practices -A well-designed environment removes guesswork by giving every run the same starting conditions. When an agent opens a PR from Slack or fixes a failed CI job, the result matches what your team can reproduce locally and in CI. +A well-designed environment removes guesswork by giving every run the same starting conditions. When an agent opens a PR from Slack or fixes a failed CI job, the result matches what your team can reproduce locally and in CI. **Design guidelines**
* **Keep setup repeatable** – Write setup steps that are safe to rerun and that produce the same toolchain and workspace state for a given repo revision. This keeps agent runs reliable across triggers and hosts. -* **Pin versions in the toolchain** – Prefer a Docker or base image that pins language runtimes and core tools, then use lockfiles (\`package-lock.json\`, etc.) for dependencies. +* **Pin versions in the toolchain** – Prefer a Docker or base image that pins language runtimes and core tools, then use lockfiles (`package-lock.json`, etc.) for dependencies. * **Define a clear workspace boundary** – In multi-repo environments, explicitly state which repos are cloned and where setup commands run so the agent doesn’t “guess” the working directory. * **Make prerequisites explicit** – If the agent must run a build step, generate code, or install system packages before it can do meaningful work, encode that as setup. diff --git a/src/content/docs/agent-platform/cloud-agents/handoff/snapshots.mdx b/src/content/docs/agent-platform/cloud-agents/handoff/snapshots.mdx index 30cbebae..8fec8ef0 100644 --- a/src/content/docs/agent-platform/cloud-agents/handoff/snapshots.mdx +++ b/src/content/docs/agent-platform/cloud-agents/handoff/snapshots.mdx @@ -10,11 +10,11 @@ sidebar: Workspace snapshots are how [handoff](/agent-platform/cloud-agents/handoff/) carries repository changes and other workspace state across cloud agent runs. At the end of every cloud agent run, Warp asks a small declarations script which repositories and files to snapshot, then uploads the resulting git diffs and file contents so the next cloud agent run can apply them. -Warp's bundled cloud agent image ships with a declarations script that snapshots every git repository under the agent's workspace, so most cloud agent runs need no configuration. This page is for the cases where you need to customize what gets snapshotted — for example, when running cloud agents in a custom Docker image, on a self-hosted [Direct backend](/agent-platform/cloud-agents/self-hosting/managed-direct/), or as an [unmanaged](/agent-platform/cloud-agents/self-hosting/unmanaged/) `oz agent run` in CI. +Warp's bundled cloud agent image ships with a declarations script that snapshots every Git repository under the agent's workspace, so most cloud agent runs need no configuration. This page is for the cases where you need to customize what gets snapshotted — for example, when running cloud agents in a custom Docker image, on a self-hosted [Direct backend](/agent-platform/cloud-agents/self-hosting/managed-direct/), or as an [unmanaged](/agent-platform/cloud-agents/self-hosting/unmanaged/) `oz agent run` in CI. ## When to customize snapshots -The default snapshotting behavior covers the most common case: snapshot every git repository the agent worked on, inside the bundled cloud agent image. Customize snapshots when you need different behavior: +The default snapshotting behavior covers the most common case: snapshot every Git repository the agent worked on, inside the bundled cloud agent image. Customize snapshots when you need different behavior: * **You're running outside the bundled image** — for example, a custom Docker base image, a self-hosted Direct backend, or unmanaged `oz agent run` invocations — where Warp's default `snapshot-declarations.sh` isn't on disk. * **You want to snapshot repos or files outside the agent's workspace** — for example, a sibling repo the agent reads but doesn't `cd` into, or a log file the agent writes to `/tmp`. diff --git a/src/content/docs/agent-platform/cloud-agents/integrations/slack.mdx b/src/content/docs/agent-platform/cloud-agents/integrations/slack.mdx index 86d3d5c9..2483b318 100644 --- a/src/content/docs/agent-platform/cloud-agents/integrations/slack.mdx +++ b/src/content/docs/agent-platform/cloud-agents/integrations/slack.mdx @@ -57,7 +57,7 @@ Agents keep you informed directly in Slack via: ### Joining the live remote session -Selecting `View agent` opens the active agent session. Inside the session you’ll see: +Selecting **View Agent** opens the active agent session. Inside the session you’ll see: * The agent’s full execution log * The plan/task list diff --git a/src/content/docs/agent-platform/cloud-agents/oz-web-app.mdx b/src/content/docs/agent-platform/cloud-agents/oz-web-app.mdx index 4240b357..0a56cc7e 100644 --- a/src/content/docs/agent-platform/cloud-agents/oz-web-app.mdx +++ b/src/content/docs/agent-platform/cloud-agents/oz-web-app.mdx @@ -242,7 +242,7 @@ For detailed integration setup instructions, see [Slack](/agent-platform/cloud-a ## Related resources -* [Cloud Agents Overview](/agent-platform/cloud-agents/overview/) — Learn about cloud agents and when to use them +* [Cloud Agents overview](/agent-platform/cloud-agents/overview/) — Learn about cloud agents and when to use them * [Multi-agent orchestration](/agent-platform/cloud-agents/orchestration/) — Parent/child model and common orchestration patterns * [Skills as Agents](/agent-platform/cloud-agents/skills-as-agents/) — Run agents based on reusable skill definitions * [Scheduled Agents](/agent-platform/cloud-agents/triggers/scheduled-agents/) — Run agents automatically on a cron schedule diff --git a/src/content/docs/agent-platform/cloud-agents/platform.mdx b/src/content/docs/agent-platform/cloud-agents/platform.mdx index f825d2b9..fbb9dee0 100644 --- a/src/content/docs/agent-platform/cloud-agents/platform.mdx +++ b/src/content/docs/agent-platform/cloud-agents/platform.mdx @@ -8,7 +8,7 @@ sidebar: --- import VideoEmbed from '@components/VideoEmbed.astro'; -Cloud agents run on the **Oz Platform**. The platform gives you a consistent way to **trigger work**, **orchestrate and track tasks**, **execute agents** (in an optional [environment](/reference/cli/integration-setup/), on a host), and inspect outcomes with team visibility. First-party [integrations](/agent-platform/cloud-agents/integrations/) connect external events — like Slack messages, GitHub PRs, or CI failures — to cloud agents automatically. +Cloud agents run on the **Oz Platform**. The platform gives you a consistent way to **trigger work**, **orchestrate and track tasks**, **execute agents** (in an optional [environment](/agent-platform/cloud-agents/environments/), on a host), and inspect outcomes with team visibility. First-party [integrations](/agent-platform/cloud-agents/integrations/) connect external events — like Slack messages, GitHub PRs, or CI failures — to cloud agents automatically. diff --git a/src/content/docs/agent-platform/cloud-agents/quickstart.mdx b/src/content/docs/agent-platform/cloud-agents/quickstart.mdx index 3c522f45..1676d1b9 100644 --- a/src/content/docs/agent-platform/cloud-agents/quickstart.mdx +++ b/src/content/docs/agent-platform/cloud-agents/quickstart.mdx @@ -84,7 +84,7 @@ You can continue conversing with the agent in real-time, watch its progress, and You can view details of your agent's run, including commands executed, files changed, and environment used, several different ways: * In the Warp app, open the [conversations panel](/agent-platform/local-agents/interacting-with-agents/#conversation-panel) to see all your agent runs. * Click the session link in your terminal output. -* Go to the [Oz web app](https://oz.warp.dev) and navigate to the `Runs` tab. +* Go to the [Oz web app](https://oz.warp.dev) and navigate to the **Runs** tab. * Access from mobile via the [Oz web app](/agent-platform/cloud-agents/oz-web-app/). **Breaking it down:** Every cloud agent run is auto-tracked. You get a shareable link, a run record, and full visibility into what the agent did. You or your teammates can watch the agent's progress in real-time and even steer it if needed. The run record persists after completion so you can review it later. diff --git a/src/content/docs/agent-platform/cloud-agents/triggers/scheduled-agents.mdx b/src/content/docs/agent-platform/cloud-agents/triggers/scheduled-agents.mdx index a0d712ee..3a84eb0f 100644 --- a/src/content/docs/agent-platform/cloud-agents/triggers/scheduled-agents.mdx +++ b/src/content/docs/agent-platform/cloud-agents/triggers/scheduled-agents.mdx @@ -54,7 +54,7 @@ Because each run is isolated, Scheduled Agents are safe to use for tasks that be Oz scheduled agents are managed through the Oz `schedule` family of CLI commands. -All scheduling operations require the Oz CLI and an authenticated session +All scheduling operations require the Oz CLI and an authenticated session. #### Creating a schedule diff --git a/src/content/docs/agent-platform/cloud-agents/warp-hosting.mdx b/src/content/docs/agent-platform/cloud-agents/warp-hosting.mdx index 667960a7..16c62dfb 100644 --- a/src/content/docs/agent-platform/cloud-agents/warp-hosting.mdx +++ b/src/content/docs/agent-platform/cloud-agents/warp-hosting.mdx @@ -8,7 +8,7 @@ sidebar: Warp's managed infrastructure lets your team run cloud agent workloads in fast, secure sandboxes. -Use Warp-hosted agents to quickly get started with Oz, without needing to configure compute resources or maintain services. +Use Warp-hosted agents to quickly get started with Oz, without needing to configure compute resources or maintain services. ## Sandbox environment @@ -16,14 +16,14 @@ All Warp-hosted agents run in fully-isolated sandboxes. Warp uses a mix of infra ### OS and architecture -Warp-hosted agents use the container image specified in your [environment](/agent-platform/cloud-agents/environments). +Warp-hosted agents use the container image specified in your [environment](/agent-platform/cloud-agents/environments/). They are compatible with any Linux x86-64 image that includes a `bash` shell and core utilities like `ls` and `mkdir`. ### Resources The resources available to Warp-hosted agents depend on your [plan](https://www.warp.dev/pricing) - see the latest details there. -On [Enterprise](/enterprise) plans, resources are configurable up to 32 vCPUs and 64 GiB of memory. If additional resources are required, reach out to Warp support about custom provisioning. +On [Enterprise](/enterprise/) plans, resources are configurable up to 32 vCPUs and 64 GiB of memory. If additional resources are required, reach out to Warp support about custom provisioning. ### Concurrency diff --git a/src/content/docs/agent-platform/getting-started/agents-in-warp.mdx b/src/content/docs/agent-platform/getting-started/agents-in-warp.mdx index 9a97d156..5fd93b94 100644 --- a/src/content/docs/agent-platform/getting-started/agents-in-warp.mdx +++ b/src/content/docs/agent-platform/getting-started/agents-in-warp.mdx @@ -88,11 +88,11 @@ Agents work best when they understand your codebase and workflows. Warp provides --- -## Third-Party CLI Agents +## Third-party CLI agents In addition to Warp's built-in agent, Warp provides first-class support for third-party CLI coding agents like Claude Code, Codex, and OpenCode. Run any supported agent inside Warp and get rich input, code review, agent notifications, vertical tabs with agent metadata, and more. -→ [Learn about Third-Party CLI Agents](/agent-platform/cli-agents/overview/) +→ [Learn about Third-party CLI agents](/agent-platform/cli-agents/overview/) --- diff --git a/src/content/docs/agent-platform/getting-started/faqs.mdx b/src/content/docs/agent-platform/getting-started/faqs.mdx index 62d4e64d..8b773b85 100644 --- a/src/content/docs/agent-platform/getting-started/faqs.mdx +++ b/src/content/docs/agent-platform/getting-started/faqs.mdx @@ -13,7 +13,7 @@ Answers to frequently asked questions about Warp's agents, including supported m ### What data is sent and/or stored when using Agents in Warp? -See our [Privacy Page](/support-and-community/privacy-and-security/privacy/) for more information on how we handle data used by Agents in Warp. +See our [Privacy page](/support-and-community/privacy-and-security/privacy/) for more information on how we handle data used by Agents in Warp. ### What happened to the old Warp AI chat panel? @@ -21,7 +21,7 @@ Agent Mode has replaced the previous AI chat panel. Agent Mode is more powerful ### Is my data used for model training? -Warp reserves the right to use data collected to train models and improve Warp. Warp has Zero Data Retention with all its model providers (e.g. Anthropic, OpenAI, etc.). Please learn more about telemetry in our [Privacy Page](/support-and-community/privacy-and-security/privacy/). +Warp reserves the right to use data collected to train models and improve Warp. Warp has Zero Data Retention with all its model providers (e.g. Anthropic, OpenAI, etc.). Please learn more about telemetry in our [Privacy page](/support-and-community/privacy-and-security/privacy/). ### What model are you using for Agent Mode? @@ -41,7 +41,7 @@ For questions about what counts as a credit, what counts as a token, and how oft ## Common AI error messages -#### **"Message token limit exceeded" error** +#### "Message token limit exceeded" error This error means your input (plus attached context) exceeds the maximum context window of the model you're using. If you exceed the limit for your selected model, you may receive no output. diff --git a/src/content/docs/agent-platform/index.mdx b/src/content/docs/agent-platform/index.mdx index ee66a21e..dc2735e8 100644 --- a/src/content/docs/agent-platform/index.mdx +++ b/src/content/docs/agent-platform/index.mdx @@ -23,7 +23,7 @@ Oz is fully programmable—launch agents manually or build custom logic around t ## Key capabilities * [**Local Agents**](/agent-platform/local-agents/overview/) - Interactive agents embedded in Warp. Use natural language to write code, debug issues, run commands, and automate development tasks with full terminal access. -* [**Third-Party CLI Agents**](/agent-platform/cli-agents/overview/) - Use Claude Code, Codex, OpenCode, and other CLI coding agents in Warp with rich input, notifications, code review, and remote session control. +* [**Third-party CLI agents**](/agent-platform/cli-agents/overview/) - Use Claude Code, Codex, OpenCode, and other CLI coding agents in Warp with rich input, notifications, code review, and remote session control. * [**Cloud Agents**](/agent-platform/cloud-agents/overview/) - Autonomous agents that run in the background in response to system events, schedules, or integrations. * [**Integrations**](/agent-platform/cloud-agents/integrations/) - Connect external system events to autonomous agent execution. Use [Slack](/agent-platform/cloud-agents/integrations/slack/), [Linear](/agent-platform/cloud-agents/integrations/linear/), [GitHub Actions](/agent-platform/cloud-agents/integrations/github-actions/), and other integrations to trigger agents in the cloud. * [**Oz Platform**](/agent-platform/cloud-agents/platform/) - The underlying infrastructure that powers Oz, including the CLI, API/SDK, orchestration layer, environments, secrets, and management/observability. @@ -42,8 +42,8 @@ Oz is fully programmable—launch agents manually or build custom logic around t ## Learn more * [Warp Agents overview](/agent-platform/local-agents/overview/) - Interactive agents in Warp -* [Third-Party CLI Agents](/agent-platform/cli-agents/overview/) - Claude Code, Codex, OpenCode, and more -* [Cloud Agents Overview](/agent-platform/cloud-agents/overview/) - Background agents for automation at scale +* [Third-party CLI agents](/agent-platform/cli-agents/overview/) - Claude Code, Codex, OpenCode, and more +* [Cloud Agents overview](/agent-platform/cloud-agents/overview/) - Background agents for automation at scale * [Agent Capabilities](/agent-platform/capabilities/) - Skills, planning, MCP, rules, and more * [Oz Platform](/agent-platform/cloud-agents/platform/) - CLI, API/SDK, orchestration, environments, and hosts * [Environments](/agent-platform/cloud-agents/environments/) - Configure execution context for cloud agents diff --git a/src/content/docs/agent-platform/inference/model-choice.mdx b/src/content/docs/agent-platform/inference/model-choice.mdx index 1e8d3f21..a44f2f33 100644 --- a/src/content/docs/agent-platform/inference/model-choice.mdx +++ b/src/content/docs/agent-platform/inference/model-choice.mdx @@ -11,7 +11,7 @@ Warp lets you choose from a curated set of large language models to power your a ## Available models -Warp lets you choose from a curated set of Large Language Models (LLMs) to power your Agentic Development Environment. +Warp lets you choose from a curated set of large language models (LLMs) to power your Agentic Development Environment. **Warp supports the following models.** @@ -117,7 +117,7 @@ Edit your default profile or any other profile directly in **Settings** > **Agen ### Zero data retention policies -Warp integrates with multiple Large Language Model (LLM) providers to power its AI-driven features. +Warp integrates with multiple large language model (LLM) providers to power its AI-driven features. **These providers include, but are not limited to:** diff --git a/src/content/docs/agent-platform/local-agents/active-ai.mdx b/src/content/docs/agent-platform/local-agents/active-ai.mdx index 2a162f37..6afe46c6 100644 --- a/src/content/docs/agent-platform/local-agents/active-ai.mdx +++ b/src/content/docs/agent-platform/local-agents/active-ai.mdx @@ -63,7 +63,7 @@ When an error occurs, Warp evaluates whether it is appropriate for an LLM to gen ![Suggested code diff with options to dismiss or accept the proposed fix.](../../../../assets/agent-platform/suggested-code-diffs.png) -#### **Using a suggested code diff** +#### Using a suggested code diff Once the diff is generated, you can either dismiss it or accept it. Acceptance can be done directly via the buttons in the diff view, or with `CMD + ENTER` on macOS and `CTRL + ENTER` on Windows/Linux. @@ -75,4 +75,4 @@ Suggested Code Diffs do not count toward your AI request limits. There are maxim ## Active AI privacy -See our [Privacy Page](/support-and-community/privacy-and-security/privacy/) for more information on how we handle data with Active AI. +See our [Privacy page](/support-and-community/privacy-and-security/privacy/) for more information on how we handle data with Active AI. diff --git a/src/content/docs/agent-platform/local-agents/agent-context/images-as-context.mdx b/src/content/docs/agent-platform/local-agents/agent-context/images-as-context.mdx index fd3062ad..beeabf93 100644 --- a/src/content/docs/agent-platform/local-agents/agent-context/images-as-context.mdx +++ b/src/content/docs/agent-platform/local-agents/agent-context/images-as-context.mdx @@ -29,7 +29,7 @@ You can attach images in the following ways: * Drag and drop images, such as from a file manager or screenshot utility. :::note -Warp accepts the following image formats: `.jpg` , `.jpeg` , `.png` , `.gif` , and .`webp` . +Warp accepts the following image formats: `.jpg`, `.jpeg`, `.png`, `.gif`, and `.webp`. ::: You can attach up to **5 images per request**, and up to **20 images across a single conversation**. Each image is sent to the model provider and immediately discarded — nothing is stored on Warp's servers. diff --git a/src/content/docs/agent-platform/local-agents/agent-context/selection-as-context.mdx b/src/content/docs/agent-platform/local-agents/agent-context/selection-as-context.mdx index bb2f82ba..cc4776a0 100644 --- a/src/content/docs/agent-platform/local-agents/agent-context/selection-as-context.mdx +++ b/src/content/docs/agent-platform/local-agents/agent-context/selection-as-context.mdx @@ -42,4 +42,4 @@ You can select code, files, or snippets and feed them directly to a running thir When a third-party agent (Claude Code, Codex, OpenCode, etc.) is running in a Warp tab, select text in Warp's code editor or Code Review panel and attach it as context to that agent's session using `Cmd + L` (macOS) or `CTRL + SHIFT + L` (Windows/Linux). This works the same way as attaching context to Warp's built-in Agent. -For more on third-party agent support, see [Third-Party CLI Agents](/agent-platform/cli-agents/overview/). +For more on third-party agent support, see [Third-party CLI agents](/agent-platform/cli-agents/overview/). diff --git a/src/content/docs/agent-platform/local-agents/agent-context/using-to-add-context.mdx b/src/content/docs/agent-platform/local-agents/agent-context/using-to-add-context.mdx index 1c41a8a4..e6cbae66 100644 --- a/src/content/docs/agent-platform/local-agents/agent-context/using-to-add-context.mdx +++ b/src/content/docs/agent-platform/local-agents/agent-context/using-to-add-context.mdx @@ -59,7 +59,7 @@ When you select one of these objects, Warp inserts a reference token into your p You are not limited to the current terminal session. With @, you can also bring in blocks of output from earlier sessions. - In the demo below, Ian shows how he previously ran cargo clippy and now wants help fixing the reported errors. Typing `@cargo clippy` surfaces the relevant block, which you can insert into your prompt. Once added, the Agent parses the output and generates fixes or explanations directly. +In the demo below, Ian shows how he previously ran `cargo clippy` and now wants help fixing the reported errors. Typing `@cargo clippy` surfaces the relevant block, which you can insert into your prompt. Once added, the Agent parses the output and generates fixes or explanations directly. You can also reference live blocks, not just those that have already completed execution. diff --git a/src/content/docs/agent-platform/local-agents/cloud-conversations.mdx b/src/content/docs/agent-platform/local-agents/cloud-conversations.mdx index 9e32fcdc..56127abc 100644 --- a/src/content/docs/agent-platform/local-agents/cloud-conversations.mdx +++ b/src/content/docs/agent-platform/local-agents/cloud-conversations.mdx @@ -135,5 +135,5 @@ When you delete a conversation, it is removed permanently and immediately. Make * [Interacting with Agents](/agent-platform/local-agents/interacting-with-agents/) - Learn about conversation mechanics, follow-ups, and context windows. * [Conversation Forking](/agent-platform/local-agents/interacting-with-agents/conversation-forking/) - Branch conversations to explore different directions. * [Session Sharing](/agent-platform/local-agents/session-sharing/) - Collaborate in real time on a live Agent session. -* [Cloud Agents Overview](/agent-platform/cloud-agents/overview/) - Run agents in the cloud from triggers, schedules, or integrations. +* [Cloud Agents overview](/agent-platform/cloud-agents/overview/) - Run agents in the cloud from triggers, schedules, or integrations. * [Handoff between local and cloud agents](/agent-platform/cloud-agents/handoff/) - Promote a local conversation to a cloud agent run, or continue a finished cloud run. diff --git a/src/content/docs/agent-platform/local-agents/code-diffs.mdx b/src/content/docs/agent-platform/local-agents/code-diffs.mdx index c6a45143..562e2067 100644 --- a/src/content/docs/agent-platform/local-agents/code-diffs.mdx +++ b/src/content/docs/agent-platform/local-agents/code-diffs.mdx @@ -21,7 +21,7 @@ If the `Apply Code Diffs` permission is set to `Always allow` in [Agent Profiles ::: :::note -Code diffs generated by Warp are never stored on our servers. Warp's coding agent only works on local repositories. The agent can make changes on remote or docker repositories, but falls back to using terminal commands (i.e. `sed`, `grep` ) to make the changes. +Code diffs generated by Warp are never stored on our servers. Warp's coding agent only works on local repositories. The agent can make changes on remote or Docker repositories, but falls back to using terminal commands (i.e. `sed`, `grep` ) to make the changes. :::
@@ -31,7 +31,7 @@ Code diffs generated by Warp are never stored on our servers. Warp's coding agen You can also choose whether Warp automatically opens the [Code Review](/code/code-review/) panel the first time you accept a diff in a conversation. -## **Navigating and applying diffs** +## Navigating and applying diffs When an Agent generates a code diff, Warp opens it in a built-in text editor with a visual diff view. Changes are grouped into clear hunks for easy inspection. @@ -43,13 +43,13 @@ When an Agent generates a code diff, Warp opens it in a built-in text editor wit These modifications will not be applied to the files unless you explicitly accept them. ::: -## **Refining or editing the diffs** +## Refining or editing the diffs If the initial suggestion needs more work: * Press `R` or select the "**Refine**" button to provide follow-up instructions in natural language. The agent will regenerate the diff based on your input. * To manually adjust the code, press `E` or click "**Edit**" to switch into an editable view. -* To cancel a pending operation, use `CTRL-C` (on macOS, Windows, or Linux). Similarly, you can exit the editor at any time with `ESC` . +* To cancel a pending operation, use `CTRL-C` (on macOS, Windows, or Linux). Similarly, you can exit the editor at any time with `ESC`. :::note You can open up code files in Warp in various different ways, refer to: [Opening files in Warp](/code/code-editor/#opening-files-in-warp) diff --git a/src/content/docs/agent-platform/local-agents/generate.mdx b/src/content/docs/agent-platform/local-agents/generate.mdx index 93be673f..6c38c134 100644 --- a/src/content/docs/agent-platform/local-agents/generate.mdx +++ b/src/content/docs/agent-platform/local-agents/generate.mdx @@ -14,7 +14,7 @@ Generate (Legacy) turns natural language queries into precise terminal commands Generate helps turn natural language queries into precise commands as terminal input or contextual suggestions inside interactive commands and programs, whether you're using psql, gdb, git, mysql, or any other CLI tool. -Generate is backed by Large Language Models from API providers like OpenAI and Anthropic, and are completely opt-in. +Generate is backed by large language models from API providers like OpenAI and Anthropic, and is completely opt-in. :::note Currently, you need to be online to use this feature. If this feature doesn't work, your ISP or firewall may be blocking the calls to `app.warp.dev` diff --git a/src/content/docs/agent-platform/local-agents/interacting-with-agents/conversation-forking.mdx b/src/content/docs/agent-platform/local-agents/interacting-with-agents/conversation-forking.mdx index b83967f9..457a3baa 100644 --- a/src/content/docs/agent-platform/local-agents/interacting-with-agents/conversation-forking.mdx +++ b/src/content/docs/agent-platform/local-agents/interacting-with-agents/conversation-forking.mdx @@ -23,7 +23,7 @@ _Example_: You can fork a conversation to explore an alternate solution, ask “ There are five ways to fork an existing conversation: -#### **1. From the Command Palette** +#### 1. From the Command Palette Open the menu using the Command Palette (`CMD + Y` on macOS / `CTRL + SHIFT + Y` on Windows/Linux). @@ -39,13 +39,13 @@ You can also access this conversation view from the conversation chip in the cur ![Conversation chip in the input area showing the Manage conversations shortcut](../../../../../assets/agent-platform/conversation-forking-chip.png) -#### **2. From the footer of the most recent AI response block** +#### 2. From the footer of the most recent AI response block In any conversation in the block list, click the **fork button** in the footer of the most recent AI block. A new conversation opens in a separate pane with the full context of the original. ![Fork conversation button in the footer of the most recent agent response block](../../../../../assets/agent-platform/conversation-forking-footer.png) -#### **3. Using the `/fork` slash command** +#### 3. Using the `/fork` slash command Type `/fork` in the input to fork the current conversation. You can optionally include a prompt after the command, and Warp will send that prompt in the newly forked conversation. @@ -54,7 +54,7 @@ Type `/fork` in the input to fork the current conversation. You can optionally i _Example_: `/fork Can you try a different approach?` Forks the selected conversation and immediately sends `Can you try a different approach?` in the forked conversation. -#### **4. Using the /fork-and-compact slash command** +#### 4. Using the `/fork-and-compact` slash command Type `/fork-and-compact` to fork the current conversation and automatically compact the forked version. This combines forking with [context window management](/agent-platform/local-agents/interacting-with-agents/#context-window-management), giving you a fresh start with a summarized context. @@ -63,7 +63,7 @@ Type `/fork-and-compact` to fork the current conversation and automatically comp ![Using the /fork-and-compact slash command to fork and summarize a conversation](../../../../../assets/agent-platform/conversation-fork-and-compact.png) -#### **5. Using the `/fork-from` slash command** +#### 5. Using the `/fork-from` slash command Type `/fork-from` to open a searchable menu of all queries in the current conversation. Select a query to fork the conversation from that specific point—everything up to and including that exchange is included in the fork, but subsequent messages are excluded. @@ -75,7 +75,7 @@ In addition to forking from the end of a conversation, you can fork from any poi -To fork from a specific point, **right-click** on any agent response block or click the three-dot menu in the top-right corner of the block. +To fork from a specific point, **right-click** on any agent response block or click the three-dot menu in the top-right corner of the block. * Select **Fork conversation from here** to create a new conversation that includes everything up to and including that response, but excludes any queries or responses that came after it. diff --git a/src/content/docs/agent-platform/local-agents/interacting-with-agents/index.mdx b/src/content/docs/agent-platform/local-agents/interacting-with-agents/index.mdx index e476d5a3..5a737ff5 100644 --- a/src/content/docs/agent-platform/local-agents/interacting-with-agents/index.mdx +++ b/src/content/docs/agent-platform/local-agents/interacting-with-agents/index.mdx @@ -59,7 +59,7 @@ You can enable or disable these tips in two places: * **Settings**: **Settings** > **Agents** > **Warp Agent** > **Input** > **Show agent tips** * **Command Palette**: Open the Command Palette (`CMD + P` on macOS, `CTRL + SHIFT + P` on Windows/Linux), then select "**Show Agent Tips**" or "**Hide Agent Tips**" -### **Managing conversations** +### Managing conversations You can view previous conversations or start a new conversation via the **Conversations Menu** (`CMD + Y` on macOS, `CTRL + SHIFT + Y` on Windows/Linux). @@ -69,7 +69,7 @@ You can view previous conversations or start a new conversation via the **Conver The "New Conversation" item disappears once you start searching for an actual conversation. ::: -### **Starting a new conversation** +### Starting a new conversation Warp automatically creates a new conversation in a few situations. For example, if you ask an AI query after running a shell command or if three hours pass without activity, Agent Mode will start a fresh conversation. @@ -114,7 +114,7 @@ Visual indicators differ slightly depending on input mode: ## Context window management -Every conversation with an agent consumes tokens stored in a **context window**. The context window (sometimes called _context length_) is the amount of text (measured in tokens) that a Large Language Model (LLM) can process at one time. **The size of the context window depends on the model you are using.** +Every conversation with an agent consumes tokens stored in a **context window**. The context window (sometimes called _context length_) is the amount of text (measured in tokens) that a large language model (LLM) can process at one time. **The size of the context window depends on the model you are using.** As tokens accumulate and exceed the context window, performance and response quality may degrade. If the context window is exceeded, the model may lose track of earlier parts of the conversation, and **Warp will automatically summarize the conversation to free up space**. diff --git a/src/content/docs/agent-platform/local-agents/interacting-with-agents/terminal-and-agent-modes.mdx b/src/content/docs/agent-platform/local-agents/interacting-with-agents/terminal-and-agent-modes.mdx index 7686b776..ab883360 100644 --- a/src/content/docs/agent-platform/local-agents/interacting-with-agents/terminal-and-agent-modes.mdx +++ b/src/content/docs/agent-platform/local-agents/interacting-with-agents/terminal-and-agent-modes.mdx @@ -134,7 +134,7 @@ Cloud agent conversations are always stored in the cloud. For more details on ac * **From the management view** - Use the [Agent Management view](/agent-platform/cloud-agents/managing-cloud-agents/) to see all cloud agent runs, filter by status, and click any row to open the conversation. * **From the Oz web app** - Access your cloud agents from the [Oz web app](https://oz.warp.dev) to manage runs from any browser. -For more on cloud agents, see [Cloud Agents Overview](/agent-platform/cloud-agents/overview/). +For more on cloud agents, see [Cloud Agents overview](/agent-platform/cloud-agents/overview/). --- @@ -309,14 +309,14 @@ If you prefer to type natural language at any point in a terminal session and ha
Using Agent as your default for new tab sessions.
-### Step 1 — Set new tabs to open in agent view +### 1. Set new tabs to open in agent view By default, new tabs and panes open in terminal mode. To launch directly into an agent conversation instead: 1. Go to **Settings** > **Features** > **General**. 2. Change **Default mode for new sessions** to **Agent**. -### Step 2 — Enable auto-detection in Agent Mode +### 2. Enable auto-detection in Agent Mode With auto-detection enabled in agent view, Warp automatically detects whether your input is natural language or a shell command, routing it to the agent or running it in the terminal accordingly. diff --git a/src/content/docs/agent-platform/local-agents/interactive-code-review.mdx b/src/content/docs/agent-platform/local-agents/interactive-code-review.mdx index 6a60c5e5..a32197cc 100644 --- a/src/content/docs/agent-platform/local-agents/interactive-code-review.mdx +++ b/src/content/docs/agent-platform/local-agents/interactive-code-review.mdx @@ -29,7 +29,7 @@ Interactive Code Review works with any supported agent running in Warp: * **Warp's native Agent** — the built-in agent in Agent Mode * **Third-party CLI agents** — Claude Code, OpenAI Codex, OpenCode, Amp, Auggie, Copilot CLI, Cursor CLI, Gemini CLI, Droid, and Pi -For the full feature matrix and setup details for each CLI agent, see [Third-Party CLI Agents](/agent-platform/cli-agents/overview/). +For the full feature matrix and setup details for each CLI agent, see [Third-party CLI agents](/agent-platform/cli-agents/overview/). --- diff --git a/src/content/docs/agent-platform/local-agents/overview.mdx b/src/content/docs/agent-platform/local-agents/overview.mdx index 5a96c27d..e26737ac 100644 --- a/src/content/docs/agent-platform/local-agents/overview.mdx +++ b/src/content/docs/agent-platform/local-agents/overview.mdx @@ -31,7 +31,7 @@ This section covers how to interact with Warp's agents and the capabilities avai * [Interactive Code Review](/agent-platform/local-agents/interactive-code-review/) - Review agent-generated diffs, leave inline comments, and have the agent address your feedback. * [Task Lists](/agent-platform/capabilities/task-lists/) - Track complex workflows with automatic task lists that update progress in real time. * [Web Search](/agent-platform/capabilities/web-search/) - Allow agents to search the web for up-to-date information. -* [Third-Party CLI Agents](/agent-platform/cli-agents/overview/) - Run third-party CLI agents like Claude Code and Codex with Warp's built-in agent toolbelt. +* [Third-party CLI agents](/agent-platform/cli-agents/overview/) - Run third-party CLI agents like Claude Code and Codex with Warp's built-in agent toolbelt. * [Active AI Recommendations](/agent-platform/local-agents/active-ai/) - Get proactive fix recommendations based on errors and outputs. * [Voice](/agent-platform/local-agents/interacting-with-agents/voice/) - Talk to Warp's agent using voice commands. diff --git a/src/content/docs/agent-platform/local-agents/session-sharing.mdx b/src/content/docs/agent-platform/local-agents/session-sharing.mdx index ffd1f266..cca72ba2 100644 --- a/src/content/docs/agent-platform/local-agents/session-sharing.mdx +++ b/src/content/docs/agent-platform/local-agents/session-sharing.mdx @@ -100,7 +100,7 @@ Multiple participants can join the same session from different machines, browser ## Related pages * [Remote Control](/agent-platform/cli-agents/remote-control/) -* [Third-Party CLI Agents](/agent-platform/cli-agents/overview/) +* [Third-party CLI agents](/agent-platform/cli-agents/overview/) * [Cloud Agent Session Sharing](/agent-platform/cloud-agents/viewing-cloud-agent-runs/) * [Attach agent session context to GitHub PRs](/guides/agent-workflows/how-to-attach-agent-session-context-to-github-prs/) * [Session Sharing (terminal)](/knowledge-and-collaboration/session-sharing/) diff --git a/src/content/docs/changelog/2021.mdx b/src/content/docs/changelog/2021.mdx index 1636be94..124a28a3 100644 --- a/src/content/docs/changelog/2021.mdx +++ b/src/content/docs/changelog/2021.mdx @@ -303,7 +303,7 @@ Submit bugs and feature requests on our [GitHub board!](https://github.com/warpd **Bug fixes** -* Down arrow sends unrecognized escape sequence to Github CLI +* Down arrow sends unrecognized escape sequence to GitHub CLI * Can’t use UP arrow if item in history is multiple lines * Crash when closing a tab when there are multiple tabs * File-only completion signatures should also show directories diff --git a/src/content/docs/changelog/2025.mdx b/src/content/docs/changelog/2025.mdx index c988e6fb..e72bd645 100644 --- a/src/content/docs/changelog/2025.mdx +++ b/src/content/docs/changelog/2025.mdx @@ -58,7 +58,7 @@ Submit bugs and feature requests on our [GitHub board!](https://github.com/warpd **New features** * MCP server configurations can now be shared with others on your team. You can install a server shared by your team with minimal configuration. -* Warp now provides out-of-box MCP servers for common services like Github and Linear that can be installed and run with a single click. +* Warp now provides out-of-box MCP servers for common services like GitHub and Linear that can be installed and run with a single click. * Find now works in the code review pane. ### 2025.11.18 (v0.2025.11.18.12.24) diff --git a/src/content/docs/code/code-editor/code-editor-vim-keybindings.mdx b/src/content/docs/code/code-editor/code-editor-vim-keybindings.mdx index 75226cf1..0d7db88d 100644 --- a/src/content/docs/code/code-editor/code-editor-vim-keybindings.mdx +++ b/src/content/docs/code/code-editor/code-editor-vim-keybindings.mdx @@ -20,15 +20,15 @@ Vim mode in the code editor uses the same setting toggle as the input editor. To * Through the [Command Palette](/terminal/command-palette/), search for "Vim Keybindings". * Through **Settings** > **Features** > **Text Editing**, toggle "Edit code and commands with Vim keybindings". -Unlike the input editor, the Vim implementation in the code editor starts in Normal mode. +Unlike the input editor, the Vim implementation in the code editor starts in Normal mode. -### Customizing Keybindings +### Customizing keybindings At the moment, Warp only supports default Vim keybindings. -One exception is the keyboard shortcut for exiting insert mode, which can be rebound under**Settings** > **Keyboard shortcuts** > **Exit Vim Insert Mode**, or through the [Command Palette](/terminal/command-palette/) search for "Exit Vim Insert Mode". +One exception is the keyboard shortcut for exiting insert mode, which can be rebound under **Settings** > **Keyboard shortcuts** > **Exit Vim Insert Mode**, or through the [Command Palette](/terminal/command-palette/) search for "Exit Vim Insert Mode". -## Supported Keybindings +## Supported keybindings Below is a list of the vim functionality implemented in Warp so far. @@ -82,7 +82,7 @@ See [Vim docs: motion](https://vimdoc.sourceforge.net/htmldoc/motion.html) for m See [Vim docs: editing](https://vimdoc.sourceforge.net/htmldoc/editing.html) for more information. -#### Text Objects +#### Text objects | Command(s) | Description | | ---------------- | ------------------------------------------ | @@ -96,7 +96,7 @@ See [Vim docs: text objects](https://vimdoc.sourceforge.net/htmldoc/motion.html# ### Search -#### Character Search +#### Character search | Command(s) | Description | | ------------------ | ------------------------------------------------------ | @@ -106,7 +106,7 @@ See [Vim docs: text objects](https://vimdoc.sourceforge.net/htmldoc/motion.html# See [Vim docs: left-right motions](https://vimdoc.sourceforge.net/htmldoc/motion.html#f) for more information. -#### General Search +#### General search Unlike Vim, general search commands don't search within the buffer. Instead, they open Warp's native command search. @@ -114,7 +114,7 @@ Unlike Vim, general search commands don't search within the buffer. Instead, the | ------------------ | ------------------------ | | `/`, `?`, `*`, `#` | open Warp command search | -### Mode Switching +### Mode switching | Command(s) | Description | | ---------- | ----------------------------------------------------------------- | @@ -148,4 +148,4 @@ See [Vim docs: registers](https://vimdoc.sourceforge.net/htmldoc/change.html#reg ## Feedback -The best way to report bugs and request features is through Warp's [GitHub Issues](https://github.com/warpdotdev/Warp/issues) page. Please note that the issue or request is for Vim Keybindings. +The best way to report bugs and request features is through Warp's [GitHub Issues](https://github.com/warpdotdev/Warp/issues) page. Please note that the issue or request is for Vim keybindings. diff --git a/src/content/docs/code/code-editor/file-tree.mdx b/src/content/docs/code/code-editor/file-tree.mdx index 2a870704..4929e82a 100644 --- a/src/content/docs/code/code-editor/file-tree.mdx +++ b/src/content/docs/code/code-editor/file-tree.mdx @@ -9,7 +9,7 @@ The File Tree is Warp's built-in project explorer for browsing, opening, and man ![Warp's native file tree showing the project's file and folder structure in the left panel.](../../../../assets/terminal/filetree-main.png) -Warp includes a **native file tree** that makes it easy to explore and manage project files. The file tree is available whenever in any directory and it automatically reflects your project structure as files are added, removed, or changed. +Warp includes a **native file tree** that makes it easy to explore and manage project files. The file tree is available in any directory, and it automatically reflects your project structure as files are added, removed, or changed. :::note The file tree also works over SSH on macOS and Linux when Warp's [SSH extension](/terminal/warpify/ssh/#installing-the-ssh-extension) is installed on the remote host. diff --git a/src/content/docs/code/code-editor/find-and-replace.mdx b/src/content/docs/code/code-editor/find-and-replace.mdx index 5b52870c..68c04ed4 100644 --- a/src/content/docs/code/code-editor/find-and-replace.mdx +++ b/src/content/docs/code/code-editor/find-and-replace.mdx @@ -16,7 +16,7 @@ Press `CMD-F` on macOS or `CTRL-SHIFT-F` on Windows and Linux to open the find m * Press `ENTER` or use the down arrow to jump to the next match * Press `SHIFT-ENTER` or use the up arrow to go to the previous match -* Click "Select All" to highlight all matches and close the menu +* Click **Select All** to highlight all matches and close the menu You can toggle regex and case-sensitive search options directly in the query editor. @@ -26,10 +26,10 @@ You can toggle regex and case-sensitive search options directly in the query edi Click the dropdown to the left of the find menu to open the replace options. -* Press Enter to replace the currently selected match -* Use Replace All to replace all matches +* Press `Enter` to replace the currently selected match +* Use **Replace All** to replace all matches -Toggle Preserve Case to keep the original casing of replaced text. Case is preserved in text that contains PascalCase, camelCase, hyphens, and underscores. For example: +Toggle **Preserve Case** to keep the original casing of replaced text. Case is preserved in text that contains PascalCase, camelCase, hyphens, and underscores. For example: * Replacing “old” with “new” will turn “Old” into “New” and “OLD” into “NEW” * Replacing “oldValue” with “NewValue” will result in “newValue” diff --git a/src/content/docs/code/code-editor/index.mdx b/src/content/docs/code/code-editor/index.mdx index 47ca3d2d..2c8ed883 100644 --- a/src/content/docs/code/code-editor/index.mdx +++ b/src/content/docs/code/code-editor/index.mdx @@ -41,7 +41,7 @@ Warp can group multiple files into a single tabbed viewer, reducing clutter and -### **File layout options** +### File layout options Choose how new files open in Warp by default in: **Settings** > **Features** > **General** > **Choose a layout to open files in Warp** diff --git a/src/content/docs/code/code-review.mdx b/src/content/docs/code/code-review.mdx index 15f258ab..eb9339ef 100644 --- a/src/content/docs/code/code-review.mdx +++ b/src/content/docs/code/code-review.mdx @@ -39,7 +39,7 @@ If the agent's changes are headed to a GitHub pull request, include a shared ses The Code Review panel can be opened in several ways. Each entry point makes it easy to inspect and manage changes without leaving your workflow. :::tip -You can also open the Code Review panel with `CMD – SHIFT – +` on macOS or `CTRL – SHIFT – +` on Windows and Linux. +You can also open the Code Review panel with `Cmd+Shift++` on macOS or `Ctrl+Shift++` on Windows and Linux. ::: #### 1. Git diff chip (terminal input) @@ -148,7 +148,7 @@ The Code Review panel lets you easily undo changes at different levels. In the g When you revert, the changes are immediately updated in your working directory. The file is restored to match the selected version, so you can continue editing or commit without the reverted code. -### Opening Files from Code Review +### Opening files from Code Review In addition to reviewing and editing diffs directly in the Code Review pane, you can open a file directly in Warp's [Code Editor](/code/code-editor/). @@ -162,7 +162,7 @@ In addition to reviewing and editing diffs directly in the Code Review pane, you * Once opened, the file behaves like any other editor tab: you can scroll, edit, search, and save. * Any changes made in the editor automatically sync back into the Code Review pane, so the diff view always stays current. -**Note**: from this code review file header, you can also attach a file diff as context into Warp's agent, or discard all the changes on a single file. +**Note**: from this code review file header, you can also attach a file diff as context into Warp's agent, or discard all the changes on a single file. #### Directly editing code diffs @@ -181,7 +181,7 @@ This extends Warp's [Interactive Code Review](/agent-platform/local-agents/inter -For more on supported agents, see [Third-Party CLI Agents](/agent-platform/cli-agents/overview/). +For more on supported agents, see [Third-party CLI agents](/agent-platform/cli-agents/overview/). ### Discarding all changes @@ -192,7 +192,7 @@ The Code Review panel also lets you discard every uncommitted change on your bra
The Discard all changes button.
-Discarding changes will ask you confirm, but still make sure you've saved or backed up anything you want to keep before using it. +Discarding changes will ask you to confirm, but still make sure you've saved or backed up anything you want to keep before using it. :::note Warp natively supports Git worktrees for Code Review and other features. See [Git worktrees](/code/git-worktrees/) for details. diff --git a/src/content/docs/code/overview.mdx b/src/content/docs/code/overview.mdx index 2eff6299..978d82c7 100644 --- a/src/content/docs/code/overview.mdx +++ b/src/content/docs/code/overview.mdx @@ -23,7 +23,7 @@ In addition to Warp’s modern, [native code editor](/code/code-editor/), it inc * A dedicated [Code Review](/code/code-review/) experience for reviewing and editing diffs * [Zero-state and setup flows](/code/overview/#getting-started-with-coding-in-warp) to quickly start a new project or initialize an existing one -### Coding Agent +### Coding agent Warp’s coding agent is designed to help you generate, edit, and manage code directly in the [Agentic Development Environment](https://www.warp.dev/blog/reimagining-coding-agentic-development-environment). It detects opportunities to apply code diffs and surfaces them inline, allowing you to review and apply changes without switching to an external IDE. When you need to make manual edits, you can open Warp’s native code editor. @@ -89,7 +89,7 @@ Select **Open Repository** to use your computer's file picker. If you choose a G Select **Clone Repository** to paste in a repo link or clone directly from GitHub. Warp places you in the cloned folder and automatically runs the `/init` flow to set up project rules and indexing. -## Learn more about code features: +## Learn more about code features * [Code Editor](/code/code-editor/) - Warp's built-in code editor lets you make quick, in-context edits with essentials like syntax highlighting, tabs, find and replace, Vim keybindings, and a file tree. * [Language Server Protocol (LSP)](/code/code-editor/language-server-protocol/) - Warp integrates with language servers to provide hover info, go-to-definition, find references, inline diagnostics, and format-on-save for Rust, Go, Python, TypeScript/JavaScript, and C/C++. diff --git a/src/content/docs/enterprise/enterprise-features/bring-your-own-llm.mdx b/src/content/docs/enterprise/enterprise-features/bring-your-own-llm.mdx index 37dc753e..94f1d121 100644 --- a/src/content/docs/enterprise/enterprise-features/bring-your-own-llm.mdx +++ b/src/content/docs/enterprise/enterprise-features/bring-your-own-llm.mdx @@ -14,7 +14,7 @@ BYOLLM currently supports **AWS Bedrock** only. Coming soon: Azure Foundry and G ::: :::note -BYOLLM is only available on Warp's Enterprise plan. Contact [contact sales](https://www.warp.dev/contact-sales) to learn more. +BYOLLM is only available on Warp's Enterprise plan. [Contact sales](https://www.warp.dev/contact-sales) to learn more. ::: ## Key features @@ -77,7 +77,7 @@ Before configuring BYOLLM, confirm the following: * You have admin access to both Warp's [Admin Panel](/enterprise/team-management/admin-panel/) and your AWS IAM settings. * Team members have the AWS CLI installed locally. -### Step 1: Configure routing policies (admin) +### 1. Configure routing policies (admin) In the [Admin Panel](/enterprise/team-management/admin-panel/), configure which models should route through AWS Bedrock: @@ -85,7 +85,7 @@ In the [Admin Panel](/enterprise/team-management/admin-panel/), configure which 2. Select which models should use your cloud provider (e.g., "Claude Opus 4.7 via AWS Bedrock"). 3. Optionally, disable direct API access to enforce provider-only routing. -### Step 2: Provision IAM roles (cloud admin) +### 2. Provision IAM roles (cloud admin) Grant your team members the necessary permissions in AWS. Use least-privilege IAM policies. @@ -116,7 +116,7 @@ Grant your team members the necessary permissions in AWS. Use least-privilege IA This policy covers Warp's current usage. By default, Warp uses [global inference profiles](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html) for models when available. Admins can override the inference profile per model on the **Models** page of the [Admin Panel](/enterprise/team-management/admin-panel/). ::: -### Step 3: Authenticate locally (team member) +### 3. Authenticate locally (team member) Each team member authenticates to AWS using the AWS CLI: @@ -126,7 +126,7 @@ aws login Confirm your AWS environment and region are correctly configured before using Warp. -### Step 4: Validate +### 4. Validate Run a test prompt in Warp using a model configured for BYOLLM routing. Verify: @@ -143,7 +143,7 @@ Before configuring BYOLLM for cloud agents, confirm the following: * You have admin access to both Warp's [Admin Panel](/enterprise/team-management/admin-panel/) and your AWS IAM settings. -### Step 1: Set up Warp as an OIDC identity provider in AWS (cloud admin) +### 1. Set up Warp as an OIDC identity provider in AWS (cloud admin) Before AWS can trust tokens issued by Warp, register Warp as an OpenID Connect (OIDC) identity provider in IAM. This is a one-time setup per AWS account. @@ -158,7 +158,7 @@ After the provider is created, copy its ARN — it will look like `arn:aws:iam:: For more detail, see AWS's [Create an OpenID Connect (OIDC) identity provider in IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc.html) guide. -### Step 2: Provision an assumable IAM role (cloud admin) +### 2. Provision an assumable IAM role (cloud admin) Create an IAM role that Warp can assume via OIDC, then attach the minimum Bedrock permissions policy. Use least-privilege IAM policies. @@ -231,7 +231,7 @@ This policy covers Warp's current usage. By default, Warp uses [global inference After you create the role, copy its ARN. You'll paste it into the **Models** page in the next step. -### Step 3: Configure routing policies (admin) +### 3. Configure routing policies (admin) Attach the IAM role from Step 2 to your team or to a specific named agent. @@ -260,7 +260,7 @@ In the Oz web app: New runs for this agent will authenticate to Bedrock using the configured role. -### Step 4: Validate the configuration +### 4. Validate the configuration Start a test cloud agent run using a model configured for BYOLLM routing. Verify: diff --git a/src/content/docs/enterprise/getting-started/getting-started-developers.mdx b/src/content/docs/enterprise/getting-started/getting-started-developers.mdx index 70c3796f..ba38d40d 100644 --- a/src/content/docs/enterprise/getting-started/getting-started-developers.mdx +++ b/src/content/docs/enterprise/getting-started/getting-started-developers.mdx @@ -7,13 +7,13 @@ description: >- This guide helps developers get up and running with their team in Warp. You'll learn how to download Warp, log in with your organization's SSO, and configure key features like Codebase Context, Warp Drive, and Agent Profiles to accelerate your work across the entire SDLC (all while staying in your terminal). -When you use agents in Warp, you're working with **Warp's built-in agents**. Oz is Warp's programmable agent for running and coordinating agents at scale, whether they run locally on your machine or in the cloud. Oz provides the orchestration, tracking, and control plane that makes scaling agent workflows seamless. +When you use agents in Warp, you're working with **Warp's built-in agents**. Oz is Warp's programmable platform for running and coordinating agents at scale, whether they run locally on your machine or in the cloud. Oz provides the orchestration, tracking, and control plane that makes scaling agent workflows seamless. :::note New to Warp Enterprise? Try the [Enterprise quickstart](/enterprise/getting-started/quickstart/) for a 10-minute walkthrough of SSO login, Warp setup, and running your first agent. ::: -## Step 1: Download and install Warp +## 1. Download and install Warp Warp is available for macOS, Linux, and Windows. @@ -49,7 +49,7 @@ curl -fsSL https://www.warp.dev/install.sh | bash 2. Follow the installation wizard. 3. Launch Warp from the Start menu. -## Step 2: Log in to your team +## 2. Log in to your team ### Logging in with SSO @@ -83,7 +83,7 @@ If you were using Warp before your organization enabled SSO: 4. Follow the prompts to link your account to SSO. 5. From now on, use **Continue with SSO** to log in. -## Step 3: Set up key features +## 3. Set up key features ### Codebase Context @@ -200,7 +200,7 @@ MCP connects Warp's agents to external tools and services for enhanced context. Your team may have shared MCP configurations. Check for a share icon next to team-configured servers to use them without manual setup. -## Step 4: Start using Warp +## 4. Start using Warp ### Everyday workflows @@ -236,7 +236,7 @@ Warp keeps you in your terminal with agent help across the entire SDLC: ### Learning resources -* **Warp Guides** - Short video tutorials in [Warp Guides](/guides/) +* **Warp Guides** - Short video tutorials in the [Guides](/guides/) * Getting Started with Warp * Warp Code features * Developer workflows diff --git a/src/content/docs/enterprise/getting-started/quickstart.mdx b/src/content/docs/enterprise/getting-started/quickstart.mdx index f2ef1799..18eee437 100644 --- a/src/content/docs/enterprise/getting-started/quickstart.mdx +++ b/src/content/docs/enterprise/getting-started/quickstart.mdx @@ -9,7 +9,7 @@ sidebar: This quickstart walks you through the essentials: logging in via SSO, setting up Warp, and running your first agent. You can complete this in under 10 minutes. -## Step 1: Log in via SSO +## 1. Log in via SSO 1. Go to the [Warp login page](https://app.warp.dev/login). 2. Click **Continue with SSO**. @@ -22,7 +22,7 @@ Do not launch Warp from your SSO provider's app portal (e.g., Okta dashboard). A If you have an existing Warp account from before your organization enabled SSO, [link your Warp account to SSO first](https://app.warp.dev/link_sso). -## Step 2: Download and set up Warp +## 2. Download and set up Warp 1. Visit the [Warp download page](https://www.warp.dev/download) and select your platform (macOS, Linux, or Windows). 2. Install Warp: @@ -32,9 +32,9 @@ If you have an existing Warp account from before your organization enabled SSO, 3. Launch Warp and log in with SSO (Step 1). 4. Verify you see your team name in **Settings** > **Teams**. -## Step 3: Configure and run your first agent +## 3. Configure and run your first agent -When you use agents in Warp, you're working with **Warp's built-in agents**. Oz is Warp's programmable agent for running and coordinating agents at scale, whether they run locally on your machine or in the cloud. +When you use agents in Warp, you're working with **Warp's built-in agents**. Oz is Warp's programmable platform for running and coordinating agents at scale, whether they run locally on your machine or in the cloud. ### Index your codebase @@ -60,7 +60,7 @@ Oz reads your codebase, understands its structure, and responds with a context-a * **Explore** - "What patterns does this repo use for error handling?" * **Plan** - Use `/plan` to have Oz create a structured task plan for complex features -## Step 4: Run a cloud agent +## 4. Run a cloud agent Cloud agents run in the cloud for background work, unlimited parallelization, and long-running tasks. diff --git a/src/content/docs/enterprise/index.mdx b/src/content/docs/enterprise/index.mdx index ad504b19..ba97a04b 100644 --- a/src/content/docs/enterprise/index.mdx +++ b/src/content/docs/enterprise/index.mdx @@ -10,7 +10,7 @@ Warp Enterprise is built for organizations that want to accelerate software deve Warp has two core products: * **Warp Terminal** - A modern terminal designed for agentic development where developers run commands, collaborate with agents, and orchestrate autonomous work from the command line. -* **Oz** - Warp's programmable agent for running and coordinating agents at scale. Oz powers all agents in Warp, whether they run locally or in the cloud, and provides the orchestration, tracking, and control plane for scalable agent workflows. +* **Oz** - Warp's programmable platform for running and coordinating agents at scale. Oz powers all agents in Warp, whether they run locally or in the cloud, and provides the orchestration, tracking, and control plane for scalable agent workflows. ## Who Warp Enterprise is for @@ -86,4 +86,4 @@ Organizations adopt Warp Enterprise to: * **Documentation** - Comprehensive guides throughout this enterprise section * **Contact sales** - [Schedule a demo or start a trial](https://www.warp.dev/contact-sales) * **Support** - Enterprise customers receive priority support via dedicated Slack/Teams channels -* **Warp Guides** - Video tutorials and training at [docs.warp.dev/guides](/guides/) +* **Warp Guides** - Video tutorials and training in the [Guides section](/guides/) diff --git a/src/content/docs/enterprise/support-and-resources/feedback-and-feature-requests.mdx b/src/content/docs/enterprise/support-and-resources/feedback-and-feature-requests.mdx index 51055fc2..349569bc 100644 --- a/src/content/docs/enterprise/support-and-resources/feedback-and-feature-requests.mdx +++ b/src/content/docs/enterprise/support-and-resources/feedback-and-feature-requests.mdx @@ -40,7 +40,7 @@ Warp's logs do not contain console input or output. Log file locations by platfo * **Windows** - `%LOCALAPPDATA%\warp\Warp\data\logs\warp.log*` * **Linux** - `~/.local/state/warp-terminal/warp.log*` -You can also access logs directly in the app: open the **Command Palette** (`⌘P` on macOS / `Ctrl+Shift+P` on Windows/Linux) and search for **View Warp Logs**. +You can also access logs directly in the app: open the **Command Palette** (`⌘+P` on macOS / `Ctrl+Shift+P` on Windows/Linux) and search for **View Warp Logs**. For detailed log gathering instructions, including how to zip logs and capture crash reports, see [Sending Feedback & Logs](/support-and-community/troubleshooting-and-support/sending-us-feedback/). diff --git a/src/content/docs/getting-started/keyboard-shortcuts.mdx b/src/content/docs/getting-started/keyboard-shortcuts.mdx index 4308ad7e..9c2e767e 100644 --- a/src/content/docs/getting-started/keyboard-shortcuts.mdx +++ b/src/content/docs/getting-started/keyboard-shortcuts.mdx @@ -82,7 +82,7 @@ Keybinds that conflict with others are highlighted with an orange border. | | Scroll Terminal Output Down One Line | `terminal:scroll_down_one_line` | :::note - "Scroll Terminal Output Up/Down One Line" has no default keybinding. You can assign one in Settings > Keyboard shortcuts or trigger it from the [Command Palette](/terminal/command-palette/). During long-running or full-screen commands, `PAGE UP`, `PAGE DOWN`, `HOME`, and `END` are forwarded to the running program. + "Scroll Terminal Output Up/Down One Line" has no default keybinding. You can assign one in **Settings** > **Keyboard shortcuts** or trigger it from the [Command Palette](/terminal/command-palette/). During long-running or full-screen commands, `PAGE UP`, `PAGE DOWN`, `HOME`, and `END` are forwarded to the running program. ::: **Input Editor** @@ -243,7 +243,7 @@ Keybinds that conflict with others are highlighted with an orange border. | | Scroll Terminal Output Down One Line | `terminal:scroll_down_one_line` | :::note - "Scroll Terminal Output Up/Down One Line" has no default keybinding. You can assign one in Settings > Keyboard shortcuts or trigger it from the [Command Palette](/terminal/command-palette/). During long-running or full-screen commands, `PAGE UP`, `PAGE DOWN`, `HOME`, and `END` are forwarded to the running program. + "Scroll Terminal Output Up/Down One Line" has no default keybinding. You can assign one in **Settings** > **Keyboard shortcuts** or trigger it from the [Command Palette](/terminal/command-palette/). During long-running or full-screen commands, `PAGE UP`, `PAGE DOWN`, `HOME`, and `END` are forwarded to the running program. ::: **Input Editor** @@ -403,7 +403,7 @@ Keybinds that conflict with others are highlighted with an orange border. | | Scroll Terminal Output Down One Line | `terminal:scroll_down_one_line` | :::note - "Scroll Terminal Output Up/Down One Line" has no default keybinding. You can assign one in Settings > Keyboard shortcuts or trigger it from the [Command Palette](/terminal/command-palette/). During long-running or full-screen commands, `PAGE UP`, `PAGE DOWN`, `HOME`, and `END` are forwarded to the running program. + "Scroll Terminal Output Up/Down One Line" has no default keybinding. You can assign one in **Settings** > **Keyboard shortcuts** or trigger it from the [Command Palette](/terminal/command-palette/). During long-running or full-screen commands, `PAGE UP`, `PAGE DOWN`, `HOME`, and `END` are forwarded to the running program. ::: **Input Editor** diff --git a/src/content/docs/getting-started/quickstart/coding-in-warp.mdx b/src/content/docs/getting-started/quickstart/coding-in-warp.mdx index 321f5ca9..289bda15 100644 --- a/src/content/docs/getting-started/quickstart/coding-in-warp.mdx +++ b/src/content/docs/getting-started/quickstart/coding-in-warp.mdx @@ -4,7 +4,7 @@ description: >- Agents can generate and edit code directly from within Warp. --- -When you enter a Git repo for the first time, Warp will enter an initialization flow to index your codebase and generate an AGENTS.md file. +When you enter a Git repo for the first time, Warp will enter an initialization flow to index your codebase and generate an AGENTS.md file. As you're in the repo, Warp will enter an advanced code generation flow that supports both single-line and multi-file changes when it detects an opportunity to write code. @@ -37,7 +37,7 @@ Once the theme is created and verified, confirm completion by telling me where t Warp can index your Git-tracked codebases to help agents understand your code and generate accurate, context-aware responses. **No code is stored on Warp servers**. -You can view and manage your indexed codebases in **Settings** > **Code** > **Indexing and projects** under "Initialized/ indexed folders". You can also specify whether to automatically index new folders as you navigate them. +You can view and manage your indexed codebases in **Settings** > **Code** > **Indexing and projects** under **Initialized / indexed folders**. You can also specify whether to automatically index new folders as you navigate them. If your codebase is large, you can exclude specific files by adding them to a `.warpindexingignore` file. @@ -50,18 +50,18 @@ You can provide different types of input as context directly to the agent to gui * [Files and code](/agent-platform/local-agents/agent-context/using-to-add-context/) (using the @ symbol) * [Public websites](/agent-platform/local-agents/agent-context/urls-as-context/) via URLs -#### Warp Drive as Context +#### Warp Drive as context -Agents pull directly from your [**Warp Drive**](/knowledge-and-collaboration/warp-drive/) contents to generate more accurate responses -- including your **Workflows**, **Notebooks**, **Prompts**, and **Environment Variables**. +Agents pull directly from your [**Warp Drive**](/knowledge-and-collaboration/warp-drive/) contents to generate more accurate responses, including your **Workflows**, **Notebooks**, **Prompts**, and **Environment Variables**. * When used, context appears under the “References” or “Derived from” section in the conversation. * This setting is **enabled by default** and can be managed via: **Settings** > **Agents** > **Knowledge** > **Warp Drive as Agent Mode Context**. #### Rules -**Rules** let you provide persistent context to Agents, enabling smarter and more personalized responses. +**Rules** let you provide persistent context to Agents, enabling smarter and more personalized responses. -You can create global rules (accessed through [Warp Drive](/knowledge-and-collaboration/warp-drive/) >**Personal** > **Rules**) or project scoped rules, defined in an `AGENTS.md` file. Note: the filename must be in all caps for Warp to recognize it. +You can create global rules (accessed through [Warp Drive](/knowledge-and-collaboration/warp-drive/) > **Personal** > **Rules**) or project-scoped rules, defined in an `AGENTS.md` file. Note: the filename must be in all caps for Warp to recognize it. **Examples of Rules include:** @@ -69,14 +69,14 @@ You can create global rules (accessed through [Warp Drive](/knowledge-and-collab * Project- or workspace-specific guidelines * Personal preferences for tools, formatting, or behavior -How to access project-specific Rules +**How to access project-specific Rules** -1. From the file-searcher, CMD+O and search "AGENTS.md" -2. From the file tree, click the "code" icon when in a repo +1. From the file searcher, press `⌘+O` and search "AGENTS.md". +2. From the file tree, click the "code" icon when in a repo. -How to access Global Rules +**How to access Global Rules** -1. From the [Warp Drive](/knowledge-and-collaboration/warp-drive/) >**Personal** > **Rules** -2. From the [Command Palette](/terminal/command-palette/), search for "Open AI Rules" -3. From the Settings panel, **Settings** > **Agents** > **Knowledge** > **Manage Rules** -4. From the macOS Menu, `AI > Open Rules` +1. From [Warp Drive](/knowledge-and-collaboration/warp-drive/), go to **Personal** > **Rules**. +2. From the [Command Palette](/terminal/command-palette/), search for "Open AI Rules". +3. From the Settings panel, go to **Settings** > **Agents** > **Knowledge** > **Manage Rules**. +4. From the Warp menu bar, choose **AI** > **Open Rules**. diff --git a/src/content/docs/getting-started/quickstart/installation-and-setup.mdx b/src/content/docs/getting-started/quickstart/installation-and-setup.mdx index 418b402e..4a622a6d 100644 --- a/src/content/docs/getting-started/quickstart/installation-and-setup.mdx +++ b/src/content/docs/getting-started/quickstart/installation-and-setup.mdx @@ -193,7 +193,7 @@ Use the official builds for daily use. Self-built `warp-oss` binaries use a sepa ## Initial setup -### Log in to Warp (Optional) +### Log in to Warp (optional) After installation, you have the option to create a Warp account through the "Sign up" button (top right), or by navigating to **Settings** > **Account** > **Sign up**. Optionally, you can skip this step. If you're having issues logging in, see the [Login Troubleshooting](/support-and-community/troubleshooting-and-support/troubleshooting-login-issues/) page. @@ -215,4 +215,4 @@ Warp tries to load your login shell by default. Currently, Warp supports bash, f Zsh is the default login and interactive shell on macOS (starting with macOS Catalina in 2019), replacing the bash shell. For most Linux distributions, the default shell is bash. -You can change your default shell by going to **Settings** > **Features** > **Session**. In the Startup shell for new sessions section, you can choose which shell you want Warp to use. +You can change your default shell by going to **Settings** > **Features** > **Session**. In the **Startup shell for new sessions** section, you can choose which shell you want Warp to use. diff --git a/src/content/docs/getting-started/supported-shells.mdx b/src/content/docs/getting-started/supported-shells.mdx index 45ba8e84..86e1a248 100644 --- a/src/content/docs/getting-started/supported-shells.mdx +++ b/src/content/docs/getting-started/supported-shells.mdx @@ -23,7 +23,7 @@ If you run into issues configuring your RC files (`~/.bashrc`, `~/.zshrc`, `conf ### Changing what shell Warp uses -To change the default shell, we recommend you choose a shell in Warp by going to **Settings** > **Features** and scrolling to the `Session` section, then select the "Startup shell for new sessions" +To change the default shell, we recommend you choose a shell in Warp by going to **Settings** > **Features** and scrolling to the **Session** section, then select **Startup shell for new sessions**. :::note The changes to your shell will only take effect when you start a new session. @@ -109,14 +109,14 @@ By default, macOS ships with [zsh](https://zsh.sourceforge.io/Doc/Release/zsh_to ### Using fish shell with Warp on macOS -#### Step 1: Install fish +#### 1. Install fish -While bash, and zsh come pre-installed on macOS systems, fish shell does not. So before using fish with Warp, you will need to install it. Install fish 3.6 or above using one of the methods listed below - +While bash and zsh come pre-installed on macOS systems, fish shell does not. So before using fish with Warp, you will need to install it. Install fish 3.6 or above using one of the methods listed below: 1. With Homebrew: If you already have homebrew installed, you can simply type `brew install fish`, and follow the instructions. -2. Download the installer at [fishshell.com](https://fishshell.com/) +2. Download the installer from the [fish shell website](https://fishshell.com/). -#### Step 2: Switch to fish as the default shell +#### 2. Switch to fish as the default shell Once you’ve installed fish on your computer, you can set it as your default shell, so Warp will use it every time a new tab, pane, or window is opened. You can either make fish the default shell for only Warp, from the session settings (**Settings** > **Features** > **Session**), or for your user account. To change your account's default shell, you need to run two commands. @@ -138,14 +138,14 @@ You can identify where fish is installed by running `which fish`. ### Using PowerShell (pwsh) with Warp on macOS -#### Step 1: Install PowerShell +#### 1. Install PowerShell -While bash, and zsh come pre-installed on macOS systems, PowerShell shell does not. So before using PowerShell with Warp, you will need to install it. Install PowerShell 7.0 or above using one of the methods listed below - +While bash and zsh come pre-installed on macOS systems, PowerShell does not. So before using PowerShell with Warp, you will need to install it. Install PowerShell 7.0 or above using one of the methods listed below: 1. With Homebrew: If you already have homebrew installed, you can simply type `brew install powershell/tap/powershell`, and follow the instructions. 2. Download from the [official Microsoft website](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell). -#### Step 2: Switch to pwsh as the default shell +#### 2. Switch to pwsh as the default shell Once you’ve installed PowerShell on your computer, you can set it as your default shell, so Warp will use it every time a new tab, pane, or window is opened. You can either make pwsh the default shell for only Warp, from the session settings (**Settings** > **Features** > **Session**), or for your user account. To change your account's default shell, you need to run two commands. diff --git a/src/content/docs/guides/agent-workflows/how-to-edit-agent-code-in-warp.mdx b/src/content/docs/guides/agent-workflows/how-to-edit-agent-code-in-warp.mdx index 1c38df58..eb026686 100644 --- a/src/content/docs/guides/agent-workflows/how-to-edit-agent-code-in-warp.mdx +++ b/src/content/docs/guides/agent-workflows/how-to-edit-agent-code-in-warp.mdx @@ -18,7 +18,7 @@ This makes debugging and bug-fix workflows fast, transparent, and interactive. --- -### 1. Starting an Agent Task +### 1. Starting an agent task When you start an agent task, Warp: @@ -33,31 +33,31 @@ Warp shows progress step-by-step, including what it’s searching and which file --- -### 2. Reviewing Diffs +### 2. Reviewing diffs Warp generates diffs for every proposed change.\ You can: * Accept changes -* Refine them with a follow-up prompt (`Cmd + R`) +* Refine them with a follow-up prompt (`Cmd+R`) * Or directly edit the code in the inline editor view This editor view works like a lightweight IDE — perfect for quick corrections before applying. --- -### 3. Applying or Skipping Changes +### 3. Applying or skipping changes Once you’re happy with a diff: -* Click Apply Changes to accept it -* Or Fast-Forward to let Warp automatically continue the rest of the fix sequence +* Click **Apply Changes** to accept it +* Or **Fast-Forward** to let Warp automatically continue the rest of the fix sequence -You can control this level of autonomy globally in Settings → AI → Autonomy. +You can control this level of autonomy globally in **Settings** > **AI** > **Autonomy**. --- -### 4. Compiling and Verifying Fixes +### 4. Compiling and verifying fixes After applying changes, you can immediately test your build, like: @@ -69,7 +69,7 @@ Warp monitors compilation, verifies results, and runs post-checks automatically. --- -### 5. Visual Verification +### 5. Visual verification In this example, the bug involved a checkbox not being honored in the UI.\ \ diff --git a/src/content/docs/guides/agent-workflows/how-to-explain-your-codebase-using-warp-rust-codebase.mdx b/src/content/docs/guides/agent-workflows/how-to-explain-your-codebase-using-warp-rust-codebase.mdx index 40d10c37..c1a2a8f9 100644 --- a/src/content/docs/guides/agent-workflows/how-to-explain-your-codebase-using-warp-rust-codebase.mdx +++ b/src/content/docs/guides/agent-workflows/how-to-explain-your-codebase-using-warp-rust-codebase.mdx @@ -41,14 +41,14 @@ This walkthrough shows: so I can add a new agent button to it. ``` -2. #### How Warp’s Agent Searches +2. #### How Warp’s agent searches Warp begins by using **semantic (vectorized) search** to locate relevant files.\ Once it finds probable matches (e.g., `agent_management_popup.rs`), it switches to **symbolic search** (`grep` and direct code reads). Warp intelligently reads large files (splitting them into smaller chunks) to extract relevant definitions and render logic. -3. #### Generated Explanation +3. #### Generated explanation Warp returns a full breakdown: diff --git a/src/content/docs/guides/agent-workflows/how-to-review-ai-generated-code.mdx b/src/content/docs/guides/agent-workflows/how-to-review-ai-generated-code.mdx index 9f31eb4c..1b17d9b3 100644 --- a/src/content/docs/guides/agent-workflows/how-to-review-ai-generated-code.mdx +++ b/src/content/docs/guides/agent-workflows/how-to-review-ai-generated-code.mdx @@ -92,7 +92,7 @@ You can add as many comments as you need before submitting — Warp batches them Once you've reviewed each file and left comments, submit the complete batch. The agent receives all your feedback, applies the requested changes in one pass, and returns an updated diff. -Review the updated diff to verify the fixes. Repeat this cycle until the code meets your standards: comment, submit, review. +Review the updated diff to verify the fixes. Repeat this cycle until the code meets your standards: comment, submit, review. :::note This workflow applies to **any CLI agent** running in Warp, not just the built-in agent. You can leave inline comments on diffs generated by Claude Code, Codex, or OpenCode and send them back to the running agent session. diff --git a/src/content/docs/guides/agent-workflows/how-to-review-prs-like-a-senior-dev.mdx b/src/content/docs/guides/agent-workflows/how-to-review-prs-like-a-senior-dev.mdx index 651d0afa..6fdd4d6b 100644 --- a/src/content/docs/guides/agent-workflows/how-to-review-prs-like-a-senior-dev.mdx +++ b/src/content/docs/guides/agent-workflows/how-to-review-prs-like-a-senior-dev.mdx @@ -13,7 +13,7 @@ tags: import VideoEmbed from '@components/VideoEmbed.astro'; import { Steps } from '@astrojs/starlight/components'; -Learn how to prompt Warp’s AI to review pull requests like an experienced engineer — focusing on structure, red flags, and clarity +Learn how to prompt Warp’s AI to review pull requests like an experienced engineer — focusing on structure, red flags, and clarity. @@ -28,12 +28,12 @@ Learn how to prompt Warp’s AI to review pull requests like an experienced engi Although this example focuses on large PRs, the same workflow applies to **code reviews**, **design docs**, or **feature diffs**. -2. #### The Problem +2. #### The problem Large PRs are difficult to parse.\ AI summaries gloss over nuance and may miss subtle issues — you need structured, prioritized insight instead. -3. #### The Prompt +3. #### The prompt Use this in Warp’s AI input: diff --git a/src/content/docs/guides/agent-workflows/how-to-run-3-agents-in-parallel-summarize-logs-analyze-pr-modify-ui.mdx b/src/content/docs/guides/agent-workflows/how-to-run-3-agents-in-parallel-summarize-logs-analyze-pr-modify-ui.mdx index 272e4a17..65323e3f 100644 --- a/src/content/docs/guides/agent-workflows/how-to-run-3-agents-in-parallel-summarize-logs-analyze-pr-modify-ui.mdx +++ b/src/content/docs/guides/agent-workflows/how-to-run-3-agents-in-parallel-summarize-logs-analyze-pr-modify-ui.mdx @@ -32,7 +32,7 @@ In the demo, we run three parallel workflows: -1. #### Launch Agents in Parallel +1. #### Launch agents in parallel Each agent runs in its own tab. @@ -52,30 +52,30 @@ In the demo, we run three parallel workflows: Analyze how many pull requests a team member has assigned. ``` - Use the GitHub CLI tool to summarize all open PRs for review that are assigned to user. I'd like to see who is the author of the PR, when was it opened, how long has it been open for, which repo is it in, are there open an dunaddressed commens on it, and is it ready for review? + Use the GitHub CLI tool to summarize all open PRs for review that are assigned to user. I'd like to see who is the author of the PR, when was it opened, how long has it been open for, which repo is it in, are there open and unaddressed comments on it, and is it ready for review? ``` Summarize Cloud Run logs by error severity. ``` - Use the gcloud tool to list all my open projects. Once you've done that, let me select a project. Once I've selected a project, we will want to see all the Cloud Run instances that are available. Then once I've picked a Cloud Run instance, I'd like to get a sumary of the last 2000 logs from that Cloud Run instance to see the history histogram of different types of logging on info, warning, and error levels. + Use the gcloud tool to list all my open projects. Once you've done that, let me select a project. Once I've selected a project, we will want to see all the Cloud Run instances that are available. Then once I've picked a Cloud Run instance, I'd like to get a summary of the last 2000 logs from that Cloud Run instance to see the history histogram of different types of logging on info, warning, and error levels. ``` -2. #### Monitor All Agents +2. #### Monitor all agents The **task pane** in Warp shows all running agents.\ You can view plans, progress, and results live without interrupting other tasks. -3. #### Review Results +3. #### Review results * **Coding Agent:** Implements UI fixes accurately. * **Code Review Agent:** Reports 26 open PRs (identifies bottlenecks). * **Log Agent:** Analyzes 1,000 log entries, categorizing errors and flagging Gemini API issues. -4. #### Why This Matters +4. #### Why this matters Warp multi‑agent execution allows you to: diff --git a/src/content/docs/guides/agent-workflows/running-multiple-agents-at-once-with-warp.mdx b/src/content/docs/guides/agent-workflows/running-multiple-agents-at-once-with-warp.mdx index 31d3b3cd..b20db6fe 100644 --- a/src/content/docs/guides/agent-workflows/running-multiple-agents-at-once-with-warp.mdx +++ b/src/content/docs/guides/agent-workflows/running-multiple-agents-at-once-with-warp.mdx @@ -13,7 +13,7 @@ import VideoEmbed from '@components/VideoEmbed.astro'; -### 1. Why Multiple Agents Matter +### 1. Why multiple agents matter Sometimes you need to work on several coding tasks at once — fix a PR, add a feature, debug a build — without losing context.\ \ @@ -21,7 +21,7 @@ Warp lets you run multiple agent tasks simultaneously, all within one workspace. --- -### 2. How It Works +### 2. How it works Each agent runs in its own thread, complete with: @@ -33,7 +33,7 @@ Because Warp is a desktop app, it can send system notifications to alert you whe --- -### 3. Example: Reverting a PR and Editing a Shortcut +### 3. Example: reverting a PR and editing a shortcut Ben uses voice mode to quickly start tasks. @@ -51,13 +51,13 @@ Warp notifies him when the task completes. Then, he runs another prompt: Prompt Example:\ -“Change the keyboard shortcut to `Cmd + Shift + I`.” +“Change the keyboard shortcut to `Cmd+Shift+I`.” Warp modifies `input.rs`, previews the diff, and Ben applies the change directly from Warp. --- -### 4. Managing Multiple Tasks +### 4. Managing multiple tasks You can switch between concurrent agents: @@ -69,7 +69,7 @@ You can even fast-forward agents to auto-approve all code diffs once you trust t --- -### 5. Parallel Contexts +### 5. Parallel contexts In another repo, Ben adds a new Eval test via a different agent: @@ -86,7 +86,7 @@ Meanwhile, the first agent continues working on the keyboard shortcut task. --- -### 6. Reviewing All Active Agents +### 6. Reviewing all active agents Open the Agent Mode Dashboard to see: diff --git a/src/content/docs/guides/agent-workflows/understanding-your-codebase.mdx b/src/content/docs/guides/agent-workflows/understanding-your-codebase.mdx index fd580ef3..ac41a013 100644 --- a/src/content/docs/guides/agent-workflows/understanding-your-codebase.mdx +++ b/src/content/docs/guides/agent-workflows/understanding-your-codebase.mdx @@ -13,7 +13,7 @@ import VideoEmbed from '@components/VideoEmbed.astro'; -### 1. The Challenge +### 1. The challenge Kevin, who worked on Warp’s Windows and Linux builds, wanted to jump into a feature he hadn’t touched before: Block Sharing.\ \ @@ -23,7 +23,7 @@ That’s where Codebase Context comes in. --- -### 2. What Is Codebase Context? +### 2. What is Codebase Context? Warp’s Codebase Context uses semantic search to understand your code.\ It doesn’t rely on exact function or variable names — instead, it searches based on meaning. @@ -38,7 +38,7 @@ This prompt tells Warp to: --- -### 3. Real Example: Block Sharing +### 3. Real example: Block Sharing Kevin types `block sharing` into Warp’s shared workflow.\ Warp: @@ -57,7 +57,7 @@ No more manual onboarding or guessing file names. --- -### 4. Incremental Syncing +### 4. Incremental syncing Whenever you change a file in an indexed repo: @@ -69,7 +69,7 @@ That means agents never reference stale code. --- -### 5. Why It’s Game-Changing +### 5. Why it’s game-changing Codebase Context helps teams: diff --git a/src/content/docs/guides/agent-workflows/using-images-as-context-with-warp.mdx b/src/content/docs/guides/agent-workflows/using-images-as-context-with-warp.mdx index 89fb79e4..80fb15ba 100644 --- a/src/content/docs/guides/agent-workflows/using-images-as-context-with-warp.mdx +++ b/src/content/docs/guides/agent-workflows/using-images-as-context-with-warp.mdx @@ -13,7 +13,7 @@ import VideoEmbed from '@components/VideoEmbed.astro'; -### 1. Why Images Matter +### 1. Why images matter Humans process visuals much faster than text — and the same applies to AI.\ \ @@ -25,7 +25,7 @@ That’s why Warp supports images as context — letting you attach screenshots --- -### 2. What Image Context Does +### 2. What image context does Image Context allows you to: @@ -41,15 +41,15 @@ This is especially useful for frontend tasks like: --- -### 3. Building an MCP Marketplace from Figma +### 3. Building an MCP marketplace from Figma Taking a Figma mock of an MCP Server Marketplace and using it as input for Warp. -#### Step 1. Capture the Mock +#### 1. Capture the mock Take a screenshot of your design (e.g., the MCP Marketplace layout). -#### Step 2. Attach the Image +#### 2. Attach the image In Warp: @@ -59,7 +59,7 @@ In Warp: --- -### 4. Running the Task +### 4. Running the task Once attached, Warp’s agent: @@ -74,7 +74,7 @@ You can view and edit these diffs in the Code Diff Viewer, similar to GitHub’s --- -### 5. Reviewing the Results +### 5. Reviewing the results The agent built: @@ -88,7 +88,7 @@ The agent built: --- -### 6. Optimizing for Performance +### 6. Optimizing for performance Because images can consume tokens quickly, Warp automatically: diff --git a/src/content/docs/guides/agent-workflows/warp-vs-claude-code.mdx b/src/content/docs/guides/agent-workflows/warp-vs-claude-code.mdx index f8f3df34..274996af 100644 --- a/src/content/docs/guides/agent-workflows/warp-vs-claude-code.mdx +++ b/src/content/docs/guides/agent-workflows/warp-vs-claude-code.mdx @@ -29,7 +29,7 @@ Both can: --- -### 2. Setup and Interface +### 2. Setup and interface #### Claude Code @@ -45,12 +45,12 @@ Both can: --- -### 3. Reviewing Diffs +### 3. Reviewing diffs In Claude Code: * You manually review diffs via CLI or external editors like VS Code. -* You can hit Shift + Tab to auto-accept all edits. +* You can hit `Shift+Tab` to auto-accept all edits. In Warp: @@ -60,7 +60,7 @@ In Warp: --- -### 4. Planning & Context Gathering +### 4. Planning & context gathering Both support planning mode for complex tasks: @@ -74,7 +74,7 @@ For context: --- -### 5. Model Selection +### 5. Model selection Claude Code lets you pick between Claude 3 models (`Sonnet`, `Opus`, `Haiku`) via the `/model` menu. @@ -97,7 +97,7 @@ In Claude Code: In Warp: -* Configure from Settings → AI & Agents. +* Configure from **Settings** > **AI & Agents**. * Add MCP servers, prompts, and global rules. * Define Agent Profiles for read/write permissions, autonomy, and planning behavior. * Maintain a global rules directory for consistent behavior across projects. @@ -106,7 +106,7 @@ Warp also supports codebase indexing, which creates embeddings for faster semant --- -### 7. Managing Agents Over Time +### 7. Managing agents over time Claude Code: @@ -120,7 +120,7 @@ Warp: --- -### 8. Performance Comparison +### 8. Performance comparison Ben ran both tools on the same coding task — fixing a bug in the `renderKeyboardShortcut` function from a Sentry issue. diff --git a/src/content/docs/guides/build-an-app-in-warp/building-a-chrome-extension-d3js-javascript-html-css.mdx b/src/content/docs/guides/build-an-app-in-warp/building-a-chrome-extension-d3js-javascript-html-css.mdx index e3c8a444..696380a5 100644 --- a/src/content/docs/guides/build-an-app-in-warp/building-a-chrome-extension-d3js-javascript-html-css.mdx +++ b/src/content/docs/guides/build-an-app-in-warp/building-a-chrome-extension-d3js-javascript-html-css.mdx @@ -21,7 +21,7 @@ This educational module teaches you step-by-step how to replicate the process sh -1. #### Set up your environment and create a new Chrome Extension project +1. #### Set up your environment and create a new Chrome extension project Our goal: build a Chrome extension called **“Sankey Stone”** that visualizes flows using **D3.js**. diff --git a/src/content/docs/guides/build-an-app-in-warp/building-a-real-time-chat-app-github-mcp-railway.mdx b/src/content/docs/guides/build-an-app-in-warp/building-a-real-time-chat-app-github-mcp-railway.mdx index f33eb7d4..fad520ce 100644 --- a/src/content/docs/guides/build-an-app-in-warp/building-a-real-time-chat-app-github-mcp-railway.mdx +++ b/src/content/docs/guides/build-an-app-in-warp/building-a-real-time-chat-app-github-mcp-railway.mdx @@ -28,10 +28,10 @@ The project: a **real-time chat application** built with **Python (FastAPI)** an -1. #### Setup & Installation +1. #### Setup & installation :::note - Warp is free for Mac, Linux, and Windows. Download it from the [Warp homepage](https://www.warp.dev/) and sign in with an account. + Warp is free for macOS, Linux, and Windows. Download it from the [Warp homepage](https://www.warp.dev/) and sign in with an account. ::: Once you open Warp, you’ll see three core modes: @@ -44,7 +44,7 @@ The project: a **real-time chat application** built with **Python (FastAPI)** an Pro tip: Enable voice input for natural prompting or attach screenshots when debugging UI issues. -2. #### Generate an App Idea +2. #### Generate an app idea Warp supports _planning models_, where the AI generates a detailed roadmap before coding. @@ -56,7 +56,7 @@ The project: a **real-time chat application** built with **Python (FastAPI)** an \ Chosen idea we went with: **a real-time chat application**. -3. #### Create a Development Plan +3. #### Create a development plan Prompt: @@ -123,17 +123,17 @@ The project: a **real-time chat application** built with **Python (FastAPI)** an Please execute this plan. ``` -4. #### Allow Autonomous Execution +4. #### Allow autonomous execution Once Warp starts executing, you can let Warp run commands automatically: - 1. Go to **Settings → AI → Agents** + 1. Go to **Settings** > **AI** > **Agents** 2. Change **“Always Ask”** → **“Always Allow”** 3. Ensure restricted commands (e.g., `rm -rf`) remain blocked This enables autonomous execution for safe, fast iteration. Warp will run shell commands, create directories, initialize files, and write code. -5. #### Running the App +5. #### Running the app First, you can click into any file, like `main.py` to edit it directly in Warp. Warp displays your file directly in the app for easy editing, similar to any regular IDE experience. @@ -145,7 +145,7 @@ The project: a **real-time chat application** built with **Python (FastAPI)** an Can you run this app for me so I can test it? Tell me how to view it. ``` - It's possible (like in the video) for an error to occur (e.g., Internal Server Error). If that happens, y you can simply debug conversationally: + It's possible (like in the video) for an error to occur (e.g., Internal Server Error). If that happens, you can debug conversationally: ```bash I’m getting an internal server error. Can you fix this? @@ -153,7 +153,7 @@ The project: a **real-time chat application** built with **Python (FastAPI)** an And Warp can fix the issue and rerun the app automatically. -6. #### Adding New Features +6. #### Adding new features To enhance the app, request features conversationally: @@ -163,13 +163,13 @@ The project: a **real-time chat application** built with **Python (FastAPI)** an Warp will modify frontend and backend code, updating WebSocket logic for real-time reactions. After testing, multiple users can now react to messages in the chat interface. -7. #### Preparing for Deployment +7. #### Preparing for deployment Warp integrates directly with version control and cloud deployers via **MCP servers**. Connect GitHub MCP: - 1. Go to **Settings → AI → MCP Servers → Add** + 1. Go to **Settings** > **AI** > **MCP Servers** > **Add** 2. Add a JSON block for GitHub MCP: ```json diff --git a/src/content/docs/guides/build-an-app-in-warp/building-warps-input-with-warp.mdx b/src/content/docs/guides/build-an-app-in-warp/building-warps-input-with-warp.mdx index b2ef154b..6bf2c01d 100644 --- a/src/content/docs/guides/build-an-app-in-warp/building-warps-input-with-warp.mdx +++ b/src/content/docs/guides/build-an-app-in-warp/building-warps-input-with-warp.mdx @@ -16,7 +16,7 @@ _Speaker: Dave, Product Design Lead at Warp_ -### The Challenge +### The challenge Redesigning the input was tricky because it’s the primary interface developers use all day, every day.\ Everyone had opinions — and expectations — about how it should look and behave. @@ -24,11 +24,11 @@ Everyone had opinions — and expectations — about how it should look and beha So, Peter (a product designer on my team) and I iterated on multiple designs using Figma. Once we landed on a version we liked, we shared it internally.\ -Most people were excited, but engineering resources were stretched thin — focused on improving agent-mode quality and prepping the Agentic Development Environment. +Most people were excited, but engineering resources were stretched thin — focused on improving Agent Mode quality and prepping the Agentic Development Environment. So I thought: _“What if I just Warp it?”_ -#### Step 1. Locating the Git Diff Chip Code +#### 1. Locating the Git Diff chip code Inside the universal input, there’s a small Git Diff chip — it shows your current branch and open changes. It was one pixel too tall. That tiny visual bug drove me nuts, so I used Warp to find where it lived. @@ -41,7 +41,7 @@ It used a combination of semantic search, code indexing, and traditional grep to --- -#### Step 2. Modifying the Font Size +#### 2. Modifying the font size Once Warp located the implementation, I asked it to reduce the font size by 1 pixel. @@ -54,7 +54,7 @@ I reviewed the diffs to confirm everything looked good. --- -#### Step 3. Building and Testing the Change +#### 3. Building and testing the change Next, I rebuilt the app using: diff --git a/src/content/docs/guides/configuration/creating-rules-for-agents.mdx b/src/content/docs/guides/configuration/creating-rules-for-agents.mdx index 9a7c8d07..ca7a9337 100644 --- a/src/content/docs/guides/configuration/creating-rules-for-agents.mdx +++ b/src/content/docs/guides/configuration/creating-rules-for-agents.mdx @@ -15,7 +15,7 @@ _Speaker: Maggie — Engineer at Warp_ -### 1. Starting with Agent Mode Evals +### 1. Starting with Agent Mode evals I’m currently adding **Evals** (short for evaluations) to test a new feature I’ve been building. @@ -25,7 +25,7 @@ This makes onboarding onto new tasks fast and collaborative. --- -### 2. Adding a Rust Syntax Eval +### 2. Adding a Rust syntax eval Next, I want to add an Eval that tests for Rust syntax errors.\ So I ask Warp to update the Dockerfile to include Rust. @@ -35,7 +35,7 @@ It also includes `gcc` and `python` via a single `apt-get` line, which doesn’t --- -### 3. Stashing Changes & Creating a Rule +### 3. Stashing changes and creating a Rule Instead of fixing this manually every time, I decide to stash the current changes and create a reusable Rule that encodes our convention: diff --git a/src/content/docs/guides/configuration/how-to-configure-yolo-and-strategic-agent-profiles.mdx b/src/content/docs/guides/configuration/how-to-configure-yolo-and-strategic-agent-profiles.mdx index e4ccaf65..a3996784 100644 --- a/src/content/docs/guides/configuration/how-to-configure-yolo-and-strategic-agent-profiles.mdx +++ b/src/content/docs/guides/configuration/how-to-configure-yolo-and-strategic-agent-profiles.mdx @@ -20,7 +20,7 @@ This tutorial explains how **Agent Profiles** in Warp influence behavior, autono -1. #### Define the Project +1. #### Define the project I want to create an app that scrapes **NFL data** from the past decade, processes stats like team scores and player performance, and predicts future wins. @@ -99,7 +99,7 @@ This tutorial explains how **Agent Profiles** in Warp influence behavior, autono * Compute scores and transformations * Instead of using unstable schedule URLs, it focuses on reliable player endpoints — completing a functional data pipeline. -4. #### Compare Outcomes +4. #### Compare outcomes diff --git a/src/content/docs/guides/configuration/how-to-create-project-rules-for-an-existing-project-astro-typescript-tailwind.mdx b/src/content/docs/guides/configuration/how-to-create-project-rules-for-an-existing-project-astro-typescript-tailwind.mdx index 06ea5050..2ef3cd46 100644 --- a/src/content/docs/guides/configuration/how-to-create-project-rules-for-an-existing-project-astro-typescript-tailwind.mdx +++ b/src/content/docs/guides/configuration/how-to-create-project-rules-for-an-existing-project-astro-typescript-tailwind.mdx @@ -20,7 +20,7 @@ This educational module is built **only** from the transcript. It shows how to c --- -## What Project Rules Are +## What Project Rules are A **Project Rules** file (`Warp.md`) acts as your project’s AI onboarding guide. Instead of re‑explaining your setup on every prompt, you document it once and Warp will always have that context. The transcript demo walks through creating the file, opening it in a side editor, and organizing it with standard Markdown headings for clear sections. @@ -203,15 +203,15 @@ Uses TypeScript path mapping with `@/*` pointing to `./src/*` for clean imports. --- -## Keep the File Lean and Intentional +## Keep the file lean and intentional -1. #### Start Lean +1. #### Start lean Everything in `warp.md` is **prepended to your prompt**. A longer file consumes more tokens and can increase compute cost. Keep only what truly matters. -2. #### Iterate and Maintain +2. #### Iterate and maintain Start with `/init` boilerplate, then treat the file as a **living document**. Add the rules that help your team ship faster (e.g., branching, PR guidelines) and prune anything redundant. @@ -223,7 +223,7 @@ If the file grows large (e.g., **500+ lines**), run it through a **prompt optimi --- -## Use Sub‑directory Rules for Monorepos +## Use sub‑directory Rules for monorepos For large repos, you can generate localized rule files in sub‑trees. Navigate into a subfolder and run `/init` again to create a **directory‑scoped `Warp.md`** tailored to that area: diff --git a/src/content/docs/guides/configuration/how-to-set-coding-best-practices.mdx b/src/content/docs/guides/configuration/how-to-set-coding-best-practices.mdx index bcec4a7c..d1df0fa7 100644 --- a/src/content/docs/guides/configuration/how-to-set-coding-best-practices.mdx +++ b/src/content/docs/guides/configuration/how-to-set-coding-best-practices.mdx @@ -28,12 +28,12 @@ By specifying formatting, style preferences, and documentation standards, Warp e -1. #### The Problem +1. #### The problem Developers often have different habits — formatting styles, TypeScript conventions, or comment quality.\ Without clear rules, AI-generated code can be inconsistent or hard to maintain. -2. #### The Rule Setup +2. #### The Rule setup Define Rules that enforce formatting, type preferences, and doc quality. diff --git a/src/content/docs/guides/configuration/how-to-set-coding-preferences-with-rules.mdx b/src/content/docs/guides/configuration/how-to-set-coding-preferences-with-rules.mdx index a01baa7b..930fdecd 100644 --- a/src/content/docs/guides/configuration/how-to-set-coding-preferences-with-rules.mdx +++ b/src/content/docs/guides/configuration/how-to-set-coding-preferences-with-rules.mdx @@ -20,14 +20,14 @@ This tutorial teaches you how to customize your development setup using **Warp -1. #### The Problem +1. #### The problem When using AI tools to write or modify code, they often default to outdated or undesired tools.\ For example, many agents still use **npm** instead of **pnpm** — or **pip** instead of **miniconda**. Warp fixes this by letting you define your preferences once, and then applying them automatically whenever your agent runs commands. -2. #### The Rule Setup +2. #### The Rule setup You can set Rules for how you want the AI to handle environments, dependencies, and commands. @@ -41,7 +41,7 @@ This tutorial teaches you how to customize your development setup using **Warp ``` This ensures the agent automatically chooses the right package manager or environment — no extra prompts required. -3. #### Supported Use Cases +3. #### Supported use cases You can apply Rules to: diff --git a/src/content/docs/guides/configuration/how-to-set-tech-stack-preferences-with-rules.mdx b/src/content/docs/guides/configuration/how-to-set-tech-stack-preferences-with-rules.mdx index 2aa0c29f..4723bfc3 100644 --- a/src/content/docs/guides/configuration/how-to-set-tech-stack-preferences-with-rules.mdx +++ b/src/content/docs/guides/configuration/how-to-set-tech-stack-preferences-with-rules.mdx @@ -25,7 +25,7 @@ By setting up tech stack Rules, you make sure every new project follows your con --- -## The Problem +## The problem When you ask AI to scaffold a new web app, it often defaults to **React** and **Express**, or other older stacks.\ This creates friction when your workflow is based on modern tools or opinionated frameworks. @@ -34,7 +34,7 @@ Warp solves this by letting you **store your stack preferences** directly as Rul --- -## The Rule Setup +## The Rule setup Create a simple Rule that defines your favorite frameworks for each project type. @@ -56,7 +56,7 @@ Think of it like setting a default coding personality for your agent. --- -## Why It Matters +## Why it matters :::tip Defining your stack preferences helps the AI: diff --git a/src/content/docs/guides/configuration/how-to-sync-your-monorepos.mdx b/src/content/docs/guides/configuration/how-to-sync-your-monorepos.mdx index 8ea19251..0ed4b7d2 100644 --- a/src/content/docs/guides/configuration/how-to-sync-your-monorepos.mdx +++ b/src/content/docs/guides/configuration/how-to-sync-your-monorepos.mdx @@ -28,7 +28,7 @@ Although this example uses Warp’s internal repos, the same workflow applies to --- -## The Problem +## The problem When projects are split into multiple repos — like backend, client, and shared schema — developers often forget to synchronize type changes manually. @@ -36,7 +36,7 @@ That’s error-prone and time-consuming. Warp solves this by teaching your **age --- -## The Rule Setup +## The Rule setup Describe each repository and its connection to the others. diff --git a/src/content/docs/guides/configuration/how-to-use-agent-profiles-efficiently.mdx b/src/content/docs/guides/configuration/how-to-use-agent-profiles-efficiently.mdx index 1b2e0025..4b4d0c45 100644 --- a/src/content/docs/guides/configuration/how-to-use-agent-profiles-efficiently.mdx +++ b/src/content/docs/guides/configuration/how-to-use-agent-profiles-efficiently.mdx @@ -65,7 +65,7 @@ It avoids brittle endpoints and produces a working dataset fast — though with --- -### Comparing the Two +### Comparing the two | Trait | Strategic Agent | YOLO Agent | | --------- | ------------------- | ------------------ | diff --git a/src/content/docs/guides/configuration/trigger-reusable-actions-with-saved-prompts.mdx b/src/content/docs/guides/configuration/trigger-reusable-actions-with-saved-prompts.mdx index a05de925..bd84d13b 100644 --- a/src/content/docs/guides/configuration/trigger-reusable-actions-with-saved-prompts.mdx +++ b/src/content/docs/guides/configuration/trigger-reusable-actions-with-saved-prompts.mdx @@ -13,7 +13,7 @@ import VideoEmbed from '@components/VideoEmbed.astro'; -### 1. Automating Commits +### 1. Automating commits When working on a PR, instead of typing long commit messages, you can use a saved prompt. @@ -23,7 +23,7 @@ Warp’s agent: * Generates a clean commit message * Pushes it automatically to your branch -You can view the saved prompt in Warp Drive → Team Prompts, where it shows: +You can view the saved prompt in **Warp Drive** > **Team Prompts**, where it shows: * Who created it * When it was last used @@ -33,7 +33,7 @@ Because it’s saved in your team drive, anyone can reuse it. --- -### 2. Reviewing Code with Prompts +### 2. Reviewing code with prompts Before creating a PR, you can run another saved prompt. @@ -52,7 +52,7 @@ Warp automatically surfaces real issues before you even open a PR — saving tim --- -### 3. Opening a Pull Request Automatically +### 3. Opening a pull request automatically Once your code looks clean, trigger your final saved prompt. @@ -65,7 +65,7 @@ Warp will: --- -### 4. Sharing and Team Usage +### 4. Sharing and team usage All saved prompts live in your Team Warp Drive, meaning: diff --git a/src/content/docs/guides/devops/how-to-analyze-cloud-run-logs-gcloud.mdx b/src/content/docs/guides/devops/how-to-analyze-cloud-run-logs-gcloud.mdx index 4b06905a..c4b342d5 100644 --- a/src/content/docs/guides/devops/how-to-analyze-cloud-run-logs-gcloud.mdx +++ b/src/content/docs/guides/devops/how-to-analyze-cloud-run-logs-gcloud.mdx @@ -18,7 +18,7 @@ Learn how to use Warp to retrieve, organize, and analyze production logs from yo -1. #### Setting the Context +1. #### Setting the context Open Warp and enable **voice input** (optional) for hands-free prompting. @@ -36,7 +36,7 @@ Learn how to use Warp to retrieve, organize, and analyze production logs from yo and highlight the most concerning errors to investigate. ``` -2. #### Warp’s Agent in Action +2. #### Warp’s agent in action After you hit Enter: @@ -45,7 +45,7 @@ Learn how to use Warp to retrieve, organize, and analyze production logs from yo * Executes the necessary `gcloud` logging queries automatically. * Writes retrieved data to a temporary file for processing. -3. #### Automated Analysis +3. #### Automated analysis Warp’s agent generates a **Python script** on the fly to: @@ -64,7 +64,7 @@ Learn how to use Warp to retrieve, organize, and analyze production logs from yo You can view or fast-forward execution, or stop the process at any point. -4. #### Reviewing Results +4. #### Reviewing results Warp outputs a readable histogram and highlights anomalies.\ For example: diff --git a/src/content/docs/guides/devops/how-to-create-a-production-ready-docker-setup.mdx b/src/content/docs/guides/devops/how-to-create-a-production-ready-docker-setup.mdx index 0bfb43b8..463035f0 100644 --- a/src/content/docs/guides/devops/how-to-create-a-production-ready-docker-setup.mdx +++ b/src/content/docs/guides/devops/how-to-create-a-production-ready-docker-setup.mdx @@ -23,12 +23,12 @@ Although this example uses a generic web app, the same pattern applies to **Pyth -1. #### The Challenge +1. #### The challenge You’ve built your app and suddenly realize — it should have been containerized from the start.\ Manually configuring Docker files, image sizes, and environment variables takes time and breaks flow. -2. #### The Prompt +2. #### The prompt Use this prompt inside Warp’s AI input: @@ -46,7 +46,7 @@ Although this example uses a generic web app, the same pattern applies to **Pyth ``` Warp will detect frameworks, infer services, and produce a ready-to-run setup. -3. #### Review and Customize +3. #### Review and customize Warp outputs: diff --git a/src/content/docs/guides/devops/how-to-create-priority-matrix-for-database-optimization.mdx b/src/content/docs/guides/devops/how-to-create-priority-matrix-for-database-optimization.mdx index 2cf98161..a43c6461 100644 --- a/src/content/docs/guides/devops/how-to-create-priority-matrix-for-database-optimization.mdx +++ b/src/content/docs/guides/devops/how-to-create-priority-matrix-for-database-optimization.mdx @@ -24,12 +24,12 @@ Learn how to generate a data-driven optimization matrix that ranks database issu It analyzes SQL queries, identifies common inefficiencies, and generates a **priority matrix** for improvements. -2. #### The Problem +2. #### The problem When you tell AI to “optimize a query,” that could mean _anything_ — faster, safer, or simpler.\ Instead, use Warp to clarify intent and return measurable outcomes. -3. #### The Prompt +3. #### The prompt Paste this into Warp’s AI input: @@ -289,7 +289,7 @@ Learn how to generate a data-driven optimization matrix that ranks database issu ```` Warp will locate all SQL usage, test each query, and score them using explain-plan data. -4. #### Review the Matrix +4. #### Review the matrix The output includes: diff --git a/src/content/docs/guides/devops/how-to-generate-unit-and-security-tests-to-debug-faster.mdx b/src/content/docs/guides/devops/how-to-generate-unit-and-security-tests-to-debug-faster.mdx index d4238661..ead22f06 100644 --- a/src/content/docs/guides/devops/how-to-generate-unit-and-security-tests-to-debug-faster.mdx +++ b/src/content/docs/guides/devops/how-to-generate-unit-and-security-tests-to-debug-faster.mdx @@ -20,14 +20,14 @@ Learn how to prompt Warp’s AI to generate useful unit and security tests — h -1. #### The Problem +1. #### The problem Building REST APIs involves a lot of overhead: validation, testing, and security.\ Most “auto-generated tests” from AI end up generic and incomplete — leaving gaps in reliability. To solve this, Warp lets you run **precise, context-aware test generation** using better-structured prompts. -2. #### The Prompt +2. #### The prompt Paste this into Warp’s AI input: @@ -101,7 +101,7 @@ Learn how to prompt Warp’s AI to generate useful unit and security tests — h Keep these tests simple and focused - each test should verify ONE thing ``` -3. #### Add to Rules File +3. #### Add to Rules file Once you’ve validated the prompt, add it to your Warp Rules file so Warp can automatically reuse it. diff --git a/src/content/docs/guides/devops/how-to-prevent-secrets-from-leaking.mdx b/src/content/docs/guides/devops/how-to-prevent-secrets-from-leaking.mdx index f49548e4..8347f1d3 100644 --- a/src/content/docs/guides/devops/how-to-prevent-secrets-from-leaking.mdx +++ b/src/content/docs/guides/devops/how-to-prevent-secrets-from-leaking.mdx @@ -1,7 +1,7 @@ --- title: "Prevent secrets from leaking" description: >- - Use Warp Rules and built-in secret reduction to prevent API keys and + Use Warp Rules and built-in Secret Redaction to prevent API keys and credentials from leaking in agent output, demos, and shared sessions. sidebar: label: "Prevent secrets from leaking" @@ -12,7 +12,7 @@ tags: import VideoEmbed from '@components/VideoEmbed.astro'; import { Steps } from '@astrojs/starlight/components'; -Learn how to safeguard credentials and sensitive data using Warp’s secret-reduction and Rule system. +Learn how to safeguard credentials and sensitive data using Warp’s Secret Redaction and Rule system. @@ -20,12 +20,12 @@ This tutorial shows how to use Warp’s **Rules** to prevent agents or collabora -1. #### The Problem +1. #### The problem AI assistants often echo API keys, tokens, or credentials in generated code blocks.\ When collaborating or screen-sharing, that can expose secrets publicly. -2. #### The Rule Setup +2. #### The Rule setup Define a simple Rule in Warp that instructs the agent to **never display secrets** in outputs or commands. @@ -36,9 +36,9 @@ This tutorial shows how to use Warp’s **Rules** to prevent agents or collabora - Automatically redact sensitive strings before showing output. ``` :::note - Enable Warp’s built-in Secret Reduction: + Enable Warp’s built-in Secret Redaction: - Settings → AI → Enable Secret Reduction + **Settings** > **Privacy** > **Secret redaction** This automatically masks sensitive values before the agent or output logs can access them. ::: diff --git a/src/content/docs/guides/devops/how-to-write-sql-commands-inside-a-postgres-repl.mdx b/src/content/docs/guides/devops/how-to-write-sql-commands-inside-a-postgres-repl.mdx index f1ec69b5..42f07b15 100644 --- a/src/content/docs/guides/devops/how-to-write-sql-commands-inside-a-postgres-repl.mdx +++ b/src/content/docs/guides/devops/how-to-write-sql-commands-inside-a-postgres-repl.mdx @@ -27,7 +27,7 @@ Although the example uses **PostgreSQL**, the same workflow applies to **Node.js You’ll learn how to: * Start a Postgres REPL in Warp. -* Use **Command + I** (or **Ctrl + I**) to open Warp’s AI input. +* Use `Cmd+I` (or `Ctrl+I`) to open Warp’s AI input. * Speak or type natural-language requests and let Warp translate them into SQL. * Run the generated queries directly inside your REPL session. @@ -43,7 +43,7 @@ You’ll learn how to: You’ll enter the interactive `psql` prompt, where you normally type SQL commands. -2. #### Invoke Warp’s AI Input +2. #### Invoke Warp’s AI input Inside the running REPL, press: @@ -56,7 +56,7 @@ You’ll learn how to: You can **type or speak** in plain English — Warp will translate your request into valid SQL or shell syntax, depending on the REPL you’re in. -3. #### Ask Warp in Natural Language +3. #### Ask Warp in natural language Start with a simple request: @@ -85,7 +85,7 @@ You’ll learn how to: You can run both within your REPL to display the tables. -4. #### Observe How Warp Learns from Context +4. #### Observe how Warp learns from context As you continue issuing prompts, Warp’s agent **learns the structure of your database** by observing what’s printed in the REPL output. @@ -110,7 +110,7 @@ You’ll learn how to: Running this query in `psql` filters users accordingly. -5. #### Apply the Same Workflow to Other REPLs +5. #### Apply the same workflow to other REPLs This feature works **not just in Postgres** but also in: @@ -122,7 +122,7 @@ You’ll learn how to: For any of these environments: 1. Launch the REPL inside Warp. - 2. Press **Command + I** to bring up AI input. + 2. Press `Cmd+I` to bring up AI input. 3. Describe what you want in natural language. 4. Warp translates it into the correct syntax for that environment. @@ -130,7 +130,7 @@ You’ll learn how to: Warp automatically detects the active REPL, so you don’t need to specify “SQL” or “Python” — it knows which language to generate. ::: -6. #### Experiment and Iterate +6. #### Experiment and iterate Try varying your natural-language prompts: @@ -156,14 +156,14 @@ You’ll learn how to: --- -### 🏁 Key Takeaways +### 🏁 Key takeaways -* **Command + I** activates Warp’s AI input within any interactive shell. +* `Cmd+I` activates Warp’s AI input within any interactive shell. * Warp understands natural language and produces valid commands for the current REPL. * It **learns from context** — subsequent prompts become more accurate. * Works beyond Postgres: Node, Python, MySQL, and others. * A fast way to query or explore systems without memorizing syntax. :::tip -Next time you’re stuck remembering a command in Postgres or Python, hit **Command + I** and just ask Warp in plain English. +Next time you’re stuck remembering a command in Postgres or Python, hit `Cmd+I` and just ask Warp in plain English. ::: diff --git a/src/content/docs/guides/devops/improve-your-kubernetes-workflow-kubectl-helm.mdx b/src/content/docs/guides/devops/improve-your-kubernetes-workflow-kubectl-helm.mdx index 5442719e..4267763a 100644 --- a/src/content/docs/guides/devops/improve-your-kubernetes-workflow-kubectl-helm.mdx +++ b/src/content/docs/guides/devops/improve-your-kubernetes-workflow-kubectl-helm.mdx @@ -22,9 +22,9 @@ This guide covers 6 key Warp features that enhance Kubernetes productivity: -1. #### AI Integration in the Terminal +1. #### AI integration in the terminal - Warp’s **Agent Mode** (`Cmd + I`) lets you run complex Kubernetes operations with plain-English prompts. + Warp’s **Agent Mode** (`Cmd+I`) lets you run complex Kubernetes operations with plain-English prompts. **Examples** @@ -44,7 +44,7 @@ This guide covers 6 key Warp features that enhance Kubernetes productivity: Ideal for on-the-fly debugging or compliance checks without leaving your terminal. ::: -2. #### Building AI-Aided Context +2. #### Building AI-aided context You can attach any command’s output as context for follow-up prompts.\ For instance, right-click log output → “Attach as Agent Context,” then run: @@ -55,7 +55,7 @@ This guide covers 6 key Warp features that enhance Kubernetes productivity: Warp detects the Helm chart and outputs the required YAML config to disable stats reporting. -3. #### Active AI Suggestions +3. #### Active AI suggestions Warp automatically suggests next actions.\ Examples of suggested actions: @@ -67,16 +67,16 @@ This guide covers 6 key Warp features that enhance Kubernetes productivity: > “Run sudo apt upgrade to update packages.” -4. #### Custom Workflows +4. #### Custom workflows Create reusable, parameterized commands for common operations like: ```bash helm upgrade --namespace -f ``` - Accessible from the **Command Palette (`Cmd + P`)**, workflows make repetitive Kubernetes tasks fast and standardized. + Accessible from the **Command Palette** (`Cmd+P`), workflows make repetitive Kubernetes tasks fast and standardized. -5. #### Synchronized Panes and Tabs +5. #### Synchronized panes and tabs Link multiple terminal panes or tabs (e.g., master + worker nodes).\ When synchronization is active, running: @@ -87,7 +87,7 @@ This guide covers 6 key Warp features that enhance Kubernetes productivity: executes simultaneously across all linked sessions. -6. #### Modern Text Editing +6. #### Modern text editing Warp supports **click-to-edit** for commands — no more arrow key gymnastics.\ Hovering shows inline **tooltips** explaining flags and subcommands (e.g., Helm, kubectl, etc.), with autocompletions for 400+ CLI tools. diff --git a/src/content/docs/guides/external-tools/context7-mcp-update-astro-project-with-best-practices.mdx b/src/content/docs/guides/external-tools/context7-mcp-update-astro-project-with-best-practices.mdx index bcb97322..b24c98c5 100644 --- a/src/content/docs/guides/external-tools/context7-mcp-update-astro-project-with-best-practices.mdx +++ b/src/content/docs/guides/external-tools/context7-mcp-update-astro-project-with-best-practices.mdx @@ -30,7 +30,7 @@ In the example, the agent updates an older **Astro** project to align with the l -1. #### Add the Context7 Server +1. #### Add the Context7 server * Open Warp’s **MCP Panel** via the Command Palette. * Add the **Context7 JSON config** and click **Save**. @@ -51,7 +51,7 @@ In the example, the agent updates an older **Astro** project to align with the l * This enables the endpoint `getLibraryDocs`, which retrieves live documentation directly from the official sources. -2. #### Run the Update Prompt +2. #### Run the update prompt The developer issues this prompt: @@ -59,7 +59,7 @@ In the example, the agent updates an older **Astro** project to align with the l Create a new git branch called update and in that branch update this Astro project to follow all the latest best practices based on all Astro and developer documentation. ``` -3. #### Review the Automatic Code Changes +3. #### Review the automatic code changes The transcript shows that Warp automatically: @@ -70,7 +70,7 @@ In the example, the agent updates an older **Astro** project to align with the l These edits happen across multiple files — without manually searching docs or changelogs. -4. #### Best Use Cases +4. #### Best use cases * Migrating old Astro, React, or Vue projects * Refreshing codebases to reflect recent standards diff --git a/src/content/docs/guides/external-tools/figma-remote-mcp-create-a-website-from-a-figma-file-from-scratch.mdx b/src/content/docs/guides/external-tools/figma-remote-mcp-create-a-website-from-a-figma-file-from-scratch.mdx index 5570ee80..81f9e842 100644 --- a/src/content/docs/guides/external-tools/figma-remote-mcp-create-a-website-from-a-figma-file-from-scratch.mdx +++ b/src/content/docs/guides/external-tools/figma-remote-mcp-create-a-website-from-a-figma-file-from-scratch.mdx @@ -33,7 +33,7 @@ This guide covers how to: -1. #### What Is a Remote MCP Server? +1. #### What is a remote MCP server? A **remote MCP server** runs outside your local machine — Warp connects to it through a secure network call.\ \ @@ -58,7 +58,7 @@ This guide covers how to: You will need a Figma Dev account for this to work. ::: -3. #### What the Figma MCP Server Provides +3. #### What the Figma MCP server provides Once connected, the server enables Warp’s AI to understand your design context by fetching: @@ -69,7 +69,7 @@ This guide covers how to: | **`get_code`** | Extracts code from your Figma design for direct use in projects. | | **`get_metadata`** | Includes text, images, and layer names for more realistic mock data. | -4. #### Generate a Website from a Figma File +4. #### Generate a website from a Figma file Basic flow: @@ -88,13 +88,13 @@ This guide covers how to: ``` Warp uses the Figma MCP server to pull all necessary context and begin generating code diffs. -5. #### Iterating on Output +5. #### Iterating on output * In under five minutes, Warp generates a working site structure based on the Figma layout. * Missing assets (e.g., logos or images) are automatically referenced in an `assets/` folder. * Warp prompts you to add any missing files before continuing. -6. #### Persistent Input Feature +6. #### Persistent input feature Warp’s **persistent input** allows mid-process updates.\ If you forget an image (e.g., the Misho logo), simply upload it and notify Warp: diff --git a/src/content/docs/guides/external-tools/github-mcp-summarizing-open-prs-and-creating-gh-issues.mdx b/src/content/docs/guides/external-tools/github-mcp-summarizing-open-prs-and-creating-gh-issues.mdx index b57fc41f..45178c69 100644 --- a/src/content/docs/guides/external-tools/github-mcp-summarizing-open-prs-and-creating-gh-issues.mdx +++ b/src/content/docs/guides/external-tools/github-mcp-summarizing-open-prs-and-creating-gh-issues.mdx @@ -20,25 +20,25 @@ The GitHub MCP Server lets Warp agents read, write, and automate tasks in your G ### 2. Setup -#### Step 1. Get a GitHub Personal Access Token +#### Step 1. Get a GitHub personal access token -1. Go to **GitHub → Settings → Developer Settings → Personal Access Tokens** +1. Go to **GitHub** > **Settings** > **Developer Settings** > **Personal Access Tokens** 2. Create a new token and enable: * ✅ `repo` * ✅ `read:user` --- -#### Step 2. Add the Server in Warp +#### Step 2. Add the server in Warp -1. Open the **MCP Panel** via Command Palette (`Cmd + P`) +1. Open the **MCP Panel** via Command Palette (`Cmd+P`) 2. Click **Add Server** 3. Paste in your JSON config and the access token 4. Save — and you’ll see the available endpoints immediately --- -### 3. Workflow 1 — Summarize All Open PRs +### Step 3. Workflow 1 — Summarize all open PRs Use Warp’s agent to summarize pull requests: @@ -52,7 +52,7 @@ Perfect for daily PR triage or stand-ups. --- -### 4. Workflow 2 — Create GitHub Issues from TODOs +### Step 4. Workflow 2 — Create GitHub issues from TODOs Use a saved prompt to automate issue creation. @@ -66,7 +66,7 @@ This turns scattered notes into trackable tickets instantly. --- -### 5. Why It’s Useful +### Why it’s useful * Save 20–30 minutes per session * Keep repos synchronized automatically diff --git a/src/content/docs/guides/external-tools/how-to-set-up-codex-cli.mdx b/src/content/docs/guides/external-tools/how-to-set-up-codex-cli.mdx index 749ca2c5..f059be1e 100644 --- a/src/content/docs/guides/external-tools/how-to-set-up-codex-cli.mdx +++ b/src/content/docs/guides/external-tools/how-to-set-up-codex-cli.mdx @@ -87,7 +87,7 @@ Switch between available models during a session with the `/model` command. See Codex has three [approval modes](https://developers.openai.com/codex/cli/features#approval-modes) that control how much autonomy it has. * **Auto** (the default) lets Codex read, edit, and run commands within your working directory but asks before anything outside that scope. -* **Read-only** keeps Codex consultative +* **Read-only** keeps Codex consultative. * **Full Access** grants broader autonomy including network access. Use `/permissions` inside a session to switch modes as your comfort level changes. diff --git a/src/content/docs/guides/external-tools/how-to-set-up-ollama.mdx b/src/content/docs/guides/external-tools/how-to-set-up-ollama.mdx index df2dd1b3..b620bcf5 100644 --- a/src/content/docs/guides/external-tools/how-to-set-up-ollama.mdx +++ b/src/content/docs/guides/external-tools/how-to-set-up-ollama.mdx @@ -19,7 +19,7 @@ In this guide, we’ll walk through how to use Warp to install, profile, and int --- -### 1. Check Your System Specs +### 1. Check your system specs Before running large language models (LLMs) locally, confirm your hardware can handle them. @@ -32,7 +32,7 @@ Example setups: --- -### 2. Run Your First Model +### 2. Run your first model Run a model locally: @@ -48,7 +48,7 @@ Use Warp to easily monitor GPU usage and model response time. --- -### 3. Understanding Model Terms +### 3. Understanding model terms Here’s a quick glossary for choosing the right local model: @@ -62,7 +62,7 @@ Here’s a quick glossary for choosing the right local model: --- -### 4. Integrate Ollama into Your App +### 4. Integrate Ollama into your app Most apps use OpenAI-compatible APIs, so integration is simple. @@ -75,7 +75,7 @@ Warp helps you quickly locate, edit, and test the integration directly from the --- -### 6. Customize Model Behavior +### 6. Customize model behavior Pull and modify a model. diff --git a/src/content/docs/guides/external-tools/linear-mcp-retrieve-issue-data.mdx b/src/content/docs/guides/external-tools/linear-mcp-retrieve-issue-data.mdx index 64088ae1..345b0fde 100644 --- a/src/content/docs/guides/external-tools/linear-mcp-retrieve-issue-data.mdx +++ b/src/content/docs/guides/external-tools/linear-mcp-retrieve-issue-data.mdx @@ -22,12 +22,12 @@ This tutorial covers how to: * Add and configure a Linear MCP server in Warp * Use MCP to query and retrieve issue data -### 1. Adding the Linear MCP Serve +### 1. Adding the Linear MCP server #### Add a new server in Warp -* In Warp, open Warp Drive → Personal → MCP Servers.\ - Alternatively, press `⌘P` and type **MCP servers** to open the palette. +* In Warp, open **Warp Drive** > **Personal** > **MCP Servers**.\ + Alternatively, press `⌘+P` and type **MCP servers** to open the palette. * Click **Add New Server**. * Paste in this JSON @@ -42,13 +42,13 @@ This tutorial covers how to: } ``` -* Click Save. +* Click **Save**. * Warp will immediately start the server. * You should now see Linear MCP listed as Running. --- -### 2. Testing the Connection +### 2. Testing the connection After saving, retry your earlier query: diff --git a/src/content/docs/guides/external-tools/linear-mcp-updating-tickets-with-a-lean-build-approach.mdx b/src/content/docs/guides/external-tools/linear-mcp-updating-tickets-with-a-lean-build-approach.mdx index 705a2392..a2c93cdc 100644 --- a/src/content/docs/guides/external-tools/linear-mcp-updating-tickets-with-a-lean-build-approach.mdx +++ b/src/content/docs/guides/external-tools/linear-mcp-updating-tickets-with-a-lean-build-approach.mdx @@ -29,14 +29,14 @@ This walkthrough demonstrates: -1. #### Setting Up the Scenario +1. #### Setting up the scenario The goal is to use Warp’s agent to update a Linear epic with a new, leaner build approach and reflect the changes in related subtasks. First, open your Linear project and locate the target epic.\ Copy the **ticket ID** (e.g. “Empty Studio 36”). -2. #### Define the Update Prompt +2. #### Define the update prompt Within Warp, run the MCP command to edit the Linear issue. @@ -49,7 +49,7 @@ This walkthrough demonstrates: ``` Warp parses the issue context and updates the ticket’s fields accordingly. -3. #### Observing the Changes +3. #### Observing the changes After execution: @@ -58,7 +58,7 @@ This walkthrough demonstrates: * Time estimates automatically adjust from _4–6 weeks_ to _2–3 weeks_. * Complex integrations (AI and Linear App) are deferred to a future phase. -4. #### Propagating Updates to Child Tasks +4. #### Propagating updates to child tasks Warp’s agent can cascade changes to linked subtasks.\ If it begins editing other epics unexpectedly, you can constrain its scope by specifying task IDs in the prompt: @@ -68,7 +68,7 @@ This walkthrough demonstrates: Do not modify other epics or related tickets. ``` -5. #### Review and Verification +5. #### Review and verification Re-open the Linear epic to confirm updates: diff --git a/src/content/docs/guides/external-tools/puppeteer-mcp-scraping-amazon-web-reviews.mdx b/src/content/docs/guides/external-tools/puppeteer-mcp-scraping-amazon-web-reviews.mdx index 7aff0659..415936c9 100644 --- a/src/content/docs/guides/external-tools/puppeteer-mcp-scraping-amazon-web-reviews.mdx +++ b/src/content/docs/guides/external-tools/puppeteer-mcp-scraping-amazon-web-reviews.mdx @@ -37,11 +37,11 @@ You’ll learn how to: -1. #### Configure the Puppeteer MCP Server +1. #### Configure the Puppeteer MCP server Open the MCP panel in Warp: - * Press **Cmd + Shift + P** (Mac) or **Ctrl + Shift + P** (Windows/Linux) to open the **Command Palette**. + * Press `Cmd+Shift+P` (macOS) or `Ctrl+Shift+P` (Windows/Linux) to open the **Command Palette**. * Search for `MCP` and open the **MCP Panel**. Add the Puppeteer MCP config: @@ -70,19 +70,19 @@ You’ll learn how to: These represent actions Warp can call automatically through its agents. -2. #### Use Voice Input to Trigger Automation +2. #### Use voice input to trigger automation Enable **voice input** by clicking the microphone icon in Warp. Then speak your automation prompt naturally. ``` - Can you go to Amazon search for "white t-short women?" + Can you go to Amazon search for "white t-shirt women?" Scrape the results so the titles, prices, and links are extracted. Then open each product link and summarize the product reviews. Finally, give me a recommendation for which shirt to buy based on the combination of the pricing and review quality. ``` - #### Watch Puppeteer Automate the Workflow + #### Watch Puppeteer automate the workflow Behind the scenes, Puppeteer: @@ -98,7 +98,7 @@ You’ll learn how to: Puppeteer runs fully headless or in visible browser mode — you don’t need to touch your mouse or keyboard. ::: - #### Analyze and Summarize Results + #### Analyze and summarize results Once the scrape is complete, Warp compiles the data and provides a ranked list of products. Example output (from transcript): @@ -112,7 +112,7 @@ You’ll learn how to: > “The Cozy T‑Shirt — $8, 4.5 stars, good fit, and soft fabric.” - #### Apply Puppeteer MCP to Other Scenarios + #### Apply Puppeteer MCP to other scenarios The same setup works for: diff --git a/src/content/docs/guides/external-tools/sentry-mcp-fix-sentry-error-in-empower-website.mdx b/src/content/docs/guides/external-tools/sentry-mcp-fix-sentry-error-in-empower-website.mdx index f81ae48b..92f60117 100644 --- a/src/content/docs/guides/external-tools/sentry-mcp-fix-sentry-error-in-empower-website.mdx +++ b/src/content/docs/guides/external-tools/sentry-mcp-fix-sentry-error-in-empower-website.mdx @@ -4,7 +4,7 @@ description: >- Connect the Sentry MCP server to Warp, fetch live error data, diagnose stack traces, and auto-generate fixes for production issues. sidebar: - label: "Sentry MCP: fix Sentry error in empower website" + label: "Sentry MCP: fix Sentry error in Empower website" tags: - "mcp" @@ -32,12 +32,12 @@ You’ll learn how to: -1. #### Set Up the Sentry MCP Server +1. #### Set up the Sentry MCP server Open the MCP panel in Warp: - * Mac: Cmd + Shift + P - * Windows/Linux: Ctrl + Shift + P\ + * macOS: `Cmd+Shift+P` + * Windows/Linux: `Ctrl+Shift+P`\ Search for “MCP” and select the **MCP Panel**. Click **Add**, then paste your configuration: @@ -58,7 +58,7 @@ You’ll learn how to: ``` Save the configuration and ensure it appears in the MCP panel. -2. #### Run Your App and Trigger an Error +2. #### Run your app and trigger an error We're using the [**Empower Plant** repository](https://github.com/sentry-demos/empower) — Sentry’s official demo project. This fake e-commerce app includes a React frontend and multiple backends, each containing intentional bugs for testing. @@ -71,7 +71,7 @@ You’ll learn how to: Open the site in your browser and trigger a few known errors. -3. #### Capture the Error in Sentry +3. #### Capture the error in Sentry 1. Go to your **Sentry Dashboard**. 2. Locate the triggered issue (for example, a `TypeError`). @@ -83,7 +83,7 @@ You’ll learn how to: https://sentry.io/organizations/demo/issues/12345/ ``` -4. #### Diagnose the Error Using Warp +4. #### Diagnose the error using Warp Back in Warp, prompt the agent to fetch and analyze the issue: @@ -100,11 +100,11 @@ You’ll learn how to: Warp’s agent automatically writes a fix — changing the code to handle the array properly. -5. #### Apply the Generated Fix +5. #### Apply the generated fix Warp produces a suggested code change inline. Review the diff and apply it automatically with one click. -6. #### Integrate Into Your Workflow +6. #### Integrate into your workflow Use Sentry MCP whenever you encounter production or staging errors. Warp can pull the latest issues, analyze them, and suggest patches. diff --git a/src/content/docs/guides/external-tools/sqlite-and-stripe-mcp-basic-queries-you-can-make-after-set-up.mdx b/src/content/docs/guides/external-tools/sqlite-and-stripe-mcp-basic-queries-you-can-make-after-set-up.mdx index ac3b7bc1..320765d9 100644 --- a/src/content/docs/guides/external-tools/sqlite-and-stripe-mcp-basic-queries-you-can-make-after-set-up.mdx +++ b/src/content/docs/guides/external-tools/sqlite-and-stripe-mcp-basic-queries-you-can-make-after-set-up.mdx @@ -25,7 +25,7 @@ This tutorial teaches you how to use **MCP servers** to connect Warp to **Stripe To set it up: - * Open **Settings → AI → MCP Servers** in Warp. + * Open **Settings** > **AI** > **MCP Servers** in Warp. * Click **Add Server**, and choose from a list of available MCP configurations. * Once added, Warp automatically connects and authorizes the agent to use those tools. @@ -86,7 +86,7 @@ This tutorial teaches you how to use **MCP servers** to connect Warp to **Stripe Warp runs the updated SQL query and displays results inline. -4. #### Why This Matters +4. #### Why this matters This demo highlights how Warp’s AI and MCP support combine to make your terminal: diff --git a/src/content/docs/guides/frontend/how-to-actually-code-ui-that-matches-your-mockup-react-tailwind.mdx b/src/content/docs/guides/frontend/how-to-actually-code-ui-that-matches-your-mockup-react-tailwind.mdx index efddc072..0a7be74a 100644 --- a/src/content/docs/guides/frontend/how-to-actually-code-ui-that-matches-your-mockup-react-tailwind.mdx +++ b/src/content/docs/guides/frontend/how-to-actually-code-ui-that-matches-your-mockup-react-tailwind.mdx @@ -30,12 +30,12 @@ Although this example uses **React** and **Tailwind**, the same method applies t -1. #### The Problem +1. #### The problem When designing UI with AI, your intended design often gets lost in translation.\ AI struggles with visual fidelity — but structured prompts can help fix that. -2. #### The Prompt +2. #### The prompt Step — Generate full specifications: @@ -93,7 +93,7 @@ Although this example uses **React** and **Tailwind**, the same method applies t ``` -3. #### Validate and Iterate +3. #### Validate and iterate Warp outputs component files and layout structure.\ You can review spacing, font weights, and responsive behavior directly in preview. diff --git a/src/content/docs/guides/frontend/how-to-replace-a-ui-element-in-warp-rust-codebase.mdx b/src/content/docs/guides/frontend/how-to-replace-a-ui-element-in-warp-rust-codebase.mdx index 6fab8468..19c6e12a 100644 --- a/src/content/docs/guides/frontend/how-to-replace-a-ui-element-in-warp-rust-codebase.mdx +++ b/src/content/docs/guides/frontend/how-to-replace-a-ui-element-in-warp-rust-codebase.mdx @@ -22,7 +22,7 @@ This demo showcases Warp’s ability to safely make intelligent code changes wit -1. #### Define the Task +1. #### Define the task The goal here is to replace all instances of the **sparkle icon** with the new **agent icon**, especially within the history menu. @@ -40,7 +40,7 @@ This demo showcases Warp’s ability to safely make intelligent code changes wit Attach any relevant Linear issue links or screenshots to help the agent identify assets accurately. -2. #### Review the Plan +2. #### Review the plan Warp’s agent parses your request and generates a plan for code edits.\ It identifies files and functions where the sparkle icon is used. @@ -56,19 +56,19 @@ This demo showcases Warp’s ability to safely make intelligent code changes wit Warp automatically updates function names, asset references, and component usage. -3. #### View AI Diffs in Real Time +3. #### View AI diffs in real time Warp lets you view live diffs as the agent edits your files. * Diffs show changes to both render logic and function naming. * You can choose to auto-accept or manually review diffs. - * These settings can be adjusted under AI Settings → Apply Changes Automatically. + * These settings can be adjusted under **AI Settings** > **Apply Changes Automatically**. :::note Note: The demo runs with “auto-accept” enabled, allowing Warp to apply diffs as soon as they’re validated. ::: -4. #### Compilation and Fixes +4. #### Compilation and fixes After editing, Warp’s agent runs: @@ -80,7 +80,7 @@ This demo showcases Warp’s ability to safely make intelligent code changes wit If compilation fails (e.g., missing imports), the agent automatically corrects and retries — mimicking a human debugging process. -5. #### Testing the Change +5. #### Testing the change Once compiled: diff --git a/src/content/docs/guides/getting-started/10-coding-features-you-should-know.mdx b/src/content/docs/guides/getting-started/10-coding-features-you-should-know.mdx index 600af1bd..41ad52a6 100644 --- a/src/content/docs/guides/getting-started/10-coding-features-you-should-know.mdx +++ b/src/content/docs/guides/getting-started/10-coding-features-you-should-know.mdx @@ -13,7 +13,7 @@ tags: --- import VideoEmbed from '@components/VideoEmbed.astro'; -## 10 Coding Features You Should Know in Warp +## 10 coding features you should know in Warp If you didn’t already know, you can code directly in Warp. @@ -26,30 +26,30 @@ Let’s walk through the 10 core features you need to know to get started. --- -### 1. Search for Files +### 1. Search for files Open the **Command Palette**: -* **Mac:** `Cmd + P` -* **Windows/Linux:** `Ctrl + Shift + P` +* **macOS:** `Cmd+P` +* **Windows/Linux:** `Ctrl+Shift+P` Then press: -* **Mac:** `Cmd + O` -* **Windows/Linux:** `Ctrl + O` +* **macOS:** `Cmd+O` +* **Windows/Linux:** `Ctrl+O` From here, you can search and open any file in your project — no need to `cd` around or remember long paths. --- -### 2. Tabbed File Viewer +### 2. Tabbed file viewer When you open files, Warp shows them in **tabs** rather than split panes.\ This keeps your workspace clean while still allowing you to switch quickly between multiple files. --- -### 3. Full Editor Support +### 3. Full editor support You can edit code directly inside Warp — just like any modern editor. @@ -60,7 +60,7 @@ No need for memorized shortcuts: --- -### 4. Find and Replace +### 4. Find and replace Warp supports full **find and replace** with: @@ -73,7 +73,7 @@ These features make renaming variables or refactoring code fast and consistent. --- -### 5. Syntax Highlighting +### 5. Syntax highlighting Warp supports syntax highlighting for **dozens of languages and frameworks**.\ It appears both in: @@ -85,16 +85,16 @@ This makes it easy to visually scan code at a glance. --- -### 6. Linked File References +### 6. Linked file references When Warp’s agent references a file, it automatically **links to the exact line of code**.\ Clicking the link opens that file at that line inside Warp — perfect for tracing logic or verifying changes. -> ⚙️ **Tip:** In **Settings → Features**, set Warp as your default editor for these file links so they open directly in Warp. +> ⚙️ **Tip:** In **Settings** > **Features**, set Warp as your default editor for these file links so they open directly in Warp. --- -### 7. Code Review Panel +### 7. Code Review panel Warp provides a **dedicated review panel** summarizing all files and diffs touched by an agent.\ You can: @@ -107,14 +107,14 @@ This reduces hallucinations and keeps agents grounded in your actual code. --- -### 8. Code Snippet References +### 8. Code snippet references When Warp explains something about your codebase, it surfaces the **exact code snippet**.\ You can attach that snippet as fresh context for your next prompt. This keeps token usage lean and the agent's focus sharp. --- -### 9. Codebase Indexing +### 9. Codebase indexing Warp can automatically **index your repositories** for faster, more context-aware responses.\ This makes it easier for agents to: @@ -125,6 +125,6 @@ This makes it easier for agents to: --- -### 10. File Tree View +### 10. File tree view Click the file-tree icon in Warp to **browse your entire repo** and open any file with a single click. diff --git a/src/content/docs/guides/getting-started/how-to-customize-warps-appearance.mdx b/src/content/docs/guides/getting-started/how-to-customize-warps-appearance.mdx index 915490e0..b98bb422 100644 --- a/src/content/docs/guides/getting-started/how-to-customize-warps-appearance.mdx +++ b/src/content/docs/guides/getting-started/how-to-customize-warps-appearance.mdx @@ -19,12 +19,12 @@ Here’s a quick walkthrough of how to make Warp feel like _your_ development en --- -### 1. Changing Themes +### 1. Changing themes Open the **Command Palette** with: -* `Cmd + P` (Mac) -* `Ctrl + Shift + P` (Windows/Linux) +* `Cmd+P` (macOS) +* `Ctrl+Shift+P` (Windows/Linux) Type **“themes”** to open the theme picker. @@ -32,7 +32,7 @@ You can preview and apply any theme instantly — for example, switching from th --- -### 2. Adjusting Input Placement +### 2. Adjusting input placement Warp’s **input bar** can live in three different positions: @@ -42,9 +42,9 @@ Warp’s **input bar** can live in three different positions: --- -### 3. Managing AI & Agent Settings +### 3. Managing AI & agent settings -Open **Settings → AI** to control: +Open **Settings** > **AI** to control: * Which **model** Warp uses (e.g., Claude 3.5 for code generation, GPT-4o for planning). * How much **autonomy** agents have for: @@ -57,7 +57,7 @@ You can also allowlist or block specific commands that always require confirmati --- -### 4. Indexing Your Codebases +### 4. Indexing your codebases Warp prompts you to index your codebase the first time you `cd` into it.\ Indexing enables faster: @@ -70,7 +70,7 @@ You can also manually re-index a folder from the sidebar anytime. --- -### 5. Team Collaboration +### 5. Team collaboration In the Teams tab, you can: @@ -81,7 +81,7 @@ This makes Warp a shared, contextual workspace — not just an individual tool. --- -### 6. Look & Feel +### 6. Look & feel Under Appearance, you can tweak: diff --git a/src/content/docs/guides/getting-started/how-to-make-warps-ui-more-minimal.mdx b/src/content/docs/guides/getting-started/how-to-make-warps-ui-more-minimal.mdx index 7d1786e7..60b41309 100644 --- a/src/content/docs/guides/getting-started/how-to-make-warps-ui-more-minimal.mdx +++ b/src/content/docs/guides/getting-started/how-to-make-warps-ui-more-minimal.mdx @@ -17,24 +17,24 @@ import VideoEmbed from '@components/VideoEmbed.astro'; Open the Command Palette: -* Mac: `Cmd + P` -* Windows/Linux: `Ctrl + Shift + P` +* macOS: `Cmd+P` +* Windows/Linux: `Ctrl+Shift+P` From here, type “Disable” to see a full list of UI toggles.\ Warp will surface options that let you quickly hide features and visual elements. --- -### 2. Key UI Toggles to Disable +### 2. Key UI toggles to disable -#### Inline & AI Features +#### Inline and AI features * Disable Auto Suggestions → removes inline code hints. * Disable Active AI → hides the ghost prompt that suggests agent queries. * Disable Completion Menu → prevents popup completions from appearing. * Disable Voice Input → hides the microphone icon. -#### Interface & Layout +#### Interface and layout * Disable Block Dividers → removes the horizontal lines between commands. * Disable Tab Indicators → hides the colored status markers across your tab bar. @@ -43,12 +43,12 @@ Warp will surface options that let you quickly hide features and visual elements --- -### 3. Choose a Simpler Theme +### 3. Choose a simpler theme Visual noise can come from colors too.\ Try switching to a calmer theme from the Command Palette: -1. Open the palette again (`Cmd + P`) +1. Open the palette again (`Cmd+P`) 2. Type “Theme” 3. Pick one with softer tones — for example: * Adeberry → calm, gray, minimal aesthetic @@ -79,11 +79,11 @@ This instantly gives Warp a retro, text-first look — no clutter, no distractio --- -### 5. Reduce Tab Bar Visibility +### 5. Reduce tab bar visibility You can make the tab bar appear only when you hover: -* Open the Settings → Appearance +* Open **Settings** > **Appearance** * Enable “Show Tabs on Hover” This keeps your workspace focused while still letting you access tabs when needed. diff --git a/src/content/docs/guides/getting-started/how-to-master-warps-code-review-panel.mdx b/src/content/docs/guides/getting-started/how-to-master-warps-code-review-panel.mdx index 1b9f2615..81b344d6 100644 --- a/src/content/docs/guides/getting-started/how-to-master-warps-code-review-panel.mdx +++ b/src/content/docs/guides/getting-started/how-to-master-warps-code-review-panel.mdx @@ -15,13 +15,13 @@ import VideoEmbed from '@components/VideoEmbed.astro'; -### 1. Why Use the Code Review Panel +### 1. Why use the Code Review panel -Warp’s Code Review Panel helps you stay focused while coding by showing all active file diffs, additions, and deletions — without leaving your workspace. +Warp’s Code Review panel helps you stay focused while coding by showing all active file diffs, additions, and deletions — without leaving your workspace. --- -### 2. Start with a Coding Task +### 2. Start with a coding task The app has a UI issue: the hover text is black on dark gray, making it unreadable. @@ -29,14 +29,14 @@ Warp’s agent generates diffs with proposed fixes — but for larger projects, --- -### 3. Opening the Code Review Panel +### 3. Opening the Code Review panel Click: * View Changes (top-left), or * The Dirty Chip in your input bar -This opens the Code Review Panel — available only when inside a Git repo. +This opens the Code Review panel — available only when inside a Git repo. The panel shows: @@ -46,7 +46,7 @@ The panel shows: --- -### 4. Editing and Reviewing Code +### 4. Editing and reviewing code You can open any file directly from the panel in Warp’s **built-in editor**: @@ -58,7 +58,7 @@ Save changes — and they’ll reflect instantly in the diff view. --- -### 5. Componentizing Changes +### 5. Componentizing changes Want that same hover fix across the app?\ Prompt Warp to componentize the hover style. @@ -68,7 +68,7 @@ The agent then creates a `Tooltip` component that reuses your schema everywhere. --- -### 6. Reviewing and Committing +### 6. Reviewing and committing Once the fix looks correct: diff --git a/src/content/docs/guides/getting-started/welcome-to-warp.mdx b/src/content/docs/guides/getting-started/welcome-to-warp.mdx index 4b9ba952..049bbdbb 100644 --- a/src/content/docs/guides/getting-started/welcome-to-warp.mdx +++ b/src/content/docs/guides/getting-started/welcome-to-warp.mdx @@ -30,7 +30,7 @@ But when you type natural language — like _“describe my open git changes”_ --- -### 2. Prompt-Based Coding +### 2. Prompt-based coding When you ask something in plain English, Warp’s agent automatically: @@ -46,7 +46,7 @@ Warp’s agent will review your current branch, run git commands in the backgrou --- -### 3. Blending Terminal and Agentic Workflows +### 3. Blending terminal and agentic workflows The beauty of Warp is in how seamlessly it blends traditional CLI workflows with AI-driven automation.\ You can: diff --git a/src/content/docs/index.mdx b/src/content/docs/index.mdx index a93be368..4a29963f 100644 --- a/src/content/docs/index.mdx +++ b/src/content/docs/index.mdx @@ -26,7 +26,7 @@ Warp is where you work — a fast, modern terminal built for coding with agents. * [**Terminal and Agent modes**](/agent-platform/local-agents/interacting-with-agents/terminal-and-agent-modes/): Switch between a clean terminal for commands and a dedicated conversation view for multi-turn agent workflows. * [**Modern terminal UX**](/terminal/editor/): Cursor movement, block-based navigation, multi-line editing, syntax highlighting, and rich completions. Built with Rust for high performance. * [**Code editor**](/code/overview/): File tree, code editor with LSP support, and interactive code review experience. -* [**Third-Party CLI Agents**](/agent-platform/cli-agents/overview/): Run third-party CLI agents like Claude Code, Codex, and OpenCode with Warp's agent toolbelt — rich input, code review, notifications, and more. +* [**Third-party CLI agents**](/agent-platform/cli-agents/overview/): Run third-party CLI agents like Claude Code, Codex, and OpenCode with Warp's agent toolbelt — rich input, code review, notifications, and more. @@ -105,5 +105,5 @@ Warp's AI features can be globally disabled in **Settings** > **Agents** > **War * [**Quickstart**](/quickstart/): Get Warp installed and start coding * [**Warp Agents overview**](/agent-platform/local-agents/overview/): Explore all AI features available in Warp -* [**Cloud Agents Overview**](/agent-platform/cloud-agents/overview/): Set up background automation +* [**Cloud Agents overview**](/agent-platform/cloud-agents/overview/): Set up background automation * [**Oz Platform**](/agent-platform/cloud-agents/platform/): Learn about the CLI, API, SDK, and infrastructure diff --git a/src/content/docs/knowledge-and-collaboration/admin-panel.mdx b/src/content/docs/knowledge-and-collaboration/admin-panel.mdx index ef9fa04b..de74acd8 100644 --- a/src/content/docs/knowledge-and-collaboration/admin-panel.mdx +++ b/src/content/docs/knowledge-and-collaboration/admin-panel.mdx @@ -12,7 +12,7 @@ The Admin Panel gives team administrators centralized control over organization- The [Admin Panel](https://app.warp.dev/admin/) provides team administrators with centralized control over organization-wide settings in Warp. It allows you to manage workspace settings that are enforced across all members of your team. :::note -Admin Panel access is restricted to team administrators. Right now, only the creator of a team is the designated admin. If your admin has setup styles that override user preferences, you will not be able to control them inside of Warp, and you'll see a note that your admin has configured this setting. +Admin Panel access is restricted to team administrators. Right now, only the creator of a team is the designated admin. If your admin has set up styles that override user preferences, you will not be able to control them inside of Warp, and you'll see a note that your admin has configured this setting. ::: **Key features:** @@ -46,7 +46,7 @@ The Admin Panel uses a tier-based policy system to determine which settings admi **Fixed settings** are determined by your billing tier and cannot be changed. These appear with a message: "Configuring this setting is not available on your plan." -### Setting Inheritance +### Setting inheritance When administrators configure organization-wide settings: @@ -54,7 +54,7 @@ When administrators configure organization-wide settings: 2. **Respect user setting** - Allows individual team members to control the setting themselves 3. **Tier restricted** - Setting is locked to default values based on billing plan -### User Experience +### User experience :::note Any changes made in the Admin Panel can take effect immediately for all team members. Consider testing settings in Warp before applying organization-wide policies. @@ -66,7 +66,7 @@ When organization settings override individual preferences: * A message indicates "your organization has configured this setting" * Users cannot modify settings that are organizationally enforced -## Plan Limitations +## Plan limitations The features available in the Admin Panel vary by billing tier: @@ -94,17 +94,17 @@ For complete details about what's included in each plan, see [Warp pricing](http The Admin Panel is organized into five main sections, each focused on a specific area of team management: -### AI Settings +### AI settings Configure how Agents behave across your organization, including autonomy levels and command permissions. -#### General AI Settings +#### General AI settings **AI in Remote Sessions** Controls whether AI features are available during SSH sessions and remote connections. Enterprise plans can toggle this setting, while Free tier teams have it enabled by default. **Prompt Summarization Caching** When conversations become long enough to require summarization, this setting allows the summary to be cached temporarily by the LLM provider to improve performance. -#### Autonomy Settings +#### Autonomy settings Configure how much independence Agents have when performing different actions: @@ -121,7 +121,7 @@ Configure how much independence Agents have when performing different actions: **Read Files** Controls Agent access to reading files in the codebase. -#### Directory and Command Control +#### Directory and command control **Directory Allowlist** Specify directories where Agents can read files without restriction. Use paths like `~/git/repo1` to grant access to specific project folders. @@ -141,7 +141,7 @@ Configure how much independence Agents have when performing different actions: Command denylist rules take precedence over allowlist rules and agent autonomy settings. If a command matches the denylist, user permission will always be required. ::: -### Privacy Settings +### Privacy settings Manage data collection and security policies for your organization. @@ -157,7 +157,7 @@ Manage data collection and security policies for your organization. * Custom regex patterns for organization-specific secrets * Unconditional application across all team members -### Code Settings +### Code settings Control codebase indexing and AI code features for your team. @@ -169,7 +169,7 @@ Control codebase indexing and AI code features for your team. Higher tier plans support more indexed repositories and larger file limits per codebase. -### Billing Settings +### Billing settings Configure billing preferences and spending controls. @@ -180,7 +180,7 @@ Configure billing preferences and spending controls. * Total overage credits used * Current month's overage costs -### Sharing Settings +### Sharing settings Control how team members can share Warp Drive objects and collaborate. diff --git a/src/content/docs/knowledge-and-collaboration/teams.mdx b/src/content/docs/knowledge-and-collaboration/teams.mdx index 70b7dc12..91287237 100644 --- a/src/content/docs/knowledge-and-collaboration/teams.mdx +++ b/src/content/docs/knowledge-and-collaboration/teams.mdx @@ -55,7 +55,7 @@ When you share this link with your teammates directly (we suggest using a secure Sometimes you may want to control your team so that people can only join if they also authenticate with a specific email domain, such as your company’s email domain. -Toggle on Restrict by domain to set an explicit allowlist. +Toggle on **Restrict by domain** to set an explicit allowlist. If you share an invite link with somebody who’s using Warp with a domain that does not match your allowlist, they will be prompted to authenticate from an emailed link sent to a matching domain to join your team. diff --git a/src/content/docs/knowledge-and-collaboration/warp-drive/environment-variables.mdx b/src/content/docs/knowledge-and-collaboration/warp-drive/environment-variables.mdx index fcfdcf98..260ec742 100644 --- a/src/content/docs/knowledge-and-collaboration/warp-drive/environment-variables.mdx +++ b/src/content/docs/knowledge-and-collaboration/warp-drive/environment-variables.mdx @@ -53,7 +53,7 @@ Dynamic variables let you reference secrets that are stored securely outside of You can use custom commands to create dynamic variables for any system with a public API or CLI, such as AWS or Hashicorp Vault. -### **How to create and edit dynamic environment variables** +### How to create and edit dynamic environment variables To create a new dynamic variable: @@ -63,7 +63,7 @@ To create a new dynamic variable: ![Opening the dynamic environment variable menu via the key icon in the editor.](../../../../assets/terminal/env-var-dynamic-variables.png) -#### **Integrated password managers** +#### Integrated password managers Before you get started, please ensure you have the CLI installed for your tool of choice and follow the instructions to enable the CLI: @@ -82,7 +82,7 @@ Selecting a secret name never stores the actual secret. Warp uses your selection ![Selecting a secret name from the password manager CLI's available list of secrets.](https://lh7-rt.googleusercontent.com/docsz/AD_4nXcqiazhpRvaHxxSW5n3Ql6nFRDDRkyVdlRB9E-Q6HE0lpL2KFgwLM1P1PPrJG_i0KIHWuEKp2PMFq4T1auWvQOxXrpuERpLRZG1h2V4DDYmNRZRqShxjPzWyqGR2VfXYNhttAK0HT2-aQNjAt3xdCA9MwE?key=q_xMyXgvJVA02ysqZAH4Jw) -### **How to write a custom secret command** +### How to write a custom secret command Reference the documentation for your external secret manager. Then, write a custom command to retrieve secrets. diff --git a/src/content/docs/knowledge-and-collaboration/warp-drive/index.mdx b/src/content/docs/knowledge-and-collaboration/warp-drive/index.mdx index 19bea9e6..f46a98ba 100644 --- a/src/content/docs/knowledge-and-collaboration/warp-drive/index.mdx +++ b/src/content/docs/knowledge-and-collaboration/warp-drive/index.mdx @@ -106,7 +106,7 @@ To switch between panels using your keyboard, you can use the “Switch Focus to ![Switching focus between the terminal and Warp Drive panels via the Command Palette.](../../../../assets/terminal/warp_drive_nav2.png) -## Import and Export +## Import and export Every object in Warp Drive can be exported to or imported from a file. When importing or exporting, objects are converted as follows: @@ -126,7 +126,7 @@ To import a local file or directory, `RIGHT-CLICK` on a folder or click **+** on ### Exporting files from Warp Drive -To export a single Warp Drive object, `RIGHT-CLICK` on an object and choose "Export" from the menu, then select a directory for export. To export all Warp Drive objects, Open the [Command Palette](/terminal/command-palette/#how-to-access-it), search for and select "Export all Warp Drive objects", then select a directory for export. +To export a single Warp Drive object, `RIGHT-CLICK` on an object and choose "Export" from the menu, then select a directory for export. To export all Warp Drive objects, open the [Command Palette](/terminal/command-palette/#how-to-access-it), search for and select "Export all Warp Drive objects", then select a directory for export. ## Sharing your drive objects diff --git a/src/content/docs/knowledge-and-collaboration/warp-drive/notebooks.mdx b/src/content/docs/knowledge-and-collaboration/warp-drive/notebooks.mdx index cd1428b9..8738e2d2 100644 --- a/src/content/docs/knowledge-and-collaboration/warp-drive/notebooks.mdx +++ b/src/content/docs/knowledge-and-collaboration/warp-drive/notebooks.mdx @@ -38,7 +38,7 @@ Any of these entry points will open the notebook editor where you can: * Start adding text and code elements. :::note -Note: The notebook will not be saved until either title or body text is added. +The notebook will not be saved until either title or body text is added. :::
@@ -71,7 +71,7 @@ Existing notebook elements can be styled in several ways:
![Styling menu](../../../../assets/terminal/styling-menu.png)
-#### Using Command and Code Blocks +#### Using command and code blocks Command and code blocks have several unique properties such as syntax highlighting and quick actions that make working with code-based documentation simple. You can create a code or command block by either: @@ -89,7 +89,7 @@ Once you’ve inserted your code block you can select the language at the bottom If you insert a Command block or specify the language as “Shell”, Warp provides extra functionality to simplify terminal work. -#### Executing Command Blocks +#### Executing command blocks Developers can execute shell command blocks by: @@ -115,7 +115,7 @@ The command text will be inserted into the developer’s active terminal session
The run button on a command block in a Notebook.
-#### Adding arguments to Command Blocks +#### Adding arguments to command blocks Command blocks accept parameters in the same format as [Workflows](/knowledge-and-collaboration/warp-drive/workflows/). To add an argument to your command block, use `{{double_curly_brackets}}` to specify your argument term. @@ -163,7 +163,7 @@ If you have existing [Workflows](/knowledge-and-collaboration/warp-drive/workflo If the notebook is shared with a team, all team members will have access to edit the notebook and updates will sync immediately for all members of the team. :::note -Note that only one editor is allowed at a given time. Opening the notebook while there is an active editor will open the notebook in Viewing mode. Your mode (view vs edit) can be toggled above the notebook’s title. +Only one editor is allowed at a given time. Opening the notebook while there is an active editor will open the notebook in Viewing mode. Your mode (view vs edit) can be toggled above the notebook’s title. :::
diff --git a/src/content/docs/knowledge-and-collaboration/warp-drive/web.mdx b/src/content/docs/knowledge-and-collaboration/warp-drive/web.mdx index be8f38b7..ff5aecc2 100644 --- a/src/content/docs/knowledge-and-collaboration/warp-drive/web.mdx +++ b/src/content/docs/knowledge-and-collaboration/warp-drive/web.mdx @@ -5,11 +5,11 @@ description: >- screen device, including mobile phones, tablets, and touch-enabled laptops. --- -Warp Drive on the Web lets you view and edit Warp Drive objects and shared sessions directly in any browser, including mobile devices and tablets. Access Workflows, Notebooks, Prompts, and session transcripts from anywhere without installing the Warp desktop app. +Warp Drive on the web lets you view and edit Warp Drive objects and shared sessions directly in any browser, including mobile devices and tablets. Access Workflows, Notebooks, Prompts, and session transcripts from anywhere without installing the Warp desktop app. ## What is Warp on the web? -Warp Drive on the Web lets you view and edit your Warp Drive objects and shared sessions directly in the browser, on any device. +Warp Drive on the web lets you view and edit your Warp Drive objects and shared sessions directly in the browser, on any device.
![A web-based rendering of a Team Workflow](../../../../assets/terminal/wd-web-team-workflow.png) @@ -20,7 +20,7 @@ Warp Drive on the Web lets you view and edit your Warp Drive objects and shared Warp's web-based viewing experience can currently be accessed via: -* The [`app.warp.dev/app` homepage](https://app.warp.dev/app) +* The [Warp web app homepage](https://app.warp.dev/app) * [Drive Object](/knowledge-and-collaboration/warp-drive/#sharing-your-drive-objects) Links * [Session Sharing](/knowledge-and-collaboration/session-sharing/#how-to-allow-access-to-collaborators-in-your-session) Links @@ -56,7 +56,7 @@ If you would like to use Warp locally and do not have it installed, please visit ![Redirect screen with Open Warp and View on the web options](../../../../assets/terminal/wd-view-on-web.png) -## Supported Browsers +## Supported browsers Warp on the web supports all modern browsers, including: diff --git a/src/content/docs/knowledge-and-collaboration/warp-drive/workflows.mdx b/src/content/docs/knowledge-and-collaboration/warp-drive/workflows.mdx index 307d1a40..4e85db2f 100644 --- a/src/content/docs/knowledge-and-collaboration/warp-drive/workflows.mdx +++ b/src/content/docs/knowledge-and-collaboration/warp-drive/workflows.mdx @@ -66,7 +66,7 @@ To create an enum type argument: ### Working with aliases -Workflow aliases allow you to create personalized shortcuts and custom configurations for your frequently used workflows. These aliases provide enhanced flexibility in how you use and configure workflows. Aliases are personal to your account, not shared with everyone who has the workflow. If settings sync is enabled, they'll be synced across devices logged in to your account. Aliases can set default values for each [argument](/knowledge-and-collaboration/warp-drive/workflows/#working-with-arguments), but don't have to. Aliases can have [Environmental Variables](/knowledge-and-collaboration/warp-drive/environment-variables/) associated with them. +Workflow aliases allow you to create personalized shortcuts and custom configurations for your frequently used workflows. These aliases provide enhanced flexibility in how you use and configure workflows. Aliases are personal to your account, not shared with everyone who has the workflow. If settings sync is enabled, they'll be synced across devices logged in to your account. Aliases can set default values for each [argument](/knowledge-and-collaboration/warp-drive/workflows/#working-with-arguments), but don't have to. Aliases can have [Environment Variables](/knowledge-and-collaboration/warp-drive/environment-variables/) associated with them. :::note Workflow aliases are not compatible with [YAML Workflows](/terminal/entry/yaml-workflows/). They can only be used with Workflows created in [Warp Drive](/knowledge-and-collaboration/warp-drive/). @@ -81,7 +81,7 @@ Once a workflow has been created, you can edit it at any time, as long as you ha
The edit menu for a Workflow in Warp Drive.
-#### AI Autofill +#### AI autofill Workflows also have the option to use an [agent](/agent-platform/local-agents/overview/) to automatically generate a title, descriptions, or parameters. @@ -123,7 +123,7 @@ These options will paste the workflow into your active terminal input. Workflow
Executing a Workflow from Warp Drive.
-You make any adjustments you need to the arguments (or the command itself) before running the command in your input editor. +You can make any adjustments you need to the arguments (or the command itself) before running the command in your input editor. diff --git a/src/content/docs/reference/api-and-sdk/demo-sentry-monitoring-with-sdk.mdx b/src/content/docs/reference/api-and-sdk/demo-sentry-monitoring-with-sdk.mdx index f0574b03..1f246efb 100644 --- a/src/content/docs/reference/api-and-sdk/demo-sentry-monitoring-with-sdk.mdx +++ b/src/content/docs/reference/api-and-sdk/demo-sentry-monitoring-with-sdk.mdx @@ -6,7 +6,7 @@ description: >- --- import VideoEmbed from '@components/VideoEmbed.astro'; -### Turn Production Errors into Draft PRs with Cloud Agents + TypeScript SDK +### Turn production errors into draft PRs with Cloud Agents + TypeScript SDK diff --git a/src/content/docs/reference/api-and-sdk/index.mdx b/src/content/docs/reference/api-and-sdk/index.mdx index 64c09666..ce7f5fe7 100644 --- a/src/content/docs/reference/api-and-sdk/index.mdx +++ b/src/content/docs/reference/api-and-sdk/index.mdx @@ -23,7 +23,7 @@ The Oz API lets you create and inspect [Cloud Agent](/agent-platform/cloud-agent :::caution This page is a high-level overview.\ \ -For full API endpoint details, please refer to the [**Agents API Reference**](/api)**.** For schema definitions, see the SDK repos: [**Python SDK**](https://github.com/warpdotdev/oz-sdk-python) and [**TypeScript SDK**](https://github.com/warpdotdev/oz-sdk-typescript). +For full API endpoint details, refer to the [**Agents API Reference**](/api). For schema definitions, see the SDK repos: [**Python SDK**](https://github.com/warpdotdev/oz-sdk-python) and [**TypeScript SDK**](https://github.com/warpdotdev/oz-sdk-typescript). ::: ### Oz SDK @@ -52,7 +52,7 @@ For the full SDK surface area and latest usage, refer to the GitHub repos: [**Py ## Oz API -### REST API Base URL +### REST API base URL All endpoints are served over HTTPS: @@ -60,7 +60,7 @@ All endpoints are served over HTTPS: https://app.warp.dev/api/v1 ``` -### Core Concepts +### Core concepts #### **Agent runs** @@ -91,7 +91,7 @@ See the [**Python SDK**](https://github.com/warpdotdev/oz-sdk-python) or [**Type --- -### Key Endpoints +### Key endpoints **The Agents API exposes three primary endpoints:** @@ -109,7 +109,7 @@ All endpoint semantics, query parameters, and [error codes](/reference/api-and-s --- -#### Models Reference +#### Models reference The API shares a set of reusable models across endpoints. Detailed JSON schemas, types, and enums are available in the SDK repos ([Python](https://github.com/warpdotdev/oz-sdk-python), [TypeScript](https://github.com/warpdotdev/oz-sdk-typescript)). Key models include: diff --git a/src/content/docs/reference/cli/api-keys.mdx b/src/content/docs/reference/cli/api-keys.mdx index 77195681..08cc720a 100644 --- a/src/content/docs/reference/cli/api-keys.mdx +++ b/src/content/docs/reference/cli/api-keys.mdx @@ -21,7 +21,7 @@ You can create an API key in either the [Oz web app](https://oz.warp.dev/setting ### From the Oz web app (recommended) -1. Open [oz.warp.dev/settings](https://oz.warp.dev/settings). +1. Open the [Oz web app settings page](https://oz.warp.dev/settings). 2. In the API keys section, click **Generate new token**. 3. Choose the type: * **Personal** — Tied to your individual Warp account. @@ -86,7 +86,7 @@ API keys start with the prefix `wk-`. If your key doesn't have this prefix, it m ## Managing API keys -The Oz web app at [oz.warp.dev/settings](https://oz.warp.dev/settings) and the Warp app's **Settings** > **Cloud platform** > **Oz Cloud API Keys** both list your active keys. Both surfaces show: +The [Oz web app settings page](https://oz.warp.dev/settings) and the Warp app's **Settings** > **Cloud platform** > **Oz Cloud API Keys** both list your active keys. Both surfaces show: * **Name** — The name you assigned when creating the key. * **Scope** — Personal keys show your user; agent keys show the cloud agent the key runs as. diff --git a/src/content/docs/reference/cli/index.mdx b/src/content/docs/reference/cli/index.mdx index 8a9110ba..3c9f5a3b 100644 --- a/src/content/docs/reference/cli/index.mdx +++ b/src/content/docs/reference/cli/index.mdx @@ -38,7 +38,7 @@ The Oz CLI is automatically distributed with the Warp desktop app and can be use To add the Oz CLI to your `PATH`: - 1. Open the [Command Palette](/terminal/command-palette/) (`CMD+P` ) + 1. Open the [Command Palette](/terminal/command-palette/) (`Cmd+P`) 2. In the search field, find and select the **Install Oz CLI Command** action. :::note diff --git a/src/content/docs/reference/cli/integration-setup.mdx b/src/content/docs/reference/cli/integration-setup.mdx index 4b45cabf..1e1b0cb8 100644 --- a/src/content/docs/reference/cli/integration-setup.mdx +++ b/src/content/docs/reference/cli/integration-setup.mdx @@ -62,7 +62,7 @@ If setup fails, use the returned error code to narrow the fix. Common errors inc --- -## Step 1: Creating an environment +## 1. Creating an environment Before you can trigger agents from Slack or Linear, you need an environment. The environment defines how and where Warp runs your code. @@ -157,11 +157,11 @@ For more details about environment configuration, see the [Slack](/agent-platfor --- -## Step 2: Authorizing GitHub +## 2. Authorizing GitHub Warp needs GitHub access so agents can clone your repositories and, when permitted, write code and open pull requests. -#### How GitHub Authorization works +#### How GitHub authorization works When you create an environment or integration, Warp will prompt you to: @@ -198,7 +198,7 @@ For full setup instructions, see [Team GitHub authorization](/agent-platform/clo --- -## Step 3: Setting up an integration +## 3. Setting up an integration Once you have set up at least one environment, you can create integrations that connect it to Slack or Linear. diff --git a/src/content/docs/reference/cli/troubleshooting.mdx b/src/content/docs/reference/cli/troubleshooting.mdx index ea9eabb2..12f620b4 100644 --- a/src/content/docs/reference/cli/troubleshooting.mdx +++ b/src/content/docs/reference/cli/troubleshooting.mdx @@ -72,7 +72,7 @@ This is the most reliable way to verify what the agent will see when it runs. #### How do I add or remove repos and setup commands? -Use `oz environment` update. You can modify environments incrementally without recreating them. +Use `oz environment update`. You can modify environments incrementally without recreating them. **Add a repo:** diff --git a/src/content/docs/support-and-community/community/contributing.mdx b/src/content/docs/support-and-community/community/contributing.mdx index 428121ec..7003348d 100644 --- a/src/content/docs/support-and-community/community/contributing.mdx +++ b/src/content/docs/support-and-community/community/contributing.mdx @@ -14,7 +14,7 @@ Warp's client is open source under [AGPL v3](https://github.com/warpdotdev/warp/ * **Build a theme** - Submit a new color scheme or improve an existing one at [`warpdotdev/themes`](https://github.com/warpdotdev/themes). * **Share a workflow** - Add reusable command patterns to [`warpdotdev/workflows`](https://github.com/warpdotdev/workflows). Merged workflows ship to every Warp user. * **Publish Warp Drive objects** - Share Workflows, Notebooks, Rules, and Prompts publicly from [Warp Drive](/knowledge-and-collaboration/warp-drive/). -* **Find an issue to pick up** - Browse [`build.warp.dev`](https://build.warp.dev), a live dashboard of the work Warp's agents are tackling across `warpdotdev/warp`. Use it to spot gaps, avoid duplicate work, and surface issues that haven't been claimed yet. +* **Find an issue to pick up** - Browse [Warp's live agent dashboard](https://build.warp.dev), which shows the work Warp's agents are tackling across `warpdotdev/warp`. Use it to spot gaps, avoid duplicate work, and surface issues that haven't been claimed yet. * **Help others in the community** - Answer questions in the [Warp community Slack](https://go.warp.dev/join-preview) or [Discord](https://discord.com/invite/warpdotdev), and join conversations in [GitHub Discussions](https://github.com/warpdotdev/warp/discussions). ## Send feedback and bug reports diff --git a/src/content/docs/support-and-community/community/refer-a-friend.mdx b/src/content/docs/support-and-community/community/refer-a-friend.mdx index 3bf4a038..2f1f463f 100644 --- a/src/content/docs/support-and-community/community/refer-a-friend.mdx +++ b/src/content/docs/support-and-community/community/refer-a-friend.mdx @@ -43,7 +43,7 @@ If your friend joins and activates their Warp account after clicking your invite > **Last Updated:** November 27, 2024 -### 1 referral: An exclusive theme +### 1 referral: an exclusive theme When someone joins Warp with your referral code, the referral theme will become available in your theme picker after you restart the app. We also send an email alerting you. This reward is available to all users worldwide. diff --git a/src/content/docs/support-and-community/privacy-and-security/network-log.mdx b/src/content/docs/support-and-community/privacy-and-security/network-log.mdx index 969221e3..d85880c4 100644 --- a/src/content/docs/support-and-community/privacy-and-security/network-log.mdx +++ b/src/content/docs/support-and-community/privacy-and-security/network-log.mdx @@ -20,10 +20,10 @@ Each log item is a timestamped Debug format string for either a request or respo 2. That will insert a command into your Input editor - it should look something like this: `tail -f "some/path/to/warp_network.log"`. 3. Press Enter to run this command. You’ll then see the corresponding requests and responses logged in the network log. -## How it Works +## How it works -## Known issues with Network Log +## Known issues with network log At the moment, network traffic originating from crash reports and error messages is not captured in the network log. This is due to our use of the Sentry SDK, which encapsulates all network logic and doesn’t currently expose a hook for handling requests and responses directly. The team is actively investigating a solution to include such traffic in the log in a future release. You may also disable Crash Reporting entirely in Warp’s **Settings** > **Privacy** tab. diff --git a/src/content/docs/support-and-community/privacy-and-security/privacy.mdx b/src/content/docs/support-and-community/privacy-and-security/privacy.mdx index 46ab1430..46f4ef62 100644 --- a/src/content/docs/support-and-community/privacy-and-security/privacy.mdx +++ b/src/content/docs/support-and-community/privacy-and-security/privacy.mdx @@ -67,7 +67,7 @@ If you're a [Team](/knowledge-and-collaboration/teams/) admin, the deletion flow ::: -### Exhaustive Telemetry Table +### Exhaustive telemetry table | Event Name | Description | |---|---| diff --git a/src/content/docs/support-and-community/troubleshooting-and-support/known-issues.mdx b/src/content/docs/support-and-community/troubleshooting-and-support/known-issues.mdx index 0967ce1b..2338e1d9 100644 --- a/src/content/docs/support-and-community/troubleshooting-and-support/known-issues.mdx +++ b/src/content/docs/support-and-community/troubleshooting-and-support/known-issues.mdx @@ -19,7 +19,7 @@ Please note that there are tools that are incompatible with Warp, as listed [bel ### SSH -To enable Blocks over SSH, Warp uses an SSH Wrapper function; navigate to settings > features if you need to disable it. Please see [Troubleshooting Legacy SSH](/terminal/warpify/ssh-legacy/#troubleshooting-ssh) for more info on workarounds to SSH issues, or see the [new SSH Page](/terminal/warpify/ssh/) for more on the upcoming features. +To enable Blocks over SSH, Warp uses an SSH Wrapper function; navigate to **Settings** > **Features** if you need to disable it. Please see [Troubleshooting Legacy SSH](/terminal/warpify/ssh-legacy/#troubleshooting-ssh) for more info on workarounds to SSH issues, or see the [new SSH Page](/terminal/warpify/ssh/) for more on the upcoming features. ### Online features don't work diff --git a/src/content/docs/support-and-community/troubleshooting-and-support/sending-us-feedback.mdx b/src/content/docs/support-and-community/troubleshooting-and-support/sending-us-feedback.mdx index 4550fba9..504e2c43 100644 --- a/src/content/docs/support-and-community/troubleshooting-and-support/sending-us-feedback.mdx +++ b/src/content/docs/support-and-community/troubleshooting-and-support/sending-us-feedback.mdx @@ -34,16 +34,16 @@ Whether you use the `/feedback` slash command or file an issue manually, a good * **What did you expect?** Describe the behavior you expected instead. * **How do we reproduce it?** List numbered steps when possible. If you can't reproduce the issue reliably, mention that too. * **What version of Warp are you on?** `/feedback` fills this in automatically; for manual reports, copy it from **Settings** > **Account**. -* **Logs, screenshots, or conversation IDs.** See [Gathering Warp Logs](#gathering-warp-logs), [Collecting crash reports on macOS](#collecting-crash-reports-on-macos), or [Gathering AI conversation ID](#gathering-ai-conversation-id) below. +* **Logs, screenshots, or conversation IDs.** See [Gathering Warp logs](#gathering-warp-logs), [Collecting crash reports on macOS](#collecting-crash-reports-on-macos), or [Gathering AI conversation ID](#gathering-ai-conversation-id) below. See the [Slash Commands reference](/agent-platform/capabilities/slash-commands/) for the full list of commands available in Warp. -## Gathering Warp Logs +## Gathering Warp logs Retrieve Warp's logs by following the instructions for your platform below. Locate the log file and attach it to your GitHub issue or email. :::note -Warp's logs and crash reports _**do not**_ contain any console input or output. See more on how we handle [Crash Reports and Telemetry](/support-and-community/privacy-and-security/privacy/#what-telemetry-data-are-you-collecting-and-why). +Warp's logs and crash reports _**do not**_ contain any console input or output. See more on how we handle [Crash Reports and Telemetry](/support-and-community/privacy-and-security/privacy/#what-telemetry-data-does-warp-collect-and-why). ::: diff --git a/src/content/docs/support-and-community/troubleshooting-and-support/troubleshooting-login-issues.mdx b/src/content/docs/support-and-community/troubleshooting-and-support/troubleshooting-login-issues.mdx index 063ef25c..20bda075 100644 --- a/src/content/docs/support-and-community/troubleshooting-and-support/troubleshooting-login-issues.mdx +++ b/src/content/docs/support-and-community/troubleshooting-and-support/troubleshooting-login-issues.mdx @@ -85,14 +85,14 @@ If you are still unable to authenticate, you may email [appeals@warp.dev](mailto If you have an active subscription and continue to have login issues, see [how to get help with login issues](/support-and-community/troubleshooting-and-support/troubleshooting-login-issues/#get-help-with-login-issues). -## How to get an Auth token to login +## How to get an auth token to login If the browser does not open from Warp directly when you click "Sign up" or "Sign in". Please go to the [Signup](https://app.warp.dev/signup) page to create an account or [Login](https://app.warp.dev/login) page if you already have one, then copy the auth token from the "here" link on the logged\_in page and paste it into Warp. If nothing happens when you click "Take me to Warp" on the logged-in page. If this happens to you, copy the "here" link on the web logged-in page (https://app.warp.dev/logged\_in) to copy the authentication token, then paste it into the app as shown below. :::caution -On Linux and Windows, the default copy-and-paste [Keyboard shortcuts](/getting-started/keyboard-shortcuts/) are `CTRL+SHIFT+C` and `CTRL+SHIFT+V` respectively.\ +On Linux and Windows, the default copy-and-paste [Keyboard shortcuts](/getting-started/keyboard-shortcuts/) are `Ctrl+Shift+C` and `Ctrl+Shift+V` respectively.\ \ On Linux and WSL you should install and set your default `$BROWSER` to `brave-browser` to workaround any copy-paste issues. Please see the workaround guide below. ::: diff --git a/src/content/docs/terminal/appearance/app-icons.mdx b/src/content/docs/terminal/appearance/app-icons.mdx index 2859a325..227a419e 100644 --- a/src/content/docs/terminal/appearance/app-icons.mdx +++ b/src/content/docs/terminal/appearance/app-icons.mdx @@ -30,7 +30,7 @@ App icons are only available for Warp on macOS. The feature doesn't support cust ## How to change the app icon * Navigate to **Settings** > **Appearance** > **Icon** > **Customize your app icon** -* Select the desired dock icon from the drop down menu +* Select the desired dock icon from the drop-down menu
![Icon customization drop-down menu](../../../../assets/terminal/custom-dock-icon-dropdown.png) diff --git a/src/content/docs/terminal/appearance/blocks-behavior.mdx b/src/content/docs/terminal/appearance/blocks-behavior.mdx index e10b3a4a..ac466130 100644 --- a/src/content/docs/terminal/appearance/blocks-behavior.mdx +++ b/src/content/docs/terminal/appearance/blocks-behavior.mdx @@ -8,11 +8,11 @@ sidebar: --- import DemoVideo from '@components/DemoVideo.astro'; -## Compact Mode +## Compact mode -Warp offers the option to enable Compact mode, which condenses the spacing between [Blocks](/terminal/blocks/), enabling more content to be in view. +Warp offers the option to enable Compact mode, which condenses the spacing between [Blocks](/terminal/blocks/), enabling more content to be in view. -### How to enable Compact Mode +### How to enable Compact mode Compact mode is disabled by default, but can be toggled in the following ways: @@ -25,7 +25,7 @@ Warp will open with the same compact settings in future sessions. -## Block Dividers +## Block dividers Warp [Blocks](/terminal/blocks/) are divided by horizontal lines that separate individual command input and output, they create a visual break between different commands that you run in a session. diff --git a/src/content/docs/terminal/appearance/custom-themes.mdx b/src/content/docs/terminal/appearance/custom-themes.mdx index 1b6beeb5..81bd4fad 100644 --- a/src/content/docs/terminal/appearance/custom-themes.mdx +++ b/src/content/docs/terminal/appearance/custom-themes.mdx @@ -1,7 +1,7 @@ --- title: Custom Themes description: >- - Warp supports Custom Themes which can be created manually or downloaded from + Warp supports custom themes, which can be created manually or downloaded from our repo. sidebar: label: "Custom themes" @@ -151,7 +151,7 @@ Browse Warp's [theme repository](https://github.com/warpdotdev/themes) for ready To add a background image you can use this attribute: `background_image:` with the name of the image you want to use as the background. :::note -Note: Warp currently only supports images with the _.jpg_ file format: +Warp currently only supports images with the _.jpg_ file format: * `.jpeg` * `.jpg` @@ -249,7 +249,7 @@ python3 ./scripts/gen_theme_previews.py standard ``` :::note -Note: We cannot accept pull requests that include custom background images because: +We cannot accept pull requests that include custom background images because: * Licensing restrictions * Trying to keep the binary size of the repo as small as possible (only the yaml files) diff --git a/src/content/docs/terminal/appearance/input-position.mdx b/src/content/docs/terminal/appearance/input-position.mdx index daee9321..d2006491 100644 --- a/src/content/docs/terminal/appearance/input-position.mdx +++ b/src/content/docs/terminal/appearance/input-position.mdx @@ -17,7 +17,7 @@ You can select from three different input positions, which each have different m * You can also choose and set modes from the [Command Palette](/terminal/command-palette/). :::note -Changes to the Input position take place immediately and apply to all open panes. +Changes to the input position take place immediately and apply to all open panes. ::: ### Related commands @@ -26,17 +26,17 @@ Changes to the Input position take place immediately and apply to all open panes * `CMD-K` will clear the entire list of input/output blocks for a clean view * `CTRL-L` will move the list of input/output blocks outside of the view and past the scroll so you have a clean view and the ability to easily visit past commands - * For long Blocks, you can press `SHIFT-CMD-UP`/`SHIFT-CMD-DOWN` to Scroll to the top/bottom the selected block. + * For long Blocks, you can press `SHIFT-CMD-UP`/`SHIFT-CMD-DOWN` to scroll to the top/bottom of the selected block. * `CTRL-SHIFT-K` will clear the entire list of input/output blocks for a clean view * `CTRL-L` will move the list of input/output blocks outside of the view and past the scroll so you have a clear view and the ability to easily visit past commands - * For long Blocks, you can press `CTRL-SHIFT-UP`/`CTRL-SHIFT-DOWN` to Scroll to the top/bottom of the selected block. + * For long Blocks, you can press `CTRL-SHIFT-UP`/`CTRL-SHIFT-DOWN` to scroll to the top/bottom of the selected block. * `CTRL-SHIFT-K` will clear the entire list of input/output blocks for a clean view * `CTRL-L` will move the list of input/output blocks outside of the view and past the scroll so you have a clear view and the ability to easily visit past commands - * For long Blocks, you can press `CTRL-SHIFT-UP`/`CTRL-SHIFT-DOWN` to Scroll to the top/bottom of the selected block. + * For long Blocks, you can press `CTRL-SHIFT-UP`/`CTRL-SHIFT-DOWN` to scroll to the top/bottom of the selected block. diff --git a/src/content/docs/terminal/appearance/pane-dimming.mdx b/src/content/docs/terminal/appearance/pane-dimming.mdx index 40907221..fafe8af3 100644 --- a/src/content/docs/terminal/appearance/pane-dimming.mdx +++ b/src/content/docs/terminal/appearance/pane-dimming.mdx @@ -18,7 +18,7 @@ The panes that aren't active will be dimmed to better indicate which pane is act * Toggle on **Dim inactive panes** to enable the feature. :::note -Split panes show a triangle indicator on the top left corner of the active pane. +Split panes show a triangle indicator on the top-left corner of the active pane. ::: ### Mouse focus diff --git a/src/content/docs/terminal/appearance/prompt.mdx b/src/content/docs/terminal/appearance/prompt.mdx index addcd1b9..d790297a 100644 --- a/src/content/docs/terminal/appearance/prompt.mdx +++ b/src/content/docs/terminal/appearance/prompt.mdx @@ -67,7 +67,7 @@ To enable same-line prompt: ## Shell prompt (PS1) -You can use a Shell prompt instead of the Warp prompt by configuring the **PS1** variable or installing a supported shell prompt plugin (see [Shell Prompt Compatibility Table](/terminal/appearance/prompt/#shell-prompt-compatibility-table)). +You can use a Shell prompt instead of the Warp prompt by configuring the **PS1** variable or installing a supported shell prompt plugin (see [Shell prompt compatibility table](/terminal/appearance/prompt/#shell-prompt-compatibility-table)). To enable the Shell prompt: @@ -147,7 +147,7 @@ If you're having issues with prompts, please see below or our [Known Issues](/su ### Starship -#### Starship Settings +#### Starship settings Some `~/.config/starship.toml` settings are known to cause errors in Warp. `#` or `DEL` the following lines to resolve known errors: @@ -197,7 +197,7 @@ Warp still doesn't fully support some p10k features like transient prompt and vi :::caution -Please note the Installing Powerlevel10k video mentions enabling a custom prompt in **Settings** > **Features** > **Honor users custom prompt (PS1)**, but it's now in **Settings** > **Appearance** > **Input** > **Classic** > **Current prompt** > **Shell Prompt (PS1)** . +Please note the Installing Powerlevel10k video mentions enabling a custom prompt in **Settings** > **Features** > **Honor users custom prompt (PS1)**, but it's now in **Settings** > **Appearance** > **Input** > **Classic** > **Current prompt** > **Shell Prompt (PS1)**. ::: ### Spaceship diff --git a/src/content/docs/terminal/appearance/size-opacity-blurring.mdx b/src/content/docs/terminal/appearance/size-opacity-blurring.mdx index 8d26b1fa..75e76176 100644 --- a/src/content/docs/terminal/appearance/size-opacity-blurring.mdx +++ b/src/content/docs/terminal/appearance/size-opacity-blurring.mdx @@ -11,23 +11,23 @@ import VideoEmbed from '@components/VideoEmbed.astro'; ## How to use it -### Window Size +### Window size To access size settings, go to **Settings** > **Appearance** > **Window**. -* Enable "Open new windows with custom size", Then configure your preferred columns and rows. +* Enable "Open new windows with custom size", then configure your preferred columns and rows. :::note If [Session Restoration](/terminal/sessions/session-restoration/) is enabled, Warp will restore the size of the last window closed when you quit the app. Either make sure the custom-sized window is the last one closed, or disable Session Restoration to ensure Warp launches with the custom-sized window. ::: -### Window Opacity +### Window opacity To access it, go to **Settings** > **Appearance** > **Window** * The slider supports setting the opacity value between `1` and `100` where `100` is completely opaque or solid. -### Window Blurring +### Window blurring After decreasing Opacity (moving the slider to a value less than `100`), you can also blur the background. @@ -59,6 +59,6 @@ At the moment, window opacity in Warp on Windows **does not work** in the follow Some graphics drivers and rendering backends may not support rendering transparent windows. -You can select the Vulkan or OpenGL graphics backend to render new Warp windows in the Settings menu, under `Features` > `System` > `Preferred graphics backend`. +You can select the Vulkan or OpenGL graphics backend to render new Warp windows in the Settings menu, under **Features** > **System** > **Preferred graphics backend**. -You can also opt to render new Warp windows with an integrated GPU, under `Features` > `System` > `Prefer rendering new windows with integrated GPU (low power)`. +You can also opt to render new Warp windows with an integrated GPU, under **Features** > **System** > **Prefer rendering new windows with integrated GPU (low power)**. diff --git a/src/content/docs/terminal/appearance/text-fonts-cursor.mdx b/src/content/docs/terminal/appearance/text-fonts-cursor.mdx index 02cdcfe8..1aafb2af 100644 --- a/src/content/docs/terminal/appearance/text-fonts-cursor.mdx +++ b/src/content/docs/terminal/appearance/text-fonts-cursor.mdx @@ -15,7 +15,7 @@ Once a new font is installed in your system, you need to restart Warp for it to ## How to use it -### Text and Fonts +### Text and fonts To access it, go to **Settings** > **Appearance** > **Text** @@ -29,7 +29,7 @@ From there you can customize: * The default setting prevents text from being blurry on low-DPI displays. :::caution -On Linux, Warp does not support the "Use thin stroke" feature. +On Linux, Warp does not support the "Use thin strokes" feature. ::: * Enforce minimum contrast @@ -37,7 +37,7 @@ On Linux, Warp does not support the "Use thin stroke" feature. * Show ligatures in terminal :::note -Enabling ligatures can reduce performance. Warps default font, Hack, doesn't yet have ligature support. We recommend font that supports ligatures (e.g. [Fira Code](https://github.com/tonsky/FiraCode)) as a stopgap. +Enabling ligatures can reduce performance. Warp's default font, Hack, doesn't yet have ligature support. We recommend a font that supports ligatures (e.g. [Fira Code](https://github.com/tonsky/FiraCode)) as a stopgap. ::: ### Cursor @@ -46,7 +46,7 @@ To access it, go to **Settings** > **Appearance** > **Cursor** From there you can customize: -* Select the Cursor type to Bar, Block, or Underline. +* Set the cursor type to Bar, Block, or Underline. * Toggle the Blinking cursor or from the [Command Palette](/terminal/command-palette/), type "Cursor blink" and toggle the setting. :::note diff --git a/src/content/docs/terminal/appearance/themes.mdx b/src/content/docs/terminal/appearance/themes.mdx index d4ae608e..78ef3885 100644 --- a/src/content/docs/terminal/appearance/themes.mdx +++ b/src/content/docs/terminal/appearance/themes.mdx @@ -31,9 +31,9 @@ import themePhenomenon from '../../../../assets/terminal/phenomenon.png'; import themeSolarFlare from '../../../../assets/terminal/solar-flare.png'; import themeAdeberry from '../../../../assets/terminal/adeberry.png'; -### Theme Picker +### Theme picker -The Theme Picker can be accessed by: +The theme picker can be accessed by: 1. Navigating to **Settings** > **Appearance**. 2. Clicking the Custom Themes (shaded) box. @@ -44,7 +44,7 @@ The Theme Picker can be accessed by: The Theme setting persists, meaning Warp will open with the same settings in the next session. ::: -### Theme Creator +### Theme creator Automatically create new themes based on a background image. @@ -53,7 +53,7 @@ Automatically create new themes based on a background image. 3. Upload the image and select the background color. 4. Click "Create Theme" to save and accept the new theme. -### OS Theme Sync +### OS theme sync Warp supports synchronizing your theme with the OS’s light and dark themes. To enable this: @@ -69,7 +69,7 @@ Warp supports synchronizing your theme with the OS’s light and dark themes. To -## Default Themes +## Default themes By default, Warp ships with these themes: diff --git a/src/content/docs/terminal/blocks/block-actions.mdx b/src/content/docs/terminal/blocks/block-actions.mdx index 31cd8bce..6d355d7a 100644 --- a/src/content/docs/terminal/blocks/block-actions.mdx +++ b/src/content/docs/terminal/blocks/block-actions.mdx @@ -22,13 +22,13 @@ There are 2 ways you can access Block actions. For command blocks, you can `RIGHT-CLICK` on a Block or click the context menu and copy the Block command, output, or both. -For AI blocks, you can `RIGHT-CLICK` to copy the prompt, output, both or the entire conversation. +For AI blocks, you can `RIGHT-CLICK` to copy the prompt, output, both, or the entire conversation. ## Sharing a block -Share a block easily with coworkers or teammates by creating a web permalink. This preserves formatting and makes debugging and sharing output easy. [See Block Sharing Page.](/terminal/blocks/block-sharing/) +Share a block easily with coworkers or teammates by creating a web permalink. This preserves formatting and makes debugging and sharing output easy. See the [Block sharing page](/terminal/blocks/block-sharing/). ## Bookmarking a block @@ -48,7 +48,7 @@ Quickly navigate to important Blocks despite where they are in the terminal hist * Pressing `OPTION-UP` and `OPTION-DOWN` - There are Ways to bookmark a Block: + Ways to bookmark a Block: 1. Select **Toggle bookmark** in the block context menu 2. Use `CTRL-SHIFT-B` keybinding to bookmark a selected block @@ -82,17 +82,17 @@ Bookmarks only persist while the session is open, once you close the session the ## Search within a block -Quickly find important information within a Block. [See Find page](/terminal/blocks/find/) +Quickly find important information within a Block. See the [Find page](/terminal/blocks/find/). With a Block selected, press "Find Within Block" or use `CMD-F` to search within a Block. - With a Block selected, Press "Find Within Block" or use `CTRL-SHIFT-F` to search within a Block. + With a Block selected, press "Find Within Block" or use `CTRL-SHIFT-F` to search within a Block. - With a Block selected, Press "Find Within Block" or use `CTRL-SHIFT-F` to search within a Block. + With a Block selected, press "Find Within Block" or use `CTRL-SHIFT-F` to search within a Block. @@ -100,7 +100,7 @@ Quickly find important information within a Block. [See Find page](/terminal/blo ## Filtering a block -Filter the output lines of a block natively in Warp to quickly focus on a subset of the block. [See Block Filtering Page](/terminal/blocks/block-filtering/). +Filter the output lines of a block natively in Warp to quickly focus on a subset of the block. See the [Block filtering page](/terminal/blocks/block-filtering/). diff --git a/src/content/docs/terminal/blocks/block-basics.mdx b/src/content/docs/terminal/blocks/block-basics.mdx index b27794e3..07a86d85 100644 --- a/src/content/docs/terminal/blocks/block-basics.mdx +++ b/src/content/docs/terminal/blocks/block-basics.mdx @@ -34,26 +34,26 @@ Type `xyz` (or some other command that doesn’t exist) and hit `ENTER` * Using your mouse: click on a Block. - * Or using your keyboard: hit `CMD-UP` (or `CMD-DOWN` if input as pinned up top) to select the most recently executed Block and use the `UP ↑` and `DOWN ↓` arrow keys to navigate to the desired Block. + * Or using your keyboard: hit `CMD-UP` (or `CMD-DOWN` if input is pinned up top) to select the most recently executed Block and use the `UP ↑` and `DOWN ↓` arrow keys to navigate to the desired Block. * For long Blocks: * You can click "Jump to the bottom of this block". - * You can press `SHIFT-CMD-UP`/`SHIFT-CMD-DOWN` to Scroll to the top/bottom of the selected block. + * You can press `SHIFT-CMD-UP`/`SHIFT-CMD-DOWN` to scroll to the top/bottom of the selected block. * From the [Command Palette](/terminal/command-palette/), you can also "Scroll to the top/bottom of selected block". - * Using your mouse: Click on a Block. - * Or using your keyboard: hit `CTRL-UP` (or `CTRL-DOWN` if input as pinned up top) to select the most recently executed Block and use the `UP ↑` and `DOWN ↓` arrow keys to navigate to the desired Block. + * Using your mouse: click on a Block. + * Or using your keyboard: hit `CTRL-UP` (or `CTRL-DOWN` if input is pinned up top) to select the most recently executed Block and use the `UP ↑` and `DOWN ↓` arrow keys to navigate to the desired Block. * For long Blocks: * You can click "Jump to the bottom of this block". - * You can press `CTRL-SHIFT-UP`/`CTRL-SHIFT-DOWN` to Scroll to the top/bottom of the selected block. + * You can press `CTRL-SHIFT-UP`/`CTRL-SHIFT-DOWN` to scroll to the top/bottom of the selected block. * From the [Command Palette](/terminal/command-palette/), you can also "Scroll to the top/bottom of selected block". - * Using your mouse: Click on a Block. - * Or using your keyboard: hit `CTRL-UP` (or `CTRL-DOWN` if input as pinned up top) to select the most recently executed Block and use the `UP ↑` and `DOWN ↓` arrow keys to navigate to the desired Block. + * Using your mouse: click on a Block. + * Or using your keyboard: hit `CTRL-UP` (or `CTRL-DOWN` if input is pinned up top) to select the most recently executed Block and use the `UP ↑` and `DOWN ↓` arrow keys to navigate to the desired Block. * For long Blocks: * You can click "Jump to the bottom of this block". - * You can press `CTRL-SHIFT-UP`/`CTRL-SHIFT-DOWN` to Scroll to the top/bottom of the selected block. + * You can press `CTRL-SHIFT-UP`/`CTRL-SHIFT-DOWN` to scroll to the top/bottom of the selected block. * From the [Command Palette](/terminal/command-palette/), you can also "Scroll to the top/bottom of selected block". @@ -65,17 +65,17 @@ Type `xyz` (or some other command that doesn’t exist) and hit `ENTER` * Click another Block while holding `CMD` to toggle the selection of that Block, or - * Click another Block while holding `SHIFT` to select a range of Block, or + * Click another Block while holding `SHIFT` to select a range of Blocks, or * Use `SHIFT-UP ↑` or `SHIFT-DOWN ↓` to expand the active selection (the Block with the thicker border) up or down, respectively. * Click another Block while holding `CTRL-SHIFT` to toggle the selection of that Block, or - * Click another Block while holding `SHIFT` to select a range of Block, or + * Click another Block while holding `SHIFT` to select a range of Blocks, or * Use `SHIFT-UP ↑` or `SHIFT-DOWN ↓` to expand the active selection (the Block with the thicker border) up or down, respectively. * Click another Block while holding `CTRL-SHIFT` to toggle the selection of that Block, or - * Click another Block while holding `SHIFT` to select a range of Block, or + * Click another Block while holding `SHIFT` to select a range of Blocks, or * Use `SHIFT-UP ↑` or `SHIFT-DOWN ↓` to expand the active selection (the Block with the thicker border) up or down, respectively. @@ -91,7 +91,7 @@ Type `xyz` (or some other command that doesn’t exist) and hit `ENTER` * **Page scrolling** - Press `PAGE UP` or `PAGE DOWN` to scroll by one page. * **Jump to top or bottom** - Press `HOME` or `END` to scroll to the top or bottom of terminal output. * **Scroll within a selected Block** - Press `SHIFT-CMD-UP` or `SHIFT-CMD-DOWN` to scroll to the top or bottom of the selected Block. - * **Scroll one line at a time** - "Scroll Terminal output up/down one line" can be configured with a keyboard shortcut in Settings > Keyboard shortcuts or accessed from the [Command Palette](/terminal/command-palette/). + * **Scroll one line at a time** - "Scroll Terminal output up/down one line" can be configured with a keyboard shortcut in **Settings** > **Keyboard shortcuts** or accessed from the [Command Palette](/terminal/command-palette/). * When the output of a command is cut off, Warp keeps the [Sticky Command Header](/terminal/blocks/sticky-command-header/) pinned at the top that displays the command the Block corresponds to. Clicking the header will scroll the screen to the start of the Block. @@ -100,7 +100,7 @@ Type `xyz` (or some other command that doesn’t exist) and hit `ENTER` * **Page scrolling** - Press `PAGE UP` or `PAGE DOWN` to scroll by one page. * **Jump to top or bottom** - Press `HOME` or `END` to scroll to the top or bottom of terminal output. * **Scroll within a selected Block** - Press `CTRL-SHIFT-UP` or `CTRL-SHIFT-DOWN` to scroll to the top or bottom of the selected Block. - * **Scroll one line at a time** - "Scroll Terminal output up/down one line" can be configured with a keyboard shortcut in Settings > Keyboard shortcuts or accessed from the [Command Palette](/terminal/command-palette/). + * **Scroll one line at a time** - "Scroll Terminal output up/down one line" can be configured with a keyboard shortcut in **Settings** > **Keyboard shortcuts** or accessed from the [Command Palette](/terminal/command-palette/). * When the output of a command is cut off, Warp keeps the [Sticky Command Header](/terminal/blocks/sticky-command-header/) pinned at the top that displays the command the Block corresponds to. Clicking the header will scroll the screen to the start of the Block. @@ -109,7 +109,7 @@ Type `xyz` (or some other command that doesn’t exist) and hit `ENTER` * **Page scrolling** - Press `PAGE UP` or `PAGE DOWN` to scroll by one page. * **Jump to top or bottom** - Press `HOME` or `END` to scroll to the top or bottom of terminal output. * **Scroll within a selected Block** - Press `CTRL-SHIFT-UP` or `CTRL-SHIFT-DOWN` to scroll to the top or bottom of the selected Block. - * **Scroll one line at a time** - "Scroll Terminal output up/down one line" can be configured with a keyboard shortcut in Settings > Keyboard shortcuts or accessed from the [Command Palette](/terminal/command-palette/). + * **Scroll one line at a time** - "Scroll Terminal output up/down one line" can be configured with a keyboard shortcut in **Settings** > **Keyboard shortcuts** or accessed from the [Command Palette](/terminal/command-palette/). * When the output of a command is cut off, Warp keeps the [Sticky Command Header](/terminal/blocks/sticky-command-header/) pinned at the top that displays the command the Block corresponds to. Clicking the header will scroll the screen to the start of the Block. diff --git a/src/content/docs/terminal/blocks/block-sharing.mdx b/src/content/docs/terminal/blocks/block-sharing.mdx index 48b488ff..ee3a3fa6 100644 --- a/src/content/docs/terminal/blocks/block-sharing.mdx +++ b/src/content/docs/terminal/blocks/block-sharing.mdx @@ -29,7 +29,7 @@ Share your blocks with a permalink or HTML embed. You can get started with share To share your blocks, follow these steps: - 1. On a finished block, click the context menu and select **Share...** or by setting up a key bind for Share Block in **Settings** > **Keyboard shortcuts**. + 1. On a finished block, click the context menu and select **Share...**, or set up a key bind for Share Block in **Settings** > **Keyboard shortcuts**. 2. A modal will pop up that lets you title your block and customize it by selecting which parts of the block you want to share (e.g. command, output, prompt, etc.). 3. Click either "Create link" or "Get embed" depending on how you want to share your block. 4. The link or embed snippet will be copied to your clipboard. @@ -37,7 +37,7 @@ Share your blocks with a permalink or HTML embed. You can get started with share To share your blocks, follow these steps: - 1. On a finished block, click the context menu and select **Share...** or by setting up a key bind for Share Block in **Settings** > **Keyboard shortcuts**. + 1. On a finished block, click the context menu and select **Share...**, or set up a key bind for Share Block in **Settings** > **Keyboard shortcuts**. 2. A modal will pop up that lets you title your block and customize it by selecting which parts of the block you want to share (e.g. command, output, prompt, etc.). 3. Click either "Create link" or "Get embed" depending on how you want to share your block. 4. The link or embed snippet will be copied to your clipboard. @@ -79,7 +79,7 @@ You can unshare a block by navigating to **Settings** > **Shared blocks**. Curre Shared permalinks will also display a preview of your code for quick context on each link. :::note -Compatible with any platform that supports Open Graph or Twitter meta tags. For example Slack, Twitter, Facebook, Telegram, Notion, and more ... +Compatible with any platform that supports Open Graph or Twitter meta tags. For example, Slack, Twitter, Facebook, Telegram, Notion, and more. ::: diff --git a/src/content/docs/terminal/blocks/find.mdx b/src/content/docs/terminal/blocks/find.mdx index e39f1813..501966c3 100644 --- a/src/content/docs/terminal/blocks/find.mdx +++ b/src/content/docs/terminal/blocks/find.mdx @@ -22,15 +22,15 @@ Since command outputs are contained within Blocks, you can still use the input e 1. Hitting `CMD-F` opens the find view which searches across the terminal (scoped within the current pane). - 2. Within the find modal, you can also enable the regex toggle, find on a selected Block, and or toggle case sensitive search. + 2. Within the find modal, you can also enable the regex toggle, find on a selected Block, and/or toggle case-sensitive search. 1. Hitting `CTRL-SHIFT-F` opens the find view which searches across the terminal (scoped within the current pane). - 2. Within the find modal, you can also enable the regex toggle, find on a selected Block, and or toggle case sensitive search. + 2. Within the find modal, you can also enable the regex toggle, find on a selected Block, and/or toggle case-sensitive search. 1. Hitting `CTRL-SHIFT-F` opens the find view which searches across the terminal (scoped within the current pane). - 2. Within the find modal, you can also enable the regex toggle, find on a selected Block, and or toggle case sensitive search. + 2. Within the find modal, you can also enable the regex toggle, find on a selected Block, and/or toggle case-sensitive search. diff --git a/src/content/docs/terminal/blocks/index.mdx b/src/content/docs/terminal/blocks/index.mdx index 34e55358..28857b37 100644 --- a/src/content/docs/terminal/blocks/index.mdx +++ b/src/content/docs/terminal/blocks/index.mdx @@ -19,7 +19,7 @@ Blocks enable us to easily: * Bookmark commands :::note -Interested in how we differentiate input and output, or how we implement blocks? Check out our blog post: [How Warp Works.](https://www.warp.dev/blog/how-warp-works#implementing-blocks) +Interested in how we differentiate input and output, or how we implement blocks? Check out our blog post: [How Warp Works](https://www.warp.dev/blog/how-warp-works#implementing-blocks). ::: diff --git a/src/content/docs/terminal/blocks/sticky-command-header.mdx b/src/content/docs/terminal/blocks/sticky-command-header.mdx index 001bbbe9..b98adf97 100644 --- a/src/content/docs/terminal/blocks/sticky-command-header.mdx +++ b/src/content/docs/terminal/blocks/sticky-command-header.mdx @@ -29,8 +29,8 @@ For long-running commands that take up the full screen, the sticky header only s * Sticky Command Header is enabled by default. * Toggle the Sticky Command Header by going to **Settings** > **Features** > **General** > toggle “Show sticky command header”. - * Toggle by searching for “Sticky Command Header” within the [Command Palette](/terminal/command-palette/) or by setting up a key bind in**Settings** > **Keyboard shortcuts**. - * You can also "Toggle Sticky Command Header in Active Pane" in the Command Palette or by setting up a key bind in**Settings** > **Keyboard shortcuts**. This won't disable the feature entirely, only minimize it on the active session. + * Toggle by searching for “Sticky Command Header” within the [Command Palette](/terminal/command-palette/) or by setting up a key bind in **Settings** > **Keyboard shortcuts**. + * You can also "Toggle Sticky Command Header in Active Pane" in the Command Palette or by setting up a key bind in **Settings** > **Keyboard shortcuts**. This won't disable the feature entirely, only minimize it on the active session. diff --git a/src/content/docs/terminal/command-completions/autosuggestions.mdx b/src/content/docs/terminal/command-completions/autosuggestions.mdx index d16c2e06..4e835a90 100644 --- a/src/content/docs/terminal/command-completions/autosuggestions.mdx +++ b/src/content/docs/terminal/command-completions/autosuggestions.mdx @@ -24,7 +24,7 @@ You can change the keybinding for accepting autosuggestions to `Tab`. Configure There are several ways to accept autosuggestions, either completely or partially: * Complete an autosuggestion using the `RIGHT` arrow or `CTRL-F`. - * `CTRL-E` also, completes the autosuggestion when your cursor is at the end of the buffer. + * `CTRL-E` also completes the autosuggestion when your cursor is at the end of the buffer. * `CTRL-RIGHT` can be used to partially complete the autosuggestion one component at a time. diff --git a/src/content/docs/terminal/command-completions/completions.mdx b/src/content/docs/terminal/command-completions/completions.mdx index 2fde8bc2..6cc68dad 100644 --- a/src/content/docs/terminal/command-completions/completions.mdx +++ b/src/content/docs/terminal/command-completions/completions.mdx @@ -14,7 +14,7 @@ Completions feature fuzzy search capability that provides you with [approximate * Type out the beginning of your command, then press `TAB`. * To search for options and flags, you must type and press `TAB`. -* Forgo `TAB` by enabling "Open completions menu as you type" in **Settings** > **Features** > **Terminal Input** +* Forgo `TAB` by enabling "Open completions menu as you type" in **Settings** > **Features** > **Terminal Input**. ## How to use it @@ -23,9 +23,9 @@ Completions feature fuzzy search capability that provides you with [approximate 1. Type `git checkout` (note the space) and then press `TAB` 2. A menu will show all of your local branches. You can select one using your mouse or the `UP ↑`/`DOWN ↓` arrow keys -### Completions on Aliases +### Completions on aliases -* Shell aliases - This is an alias for an entire command. For example, if you have `gc=git checkout` in alias, typing `gc` and hitting `TAB` should give you the same completion options as for `git checkout` . +* Shell aliases - This is an alias for an entire command. For example, if you have `gc=git checkout` in alias, typing `gc` and hitting `TAB` should give you the same completion options as for `git checkout`. * Command aliases - This is an alias for a subcommand. For example, this could be setting `git status` to `git st`. With completions support, we could now suggest completions for `git status` even if you typed in `git st`. :::note diff --git a/src/content/docs/terminal/command-palette.mdx b/src/content/docs/terminal/command-palette.mdx index 7dc3999d..546ac78d 100644 --- a/src/content/docs/terminal/command-palette.mdx +++ b/src/content/docs/terminal/command-palette.mdx @@ -11,7 +11,7 @@ The Command Palette is Warp's global search interface for quickly finding and la
![Command Palette Panel](../../../assets/terminal/command-palette-panel.png) -
Command Palette Panel.
+
The Command Palette panel.
## How to access it @@ -30,7 +30,7 @@ The Command Palette is Warp's global search interface for quickly finding and la ## How it works -* Start typing to search for workflows, notebooks, keyboard shortcuts, actions, toggles, etc. +* Start typing to search for Workflows, Notebooks, keyboard shortcuts, actions, toggles, etc. * Activate a specific filter, by clicking on the filter buttons or prepending your search with the following: * `workflows:` or `w:` will filter for [Workflows](/knowledge-and-collaboration/warp-drive/workflows/). * `prompts:` or `p:` will filter for [Prompts](/knowledge-and-collaboration/warp-drive/prompts/). diff --git a/src/content/docs/terminal/comparisons/performance.mdx b/src/content/docs/terminal/comparisons/performance.mdx index e04a4985..fc926fb0 100644 --- a/src/content/docs/terminal/comparisons/performance.mdx +++ b/src/content/docs/terminal/comparisons/performance.mdx @@ -8,8 +8,8 @@ description: >- We chose to benchmark Warp against 4 other terminal emulator applications, based on their popularity as well as language and principles. Here is the list of the applications we chose for this comparison together with the explanation as to why we decided to include it in our comparison: -* Terminal.app - the default terminal app available on the macOS; -* ITerm2 - one of the most popular terminal emulators used by macOS users; +* Terminal.app - the default terminal app available on macOS; +* iTerm2 - one of the most popular terminal emulators used by macOS users; * Alacritty & WezTerm - both of those terminals are written in Rust and are well-known for their speed and overall performance, things that Warp is aiming for. ### Versions & settings used during the comparison @@ -20,7 +20,7 @@ We chose to benchmark Warp against 4 other terminal emulator applications, based | Terminal.app | Version 2.11 (440) | 188 cols / 72 rows | | iTerm2 | Build 3.4.15 | 211 cols / 78 rows | | Alacritty | alacritty 0.10.1 (2844606) | 286 cols / 102 rows | -| Wezterm | 20220319-142410-0fcdea07 | 243 cols / 80 rows | +| WezTerm | 20220319-142410-0fcdea07 | 243 cols / 80 rows | ### About benchmarks diff --git a/src/content/docs/terminal/comparisons/terminal-features.mdx b/src/content/docs/terminal/comparisons/terminal-features.mdx index de18bfec..18ef8de8 100644 --- a/src/content/docs/terminal/comparisons/terminal-features.mdx +++ b/src/content/docs/terminal/comparisons/terminal-features.mdx @@ -8,7 +8,7 @@ description: >- To make it more transparent & useful, we also show the results for 4 other popular macOS terminal emulators. -| Feature | Warp | Terminal.app | Iterm | Alacritty | Wezterm | +| Feature | Warp | Terminal.app | iTerm | Alacritty | WezTerm | | --------------------------------------------------------- | ---- | ------------ | ----- | --------- | ------- | | 24-bit (true color) | YES | NO | YES | YES | YES | | Bold | YES | YES | YES | YES | YES | diff --git a/src/content/docs/terminal/editor/alias-expansion.mdx b/src/content/docs/terminal/editor/alias-expansion.mdx index cd03ca30..5fcd6f56 100644 --- a/src/content/docs/terminal/editor/alias-expansion.mdx +++ b/src/content/docs/terminal/editor/alias-expansion.mdx @@ -12,17 +12,17 @@ import VideoEmbed from '@components/VideoEmbed.astro'; - When Alias Expansion is enabled, type an alias and then hit `SPACE` will expand the alias. + When alias expansion is enabled, type an alias and then hit `SPACE` to expand the alias. To insert a space without expanding an alias, the default keybinding is `OPT-SPACE`. - When Alias Expansion is enabled, type an alias and then hit `SPACE` will expand the alias. + When alias expansion is enabled, type an alias and then hit `SPACE` to expand the alias. To insert a space without expanding an alias, the default keybinding is `ALT-SPACE`. - When Alias Expansion is enabled, type an alias and then hit `SPACE` will expand the alias. + When alias expansion is enabled, type an alias and then hit `SPACE` to expand the alias. To insert a space without expanding an alias, the default keybinding is `ALT-SPACE`. diff --git a/src/content/docs/terminal/editor/index.mdx b/src/content/docs/terminal/editor/index.mdx index 07d7dd78..bcf51878 100644 --- a/src/content/docs/terminal/editor/index.mdx +++ b/src/content/docs/terminal/editor/index.mdx @@ -13,37 +13,37 @@ Warp's input editor works like a modern IDE text editor, with cursor movement, c Text Editor Input also works for [SSH sessions](/terminal/warpify/ssh/). ::: -### Soft Wrapping +### Soft wrapping Warp supports soft wrapping in the input editor. If an autosuggestion goes off-screen, the input editor will be horizontally scrollable to make it visible. Some operations treat soft-wrapped lines like a logical line (`TRIPLE-CLICK`) while other operations treat soft wrapped lines like visible different lines (`UP`/`DOWN`, `SHIFT-UP`/`SHIFT-DOWN`). -### Copy on Select +### Copy on select Warp supports copy on select for selectable text within [Blocks](/terminal/blocks/). -* Toggle this feature **Settings** > **Features** > **Terminal** or search for "Copy on select" in the [Command Palette](/terminal/command-palette/). +* Toggle this feature in **Settings** > **Features** > **Terminal** or search for "Copy on select" in the [Command Palette](/terminal/command-palette/). ### Autocomplete quotes, parentheses, and brackets Warp can automatically complete quotes, brackets, and parentheses like you're used to in IDEs. -* Toggle this feature **Settings** > **Features** > **Text Editing** or search for "Autocomplete quotes" in the [Command Palette](/terminal/command-palette/). +* Toggle this feature in **Settings** > **Features** > **Text Editing** or search for "Autocomplete quotes" in the [Command Palette](/terminal/command-palette/). ## How to use it -
Keyboard bindingShortcut description
ESCAPECloses the input suggestions or history menu
CTRL-LClears the terminal
CTRL-HBackspace
CTRL-CClear the entire editor buffer
CTRL-UCopy and Clear the current line
CMD-SHIFT-KClear selected lines
CMD-C, CMD-X, CMD-VCopy, cut, paste
CTRL-W / OPT-DCut the word to the left / right of the cursor
OPT-BACKSPACE / OPT-DDelete the word to the left / right of the cursor
CTRL-K CMD-DELETEDelete everything to the right of the cursor
OPT-LEFT / OPT-RIGHTMove to the beginning of the previous / next word
CTRL-OPT-LEFT / CTRL-OPT-RIGHTMove backward / forward by one subword
CMD-LEFT CTRL-A/ CTRL-E CMD-DOWN CMD-RIGHTMove the cursor to the start / end of the line
SHIFT-LEFT / SHIFT-RIGHTSelect the character to the left / right of the cursor
OPT-SHIFT-LEFT / OPT-SHIFT-RIGHTSelect the word to the left / right of the cursor
CMD-SHIFT-LEFT / CMD-SHIFT-RIGHTSelect everything to the left / right of the cursor
SHIFT-UP / SHIFT-UPSelect everything above / below the cursor
CMD-ASelect the entire editor buffer
SHIFT-ENTER CTRL-ENTER OPT-ENTERInsert newline
CTRL-RCommand Search
CMD-DSplit pane
+
Keyboard bindingShortcut description
ESCAPECloses the input suggestions or history menu
CTRL-LClears the terminal
CTRL-HBackspace
CTRL-CClear the entire editor buffer
CTRL-UCopy and Clear the current line
CMD-SHIFT-KClear selected lines
CMD-C, CMD-X, CMD-VCopy, cut, paste
CTRL-W / OPT-DCut the word to the left / right of the cursor
OPT-BACKSPACE / OPT-DDelete the word to the left / right of the cursor
CTRL-K CMD-DELETEDelete everything to the right of the cursor
OPT-LEFT / OPT-RIGHTMove to the beginning of the previous / next word
CTRL-OPT-LEFT / CTRL-OPT-RIGHTMove backward / forward by one subword
CMD-LEFT CTRL-A/ CTRL-E CMD-DOWN CMD-RIGHTMove the cursor to the start / end of the line
SHIFT-LEFT / SHIFT-RIGHTSelect the character to the left / right of the cursor
OPT-SHIFT-LEFT / OPT-SHIFT-RIGHTSelect the word to the left / right of the cursor
CMD-SHIFT-LEFT / CMD-SHIFT-RIGHTSelect everything to the left / right of the cursor
SHIFT-UP / SHIFT-DOWNSelect everything above / below the cursor
CMD-ASelect the entire editor buffer
SHIFT-ENTER CTRL-ENTER OPT-ENTERInsert newline
CTRL-RCommand Search
CMD-DSplit pane
 -
Keyboard bindingShortcut description
ESCAPECloses the input suggestions or history menu
CTRL-LClears the terminal
CTRL-HBackspace
CTRL-CClear the entire editor buffer
CTRL-UCopy and Clear the current line
CTRL-SHIFT-KClear selected lines
CTRL-C, CTRL-X, CTRL-VCopy, cut, paste
CTRL-W / ALT-DCut the word to the left / right of the cursor
ALT-BACKSPACE / ALT-DDelete the word to the left / right of the cursor
CTRL-KDelete everything to the right of the cursor
ALT-LEFT / ALT-RIGHTMove to the beginning of the previous / next word
CTRL-LEFT / CTRL-RIGHTMove backward / forward by one subword
CTRL-A/ CTRL-EMove the cursor to the start / end of the line
Select the character to the left / right of the cursor
META-SHIFT-B / META-SHIFT-FSelect the word to the left / right of the cursor
Select everything to the left / right of the cursor
SHIFT-UP / SHIFT-UPSelect everything above / below the cursor
CTRL-ASelect the entire editor buffer
SHIFT-ENTER CTRL-ENTER ALT-ENTERInsert newline
CTRL-RCommand Search
CTRL-SHIFT-DSplit pane
+
Keyboard bindingShortcut description
ESCAPECloses the input suggestions or history menu
CTRL-LClears the terminal
CTRL-HBackspace
CTRL-CClear the entire editor buffer
CTRL-UCopy and Clear the current line
CTRL-SHIFT-KClear selected lines
CTRL-C, CTRL-X, CTRL-VCopy, cut, paste
CTRL-W / ALT-DCut the word to the left / right of the cursor
ALT-BACKSPACE / ALT-DDelete the word to the left / right of the cursor
CTRL-KDelete everything to the right of the cursor
ALT-LEFT / ALT-RIGHTMove to the beginning of the previous / next word
CTRL-LEFT / CTRL-RIGHTMove backward / forward by one subword
CTRL-A/ CTRL-EMove the cursor to the start / end of the line
Select the character to the left / right of the cursor
META-SHIFT-B / META-SHIFT-FSelect the word to the left / right of the cursor
Select everything to the left / right of the cursor
SHIFT-UP / SHIFT-DOWNSelect everything above / below the cursor
CTRL-ASelect the entire editor buffer
SHIFT-ENTER CTRL-ENTER ALT-ENTERInsert newline
CTRL-RCommand Search
CTRL-SHIFT-DSplit pane
 -
Keyboard bindingShortcut description
ESCAPECloses the input suggestions or history menu
CTRL-LClears the terminal
CTRL-HBackspace
CTRL-CClear the entire editor buffer
CTRL-UCopy and Clear the current line
CTRL-SHIFT-KClear selected lines
CTRL-C, CTRL-X, CTRL-VCopy, cut, paste
CTRL-W / ALT-DCut the word to the left / right of the cursor
ALT-BACKSPACE / ALT-DDelete the word to the left / right of the cursor
CTRL-KDelete everything to the right of the cursor
ALT-LEFT / ALT-RIGHTMove to the beginning of the previous / next word
CTRL-LEFT / CTRL-RIGHTMove backward / forward by one subword
CTRL-A/ CTRL-EMove the cursor to the start / end of the line
Select the character to the left / right of the cursor
META-SHIFT-B / META-SHIFT-FSelect the word to the left / right of the cursor
Select everything to the left / right of the cursor
SHIFT-UP / SHIFT-UPSelect everything above / below the cursor
CTRL-ASelect the entire editor buffer
SHIFT-ENTER CTRL-ENTER ALT-ENTERInsert newline
CTRL-RCommand Search
CTRL-SHIFT-DSplit pane
+
Keyboard bindingShortcut description
ESCAPECloses the input suggestions or history menu
CTRL-LClears the terminal
CTRL-HBackspace
CTRL-CClear the entire editor buffer
CTRL-UCopy and Clear the current line
CTRL-SHIFT-KClear selected lines
CTRL-C, CTRL-X, CTRL-VCopy, cut, paste
CTRL-W / ALT-DCut the word to the left / right of the cursor
ALT-BACKSPACE / ALT-DDelete the word to the left / right of the cursor
CTRL-KDelete everything to the right of the cursor
ALT-LEFT / ALT-RIGHTMove to the beginning of the previous / next word
CTRL-LEFT / CTRL-RIGHTMove backward / forward by one subword
CTRL-A/ CTRL-EMove the cursor to the start / end of the line
Select the character to the left / right of the cursor
META-SHIFT-B / META-SHIFT-FSelect the word to the left / right of the cursor
Select everything to the left / right of the cursor
SHIFT-UP / SHIFT-DOWNSelect everything above / below the cursor
CTRL-ASelect the entire editor buffer
SHIFT-ENTER CTRL-ENTER ALT-ENTERInsert newline
CTRL-RCommand Search
CTRL-SHIFT-DSplit pane
 -## How it Works +## How it works diff --git a/src/content/docs/terminal/editor/syntax-error-highlighting.mdx b/src/content/docs/terminal/editor/syntax-error-highlighting.mdx index 039f6a0d..09eba088 100644 --- a/src/content/docs/terminal/editor/syntax-error-highlighting.mdx +++ b/src/content/docs/terminal/editor/syntax-error-highlighting.mdx @@ -10,7 +10,7 @@ import VideoEmbed from '@components/VideoEmbed.astro'; ## What is syntax highlighting -Warp supports Syntax Highlighting in the [Input Editor.](/terminal/editor/) It colors each part of a command to help differentiate between sub-commands, options/flags, arguments, and variables. +Warp supports syntax highlighting in the [Input Editor](/terminal/editor/). It colors each part of a command to help differentiate between sub-commands, options/flags, arguments, and variables. :::caution Newly installed apps or newly created aliases will not trigger syntax highlighting until you open a new Warp session (new window, tab, or pane), even if you `source` the RC files in the current session. @@ -18,14 +18,14 @@ Newly installed apps or newly created aliases will not trigger syntax highlighti ### How to access syntax highlighting -When Syntax Highlighting is enabled, Warp's [Input Editor](/terminal/editor/) automatically recognizes each part of the command as you type it into the Input Editor, and syntactically highlight them. +When syntax highlighting is enabled, Warp's [Input Editor](/terminal/editor/) automatically recognizes each part of the command as you type it into the Input Editor, and syntactically highlights them. ### How to enable/disable syntax highlighting Syntax highlighting is enabled by default, to toggle it: * Through the [Command Palette](/terminal/command-palette/), search for the "Syntax Highlighting" option and click it (or press enter) to enable/disable. -* Through **Settings** > **Features** > **Terminal Input** , toggle "Syntax highlighting for commands" +* Through **Settings** > **Features** > **Terminal Input**, toggle "Syntax highlighting for commands". ### How syntax highlighting works @@ -41,14 +41,14 @@ Newly installed apps or newly created aliases will trigger error underlining unt ### How to access error underlining -When Error Underlining is enabled, Warp automatically underlines any invalid commands with a dashed red underline. +When error underlining is enabled, Warp automatically underlines any invalid commands with a dashed red underline. ### How to enable/disable error underlining Error underlining is enabled by default, to toggle it: * Through the [Command Palette](/terminal/command-palette/), search for the "Syntax Highlighting" option and click it (or press enter) to enable/disable. -* Through **Settings** > **Features** > **Terminal Input** , toggle "Error underlining for commands" +* Through **Settings** > **Features** > **Terminal Input**, toggle "Error underlining for commands". ### How error underlining works diff --git a/src/content/docs/terminal/editor/vim.mdx b/src/content/docs/terminal/editor/vim.mdx index 5b196f3e..66d7541a 100644 --- a/src/content/docs/terminal/editor/vim.mdx +++ b/src/content/docs/terminal/editor/vim.mdx @@ -9,7 +9,7 @@ sidebar: ## About Vim keybindings -The Vi family of programs (including Vim and Neovim) are modal text editors that allow for keyboard-driven text editing. Several shells, including `bash` and `zsh`, implement vi-style keybindings. Warp's input editor was built natively to support more modern text editing experiences, which means it replaces the shell's editor capabilities. Warp has its implementation of Vim keybindings (also known as Vim mode) you can use. +The Vi family of programs (including Vim and Neovim) are modal text editors that allow for keyboard-driven text editing. Several shells, including `bash` and `zsh`, implement vi-style keybindings. Warp's input editor was built natively to support more modern text editing experiences, which means it replaces the shell's editor capabilities. Warp has its own implementation of Vim keybindings (also known as Vim mode) you can use. ### How to enable Vim keybindings @@ -24,13 +24,13 @@ To manually toggle Vim keybindings in Warp's input editor: As in `bash` and `zsh`'s vi mode implementations, the editor starts in insert mode. Pressing `CTRL-C` or `ENTER` clears any pending command state. -### Customizing Keybindings +### Customizing keybindings At the moment, Warp only supports default Vim keybindings. -One exception is the keyboard shortcut for exiting insert mode, which can be rebound under**Settings** > **Keyboard shortcuts** > **Exit Vim Insert Mode**, or through the [Command Palette](/terminal/command-palette/) search for "Exit Vim Insert Mode". +One exception is the keyboard shortcut for exiting insert mode, which can be rebound under **Settings** > **Keyboard shortcuts** > **Exit Vim Insert Mode**, or through the [Command Palette](/terminal/command-palette/) search for "Exit Vim Insert Mode". -## Supported Keybindings +## Supported keybindings Below is a list of the vim functionality implemented in Warp so far. @@ -81,7 +81,7 @@ See [Vim docs: motion](https://vimdoc.sourceforge.net/htmldoc/motion.html) for m See [Vim docs: editing](https://vimdoc.sourceforge.net/htmldoc/editing.html) for more information. -#### Text Objects +#### Text objects | Command(s) | Description | | ---------------- | ------------------------------------------ | @@ -95,7 +95,7 @@ See [Vim docs: text objects](https://vimdoc.sourceforge.net/htmldoc/motion.html# ### Search -#### Character Search +#### Character search | Command(s) | Description | | ------------------ | ------------------------------------------------------ | @@ -105,7 +105,7 @@ See [Vim docs: text objects](https://vimdoc.sourceforge.net/htmldoc/motion.html# See [Vim docs: left-right motions](https://vimdoc.sourceforge.net/htmldoc/motion.html#f) for more information. -#### General Search +#### General search Unlike Vim, general search commands don't search within the buffer. Instead, they open Warp's native command search. @@ -113,7 +113,7 @@ Unlike Vim, general search commands don't search within the buffer. Instead, the | ------------------ | ------------------------ | | `/`, `?`, `*`, `#` | open Warp command search | -### Mode Switching +### Mode switching | Command(s) | Description | | ---------- | ----------------------------------------------------------------- | @@ -147,4 +147,4 @@ See [Vim docs: registers](https://vimdoc.sourceforge.net/htmldoc/change.html#reg ## Feedback -The best way to report bugs and request features is through Warp's [GitHub Issues](https://github.com/warpdotdev/Warp/issues) page. Please note that the issue or request is for Vim Keybindings. +The best way to report bugs and request features is through Warp's [GitHub Issues](https://github.com/warpdotdev/Warp/issues) page. Please note that the issue or request is for Vim keybindings. diff --git a/src/content/docs/terminal/entry/command-corrections.mdx b/src/content/docs/terminal/entry/command-corrections.mdx index 7c98538a..d1a8aac0 100644 --- a/src/content/docs/terminal/entry/command-corrections.mdx +++ b/src/content/docs/terminal/entry/command-corrections.mdx @@ -10,13 +10,13 @@ import VideoEmbed from '@components/VideoEmbed.astro'; ## What is it -This feature was built on top of the open-source project [nvdn/thefuck](https://github.com/nvbn/thefuck). Here are some examples that the Warp team usually finds Command Corrections useful for: +This feature was built on top of the open-source project [nvbn/thefuck](https://github.com/nvbn/thefuck). Here are some examples that the Warp team usually finds Command Corrections useful for: * Misspelled commands * `gti checkout myBranchName` -> `git checkout myBranchName` * `cd ap/sorce/executtor` -> `cd app/source/executor` * Missing flags - * `git push` -> `git push –set-upstream myBranchName` + * `git push` -> `git push --set-upstream myBranchName` * Add permissions * `./script` -> `chmod +x ./script && ./script` @@ -29,7 +29,7 @@ This feature was built on top of the open-source project [nvdn/thefuck](https:// -#### Command correction rules: +#### Command correction rules | Command | | ------------------------------------------------------------- | diff --git a/src/content/docs/terminal/entry/command-search.mdx b/src/content/docs/terminal/entry/command-search.mdx index 5d340fc9..a7b066c8 100644 --- a/src/content/docs/terminal/entry/command-search.mdx +++ b/src/content/docs/terminal/entry/command-search.mdx @@ -22,7 +22,7 @@ Tailor your Command Search experience by toggling off "Show Global Workflows" in 2. Type your search query in the input box 3. Press `ENTER` to input the selected command into Warp's Input Editor -## Search Filters +## Search filters You can filter your search results by prepending your search term with any of the following: @@ -32,7 +32,7 @@ You can filter your search results by prepending your search term with any of th When a filter is activated, it will be bolded and italicized in the search panel. ::: -## Additional Features +## Additional features * You can expand the menu horizontally by dragging the right edge * The panel supports fuzzy search and ranks results by relevance diff --git a/src/content/docs/terminal/entry/index.mdx b/src/content/docs/terminal/entry/index.mdx index 28de538d..6fe32969 100644 --- a/src/content/docs/terminal/entry/index.mdx +++ b/src/content/docs/terminal/entry/index.mdx @@ -2,12 +2,12 @@ title: Command entry overview description: >- Warp's main features for Command Entry, History, Synchronized Inputs, YAML - Workflows and More! + Workflows, and more. --- import DemoVideo from '@components/DemoVideo.astro'; import VideoEmbed from '@components/VideoEmbed.astro'; -1. [Command Corrections](/terminal/entry/command-corrections/) provides auto-correct suggestions on previously run commands to catch typos, and forgotten flags, and fix general console errors. +1. [Command Corrections](/terminal/entry/command-corrections/) provides auto-correct suggestions on previously run commands to catch typos and forgotten flags, and fix general console errors. 2. [Command Search](/terminal/entry/command-search/) is a 3-in-1 panel that allows you to search across Command History, Workflows, Notebooks, and AI Command Search all at once. 3. [Command History](/terminal/entry/command-history/) allows Warp to isolate the history of each shell session to make previously run commands easily accessible. 4. [Synchronized Inputs](/terminal/entry/synchronized-inputs/) allow you to easily run the same command in multiple sessions at the same time. diff --git a/src/content/docs/terminal/entry/synchronized-inputs.mdx b/src/content/docs/terminal/entry/synchronized-inputs.mdx index ee2c3da6..a4175728 100644 --- a/src/content/docs/terminal/entry/synchronized-inputs.mdx +++ b/src/content/docs/terminal/entry/synchronized-inputs.mdx @@ -15,10 +15,10 @@ With Warp’s synchronized inputs, whatever command you enter in one session wil ## How to access it -There are three ways to access controls to synchronize inputs: +There are two ways to access controls to synchronize inputs: * [Command Palette](/terminal/command-palette/) in Warp: Search for “synchronize” -* macOS menus for the Warp app: `Edit > Synchronize Input` +* macOS menus for the Warp app: **Edit** > **Synchronize Input** ## How to use it diff --git a/src/content/docs/terminal/entry/yaml-workflows.mdx b/src/content/docs/terminal/entry/yaml-workflows.mdx index 8b545e48..ab967c34 100644 --- a/src/content/docs/terminal/entry/yaml-workflows.mdx +++ b/src/content/docs/terminal/entry/yaml-workflows.mdx @@ -8,7 +8,7 @@ sidebar: import DemoVideo from '@components/DemoVideo.astro'; import { Tabs, TabItem } from '@astrojs/starlight/components'; -:::danger +:::caution You can continue to use YAML-based workflows, but we recommend using new [workflows in Warp Drive](/knowledge-and-collaboration/warp-drive/workflows/) instead for a better editing experience. ::: @@ -73,7 +73,7 @@ See the existing Workflow spec within the [Workflows repo](https://github.com/wa Workflow File Format -The Workflow file format is a [yaml](https://yaml.org/) file and must have either a \`.yml \` or \`yaml\` extension. If you're new to YAML and want to learn more, see [Learn YAML in Y minutes](https://learnxinyminutes.com/docs/yaml/). +The Workflow file format is a [yaml](https://yaml.org/) file and must have either a `.yml` or `.yaml` extension. If you're new to YAML and want to learn more, see [Learn YAML in Y minutes](https://learnxinyminutes.com/docs/yaml/). --- diff --git a/src/content/docs/terminal/input/classic-input.mdx b/src/content/docs/terminal/input/classic-input.mdx index 9d36dad1..5da4f800 100644 --- a/src/content/docs/terminal/input/classic-input.mdx +++ b/src/content/docs/terminal/input/classic-input.mdx @@ -76,7 +76,7 @@ The first time you enter Agent Mode, you will be served a banner with the option Warp input occasionally shows hints within the input editor in a light grey text that helps users learn about features. It's enabled by default. -* Toggle this feature **Settings** > **Agents** > **Warp Agent** > **Show input hint text** or search for "Input hint text" in the [Command Palette](/terminal/command-palette/) or Right-click on the input editor. +* Toggle this feature in **Settings** > **Agents** > **Warp Agent** > **Show input hint text** or search for "Input hint text" in the [Command Palette](/terminal/command-palette/) or right-click on the input editor. ## How to exit Agent Mode diff --git a/src/content/docs/terminal/input/universal-input.mdx b/src/content/docs/terminal/input/universal-input.mdx index e715d770..5cdb6075 100644 --- a/src/content/docs/terminal/input/universal-input.mdx +++ b/src/content/docs/terminal/input/universal-input.mdx @@ -10,7 +10,7 @@ import { Tabs, TabItem } from '@astrojs/starlight/components'; import VideoEmbed from '@components/VideoEmbed.astro'; :::caution -**This is legacy documentation.** Universal Input has been replaced by [Agent Modality](/agent-platform/local-agents/interacting-with-agents/terminal-and-agent-modes/), which provides a cleaner terminal experience with a dedicated conversation view for agent interactions. +**This is legacy documentation.** Universal Input has been replaced by [Terminal and Agent modes](/agent-platform/local-agents/interacting-with-agents/terminal-and-agent-modes/), which provides a cleaner terminal experience with a dedicated conversation view for agent interactions. ::: The **Universal Input** was the main input interface for using Warp. @@ -33,7 +33,7 @@ The Universal Input brings together all of Warp's input features into one stream If you prefer a more traditional terminal input experience, you can switch to [Classic Input](/terminal/input/classic-input/) in **Settings** > **Appearance** > **Input**. Classic input also supports oh-my-posh, PS1 customizations, and [same line prompt.](/terminal/appearance/prompt/#same-line-prompt) -## Input Modes +## Input modes The Universal Input supports three modes, shown in the input switcher: @@ -86,7 +86,7 @@ When Warp detects an input type, the input switcher softly highlights the corres The model Warp uses to detect natural language automatically is completely local. ::: -#### Disabling Natural Language Auto-detection +#### Disabling natural language auto-detection By default, auto-detection is enabled. This means Warp decides whether to treat your input as a command or an Agent prompt. @@ -139,7 +139,7 @@ By default, auto-detection is enabled. This means Warp decides whether to treat -When you're in Agent Mode, the **Agent icon** will be highlighted in the [Universal Input(/terminal/input/universal-input/) +When you're in Agent Mode, the **Agent icon** will be highlighted in the [Universal Input](/terminal/input/universal-input/).
![The Agent icon in the Universal input indicates that Agent Mode is active.](../../../../assets/terminal/using-agents-universal-input.png) @@ -189,7 +189,7 @@ You can leave Agent or Terminal Modes in several ways: -### Natural Language Auto-detection Settings +### Natural language auto-detection settings Warp can automatically detect when you’re writing in plain English and switch you into Agent Mode. If needed, you can customize or disable this behavior. @@ -214,7 +214,7 @@ The first time you enter Agent Mode, Warp will display a banner with the option --- -## Contextual Input Chips +## Contextual input chips
![Universal Input's contextual input chips, from left to right: conversation management, node version, active directory, Git and code diffs, and 2 attached images.](../../../../assets/terminal/universal-input.png) diff --git a/src/content/docs/terminal/integrations-and-plugins.mdx b/src/content/docs/terminal/integrations-and-plugins.mdx index 1f77434e..56863f52 100644 --- a/src/content/docs/terminal/integrations-and-plugins.mdx +++ b/src/content/docs/terminal/integrations-and-plugins.mdx @@ -18,7 +18,7 @@ Currently, the Docker extension is only available on macOS. [Warp’s Docker extension](https://hub.docker.com/extensions/warpdotdev/warp) makes it more convenient to open Docker containers in Warp. With the extension, you can click to open any Docker container in a [Warpified subshell](/terminal/warpify/subshells/), without manually running `docker exec` or typing out lengthy container IDs. -Select a container from the list and specify a shell type. Note, that only `bash|zsh|fish` are supported shells for docker containers. Then, select a user (optional) and finally click “Open in Warp” to run commands within the Docker container. +Select a container from the list and specify a shell type. Note that only `bash|zsh|fish` are supported shells for Docker containers. Then, select a user (optional) and finally click “Open in Warp” to run commands within the Docker container.
![Warp's extension for Docker lists available containers](../../../assets/terminal/docker-extension.png) @@ -81,14 +81,14 @@ Currently, the JetBrains IDE configuration is only available on macOS. Press a keyboard shortcut of choice while in a JetBrains IDE to open a new session in Warp. -To configure this, use the Apple Menu. Click on **Preferences**, go to `External Tools` , and click **Add**. In this menu, put the following information: +To configure this, use the Apple Menu. Click on **Preferences**, go to **External Tools**, and click **Add**. In this menu, put the following information: * _Name_: Open Warp * _Program_: `/Applications/Warp.app` * _Arguments_: `$ProjectFileDir$` * _Working Directory_: `/Applications` -Then press `Ok`. Now you will be able to `Open Warp` from the Apple Menu under `Tools` -> `External Tools`. +Then press **OK**. Now you will be able to `Open Warp` from the Apple Menu under `Tools` -> `External Tools`. diff --git a/src/content/docs/terminal/more-features/accessibility.mdx b/src/content/docs/terminal/more-features/accessibility.mdx index 39640738..6521ee86 100644 --- a/src/content/docs/terminal/more-features/accessibility.mdx +++ b/src/content/docs/terminal/more-features/accessibility.mdx @@ -6,14 +6,14 @@ description: >- --- :::note -Note that currently, these instructions are for macOS only. Warp doesn't support screen readers on Linux or Windows. We're tracking screen reader support in [GitHub issue #3847](https://github.com/warpdotdev/Warp/issues/3847). +Currently, these instructions are for macOS only. Warp doesn't support screen readers on Linux or Windows. We're tracking screen reader support in [GitHub issue #3847](https://github.com/warpdotdev/Warp/issues/3847). ::: We recognize the need to improve the experience for those visually impaired, as - to our best knowledge - other terminal emulator apps didn't do a good job in this area. This doc summarizes what we've done so far, how Warp works with VoiceOver, and outlines the main changes from the typical workflow. For the features documentation and its keyboard shortcuts, please go to the feature-specific page in the documentation. **Keep in mind that this is a work-in-progress and the current state is not a final state of accessibility in Warp**. -## How to use Warp with Voice Over? +## How to use Warp with VoiceOver The best way to start working with Warp & VoiceOver is to install it using Homebrew: @@ -29,11 +29,11 @@ The login flow will require you to navigate between the app and your browser. Th The main terminal window is not that different from other terminals - there's a place to type commands (Command Input) and a list of the previously executed commands and their outputs. Warp groups those together - each command and output create a Block. You can navigate blocks with your keyboard to easily check what was the command, learn whether it was successful or not, and what was the output, as well as more easily copy the command, output, or both for further processing. -A main entry point for discovering new features and actions is our Command Palette, which you can access by executing the cmd-p shortcut. +A main entry point for discovering new features and actions is our Command Palette, which you can access by pressing `Cmd+P`. ## Differences from the regular VoiceOver workflow -As you may notice, typical Voice Over navigation keys or settings do not currently work in Warp. In short - it's related to how our UI Framework is currently implemented and that as of now we don't yet offer a keyboard-accessible way to navigate the UI elements. +As you may notice, typical VoiceOver navigation keys or settings do not currently work in Warp. In short - it's related to how our UI framework is currently implemented and that as of now we don't yet offer a keyboard-accessible way to navigate the UI elements. Instead, whenever you perform an action and/or something happens in the background, Warp announces it to you, letting you know what's going on and what possible actions you can take. Since it's a terminal, we care about all user actions being keyboard accessible from the start, so pretty much all our features have the assigned keybindings already. You can adjust the default keybindings by following the [Warp keysets repository](https://github.com/warpdotdev/keysets). You can also always fall back to using cmd-p to check the keybinding or execute the specific action. @@ -41,7 +41,7 @@ Instead, whenever you perform an action and/or something happens in the backgrou Some a11y-specific settings are available through the Command Palette. For example, you can adjust the verbosity level of messages. Simply enter the [Command Palette](/terminal/command-palette/) and type "a11y" to discover related options and their keybindings. -### Voice Input +### Voice input Warp supports voice input as an alternative way to interact with your terminal. This can be especially helpful for users who prefer or require voice commands over typing. You can use voice input to: diff --git a/src/content/docs/terminal/more-features/audible-bell.mdx b/src/content/docs/terminal/more-features/audible-bell.mdx index b77c9755..50323437 100644 --- a/src/content/docs/terminal/more-features/audible-bell.mdx +++ b/src/content/docs/terminal/more-features/audible-bell.mdx @@ -7,5 +7,5 @@ description: >- Warp allows you to enable an audible terminal bell (disabled by default) that can be triggered by a variety of CLI tools (for example, `ping -a`). -* In Settings, enable an Audible terminal bell in **Settings** > **Features** > **Terminal**. -* In [Command Palette](/terminal/command-palette/), “Enable/Disable Audible Terminal Bell”. +* Enable the audible terminal bell in **Settings** > **Features** > **Terminal**. +* In the [Command Palette](/terminal/command-palette/), “Enable/Disable Audible Terminal Bell”. diff --git a/src/content/docs/terminal/more-features/files-and-links.mdx b/src/content/docs/terminal/more-features/files-and-links.mdx index 7315b95a..793f24bd 100644 --- a/src/content/docs/terminal/more-features/files-and-links.mdx +++ b/src/content/docs/terminal/more-features/files-and-links.mdx @@ -8,12 +8,12 @@ sidebar: import DemoVideo from '@components/DemoVideo.astro'; import { Tabs, TabItem } from '@astrojs/starlight/components'; -## Files & Links +## Files & links Warp supports opening files, folders, and URL links that are within Blocks. Multiple URL protocols are supported e.g. `https`, `ftp`, `file`, etc. Warp can open files and folders in a variety of editors and opens web links directly in your default browser. Warp can also open markdown files directly with a [Markdown Viewer](/terminal/more-features/markdown-viewer/). :::note -Warp also supports iTerm2 and Kitty Image protocols on macOS and Linux. You will need to use a cli tool to view images, in some cases the tools expect `$TERM=kitty`, so you may need to workaround this by setting `TERM=kitty` before the command. We're working on updating the popular tools to recognize Warp natively. +Warp also supports iTerm2 and Kitty Image protocols on macOS and Linux. You will need to use a CLI tool to view images, in some cases the tools expect `$TERM=kitty`, so you may need to workaround this by setting `TERM=kitty` before the command. We're working on updating the popular tools to recognize Warp natively. ::: Warp parses relative and absolute file paths. Warp also tries to capture line and column numbers attached to the file path, supported formats include: @@ -50,9 +50,9 @@ Warp parses relative and absolute file paths. Warp also tries to capture line an #### List of supported editors -Non exhaustive list of editors, please submit new ones on our GitHub, see [Sending Feedback](/support-and-community/troubleshooting-and-support/sending-us-feedback/#sending-warp-feedback). +Non-exhaustive list of editors, please submit new ones on our GitHub, see [Sending Feedback](/support-and-community/troubleshooting-and-support/sending-us-feedback/#sending-warp-feedback). -1. `$EDITOR` +1. `$EDITOR` 2. Visual Studio Code 3. JetBrains IDEs * WebStorm @@ -73,9 +73,9 @@ Non exhaustive list of editors, please submit new ones on our GitHub, see [Sendi ## Scripts -Warp can open `.command` and Unix Executable files from the finder directly. +Warp can open `.command` and Unix Executable files from Finder directly. -1. Find a `.command` or Shell script you'd like to open in Finder. +1. Find a `.command` or shell script you'd like to open in Finder. 2. Right-click and open the script with Warp. :::caution diff --git a/src/content/docs/terminal/more-features/full-screen-apps.mdx b/src/content/docs/terminal/more-features/full-screen-apps.mdx index fbc2c7ee..bda484e0 100644 --- a/src/content/docs/terminal/more-features/full-screen-apps.mdx +++ b/src/content/docs/terminal/more-features/full-screen-apps.mdx @@ -22,7 +22,7 @@ If you want a mouse event to go to Warp instead (for example, for text selection ### How to access it -* From the Settings panel, **Settings** > **Features** > **Terminal** > **Enable Mouse Reporting** +* From **Settings** > **Features** > **Terminal** > **Enable Mouse Reporting** * Scroll Reporting can be enabled after toggling **Enable Mouse Reporting** * From the [Command Palette](/terminal/command-palette/), search for "Toggle Mouse Reporting" * From the macOS Menu, **View** > **Toggle Mouse Reporting** @@ -42,7 +42,7 @@ Warp allows you to scale your terminal by fractions of a cell width | height. Wh ### How to access it * Go to **Settings** > **Appearance** > **Full-screen Apps** or from the [Command Palette](/terminal/command-palette/) search for "Appearance" - * `Use custom padding in alt-screen` is enabled by default, you can disable it to match the block list padding + * **Use custom padding in alt-screen** is enabled by default, you can disable it to match the block list padding * Set the desired uniform padding (px) pixels, which is set to 0px by default :::caution diff --git a/src/content/docs/terminal/more-features/linux.mdx b/src/content/docs/terminal/more-features/linux.mdx index 6ef5171c..84feba63 100644 --- a/src/content/docs/terminal/more-features/linux.mdx +++ b/src/content/docs/terminal/more-features/linux.mdx @@ -14,4 +14,4 @@ When native Wayland is enabled, Global Hotkey support will be disabled. Unlike X ## Wayland crash recovery -When Wayland support is enabled, Warp uses a custom crash recovery process to detect any crashes that may occur when using Wayland. If there's a crash, Warp will fallback to use X11 to allow you to continue to use the application. +When Wayland support is enabled, Warp uses a custom crash recovery process to detect any crashes that may occur when using Wayland. If there's a crash, Warp will fall back to using X11 to allow you to continue to use the application. diff --git a/src/content/docs/terminal/more-features/quit-warning.mdx b/src/content/docs/terminal/more-features/quit-warning.mdx index 54d9a078..883c4287 100644 --- a/src/content/docs/terminal/more-features/quit-warning.mdx +++ b/src/content/docs/terminal/more-features/quit-warning.mdx @@ -14,13 +14,13 @@ If you quit the app or close a window containing a session with a running proces ## How to access it * Open **Settings** > **Features** > **General**, there you can toggle the "Show warning before quitting". -* You can also toggle the quit warning feature in the [Command Palette](/terminal/command-palette/), by searching for \`Quit Warning'. +* You can also toggle the quit warning feature in the [Command Palette](/terminal/command-palette/), by searching for `Quit Warning`. * If enabled, when you try and close Warp you will see a pop-up window with a few options listed below: - * Yes, quit, which will close all the Warps sessions and running processes. + * Yes, quit, which will close all the Warp sessions and running processes. * Show running processes, which will bring up the [Session Navigation](/terminal/sessions/session-navigation/) panel with a filter for running processes. * Cancel, which will prevent Warp from closing. * Don't ask again, which is a box you can check to disable the quit warning feature. -## How it Works +## How it works diff --git a/src/content/docs/terminal/more-features/working-directory.mdx b/src/content/docs/terminal/more-features/working-directory.mdx index 77b96981..569b7cd3 100644 --- a/src/content/docs/terminal/more-features/working-directory.mdx +++ b/src/content/docs/terminal/more-features/working-directory.mdx @@ -17,8 +17,8 @@ Warp's working directory feature is designed to enhance your workflow by enablin * Open **Settings** > **Features** > **Session** and go to "Working directory for new sessions". * The drop-down for this feature provides several options discussed below: - * Home Directory, is the default option for new sessions and opens new sessions in the currently logged-in users home folder `~/`. - * Previous session's directory, opens new sessions in your active sessions' current directory. + * Home Directory, is the default option for new sessions and opens new sessions in the currently logged-in user's home folder `~/`. + * Previous session's directory, opens new sessions in your active session's current directory. * Custom directory, opens new sessions in a file path you specify. * Advanced, allows you to select from the three options for new sessions in Windows, Tabs, and Panes. diff --git a/src/content/docs/terminal/sessions/launch-configurations.mdx b/src/content/docs/terminal/sessions/launch-configurations.mdx index 7cb519a4..e678f269 100644 --- a/src/content/docs/terminal/sessions/launch-configurations.mdx +++ b/src/content/docs/terminal/sessions/launch-configurations.mdx @@ -13,7 +13,7 @@ Launch Configurations have been replaced by [Tab Configs](/terminal/windows/tab- ## What is it -With Launch configurations you can save in the app or by adding a yaml file. +You can create Launch Configurations in the app or by adding a YAML file. ## Creating a Launch Configuration @@ -41,7 +41,7 @@ With Launch configurations you can save in the app or by adding a yaml file. * From the [Command Palette](/terminal/command-palette/), enter `Launch Configuration` to open and select Launch Configuration. * Right-clicking the new Tab **+** button to open a menu and select saved Launch Configuration. - * Single-window launch configs can be launched into the active window from the launch configuration palette using `CTRL-ENTER` on Linux. + * Single-window launch configs can be launched into the active window from the launch configuration palette using `CTRL-ENTER` on Windows. To open a WSL tab with a Launch Configuration, you must first set WSL as your default shell in Warp: @@ -66,7 +66,7 @@ You can open saved Launch Configurations via Alfred Workflow or [Raycast](/termi -## Launch Configuration YAML Format +## Launch Configuration YAML format All Launch Configuration yaml files are stored in the following location: @@ -188,7 +188,7 @@ windows: Sample configuration that shows how a Window and Tab can be activated with a session in focus. -* Use the `active_window_index` and `active_tab_index`fields to set your active Window and Tab. +* Use the `active_window_index` and `active_tab_index` fields to set your active Window and Tab. * Use the `is_focused` field to set which Pane is focused in each tab. :::caution @@ -198,7 +198,7 @@ Note that when you use `- active_tab_index:` the `tabs:` field doesn't need the ```yaml # Warp Launch Configuration # -# This configurations has two tabs, with the second tab active. +# This configuration has two tabs, with the second tab active. # Two vertical split panes in the first tab and the top pane focused. # Two horizontal split panes in the second tab and the right pane focused. --- @@ -225,7 +225,7 @@ windows: ### Commands -Use the `commands` field to define a set of commands to run when a launch configuration in run. +Use the `commands` field to define a set of commands to run when a launch configuration is run. :::caution You may need to use double quotes for commands with special characters. Commands in separate lines are chained together with `&&` when run, as such commands run after `ssh` commands may not execute. diff --git a/src/content/docs/terminal/sessions/session-navigation.mdx b/src/content/docs/terminal/sessions/session-navigation.mdx index f18004e5..6b897c4e 100644 --- a/src/content/docs/terminal/sessions/session-navigation.mdx +++ b/src/content/docs/terminal/sessions/session-navigation.mdx @@ -8,7 +8,7 @@ sidebar: --- import VideoEmbed from '@components/VideoEmbed.astro'; -## How to access Session navigation +## How to access Session Navigation 1. Open the Session Navigation palette with the [Command Palette](/terminal/command-palette/), click on **session >\_** or type in "sessions:". 2. Jump to a session by using your mouse or the `UP ↑`/`DOWN ↓` arrow keys and `ENTER`. diff --git a/src/content/docs/terminal/sessions/session-restoration.mdx b/src/content/docs/terminal/sessions/session-restoration.mdx index b5a131c4..fc835367 100644 --- a/src/content/docs/terminal/sessions/session-restoration.mdx +++ b/src/content/docs/terminal/sessions/session-restoration.mdx @@ -21,7 +21,7 @@ Session restoration allows you to quickly pick up where you left off in your pre On Linux, opening windows at a specific position is not supported in Wayland. ::: -* You can disable Session Restoration by going to **Settings** > **Features**, then toggling off `Restore windows, tabs, and panes on startup`. +* You can disable Session Restoration by going to **Settings** > **Features**, then toggling off **Restore windows, tabs, and panes on startup**. :::caution Toggling off Session Restoration will not clear the [SQLite database](/terminal/sessions/session-restoration/#session-restoration-database); however, Warp will stop recording new output. @@ -58,7 +58,7 @@ Warp saves the data from your previous session's windows, tabs, and panes to a S Sometimes, you may want to prevent a sensitive Block from being saved on your computer, or you may want to clear blocks from a machine entirely. :::note -This interferes with the running session's ability to save content and may require you close Warp before running the database removal commands. +This interferes with the running session's ability to save content and may require you to close Warp before running the database removal commands. ::: :::danger diff --git a/src/content/docs/terminal/warpify/ssh-legacy.mdx b/src/content/docs/terminal/warpify/ssh-legacy.mdx index 86372e04..5b46fdd9 100644 --- a/src/content/docs/terminal/warpify/ssh-legacy.mdx +++ b/src/content/docs/terminal/warpify/ssh-legacy.mdx @@ -7,7 +7,7 @@ description: >- import DemoVideo from '@components/DemoVideo.astro'; :::note -If you are looking to troubleshoot the tmux SSH feature, see the [SSH](/terminal/warpify/ssh/). +If you are looking to troubleshoot the tmux SSH feature, see the [SSH page](/terminal/warpify/ssh/). ::: When you SSH into a remote box, you get all the features of Warp without any configuration on your part. The input editor, auto-completions, and history search work the same, regardless of machine. @@ -15,11 +15,11 @@ When you SSH into a remote box, you get all the features of Warp without any con :::caution [Limitations of SSH](https://github.com/warpdotdev/Warp/issues/578) (as of May 2024): -* The SSH Wrapper only supports `bash` or `zsh` shells in remote sessions. +* The SSH wrapper only supports `bash` or `zsh` shells in remote sessions. * If you're using a different shell, you'll want to use `command ssh` directly (see below for more details). -* For zsh, xxd is required to bootstrap warp. -* For Windows, [Cygwin](https://www.cygwin.com/) is required to bootstrap the SSH Wrapper. -* RemoteCommand causes the ssh wrapper to fail. +* For zsh, xxd is required to bootstrap Warp. +* For Windows, [Cygwin](https://www.cygwin.com/) is required to bootstrap the SSH wrapper. +* RemoteCommand causes the SSH wrapper to fail. * [Tmux is not currently supported.](https://github.com/warpdotdev/Warp/discussions/501) ::: @@ -38,7 +38,7 @@ We create a wrapper (around `/usr/bin/ssh`) to set up the shell for Warp's featu You can see the SSH wrapper by using `which warp_ssh_helper` in zsh, `type warp_ssh_helper` in bash. -_Note:_ The ssh wrapper is only _initialized_ on your local machine. We don’t currently support bootstrapping nested ssh sessions. +_Note:_ The SSH wrapper is only _initialized_ on your local machine. We don’t currently support bootstrapping nested ssh sessions. :::note Warp [Completions](/terminal/command-completions/completions/) for ssh show entries in `~/.ssh/config` and `~/.ssh/known_hosts` @@ -54,12 +54,12 @@ You should ensure that `MaxSessions` is either commented out or is at least `2`. Write access in `/etc/ssh/` typically requires sudo access. After any edits, you'd also need to restart the `sshd` daemon. -### SSH Wrapper fails +### SSH wrapper fails -There are several [known issues with SSH Wrapper](https://github.com/warpdotdev/Warp/issues?q=is%3Aissue+is%3Aopen+sort%3Acreated-desc+label%3ABugs+label%3ASSH). As a workaround to the SSH Wrapper, you can add `command ssh` to your **Settings** > **Warpify** > **Subshells** > **Added commands**, then run `command ssh ` to connect to a remote session, this will attempt to enable Warp features as a [subshell](/terminal/warpify/subshells/). +There are several [known issues with SSH wrapper](https://github.com/warpdotdev/Warp/issues?q=is%3Aissue+is%3Aopen+sort%3Acreated-desc+label%3ABugs+label%3ASSH). As a workaround to the SSH wrapper, you can add `command ssh` to your **Settings** > **Warpify** > **Subshells** > **Added commands**, then run `command ssh ` to connect to a remote session, this will attempt to enable Warp features as a [subshell](/terminal/warpify/subshells/). :::note -If the subshell workaround helps, we recommend you disable the SSH Wrapper in **Settings** > **Features** > **Session**. You'll need to start a new session before a change is reflected or try invoking the SSH binary directly with `command ssh`. +If the subshell workaround helps, we recommend you disable the SSH wrapper in **Settings** > **Features** > **Session**. You'll need to start a new session before a change is reflected or try invoking the SSH binary directly with `command ssh`. ::: diff --git a/src/content/docs/terminal/warpify/subshells.mdx b/src/content/docs/terminal/warpify/subshells.mdx index 3260eded..67c9e3a3 100644 --- a/src/content/docs/terminal/warpify/subshells.mdx +++ b/src/content/docs/terminal/warpify/subshells.mdx @@ -41,9 +41,9 @@ You can add any command that spawns a bash, fish, or zsh subshell to ‘Added co Furthermore, you can add regular expressions to the Added commands list. Any commands that match an added regex will be eligible for "Warpification." -#### Blocklisting commands +#### Denylisting commands -Some types of subshells are not compatible, and you may also want to control Warp so it never invites you to "Warpify" the subshells for specific commands. When you add commands to the Blocklist, Warp will never invite you to "Warpify" subshells spawned by those commands. +Some types of subshells are not compatible, and you may also want to control Warp so it never invites you to "Warpify" the subshells for specific commands. When you add commands to the denylist, Warp will never invite you to "Warpify" subshells spawned by those commands. ### Automatically "Warpify" subshells diff --git a/src/content/docs/terminal/windows/global-hotkey.mdx b/src/content/docs/terminal/windows/global-hotkey.mdx index 49888cf2..da9123ca 100644 --- a/src/content/docs/terminal/windows/global-hotkey.mdx +++ b/src/content/docs/terminal/windows/global-hotkey.mdx @@ -21,10 +21,10 @@ On Linux, the Global Hotkey may not work for some X11 window managers that do no ### Dedicated window -Dedicated Window allows you to customize the windows' pinned position and its width and height ratio relative to your active screen size (also known as Quake Mode). +Dedicated Window allows you to customize the window's pinned position and its width and height ratio relative to your active screen size (also known as Quake Mode). 1. Open **Settings** > **Features** > **Keys** and select "Dedicated hotkey window" from the Global Hotkey dropdown to enable the feature. -2. Configure the keybinding, the windows position, screen, and relative size or uncheck "Autohides on the loss of keyboard focus" which will cause the dedicated Hotkey Window to stay on top when triggered regardless of mouse or keyboard focus. +2. Configure the keybinding, the window's position, screen, and relative size or uncheck "Autohides on the loss of keyboard focus" which will cause the dedicated Hotkey Window to stay on top when triggered regardless of mouse or keyboard focus. :::caution On Linux and Windows, Warp does not support the "Autohides on the loss of keyboard focus" feature. @@ -59,6 +59,6 @@ Review platform-specific instructions for troubleshooting the global hotkey belo On Windows, there are no known issues with Global Hotkey Dedicated Window. If you find an issue, please [send feedback](/support-and-community/troubleshooting-and-support/sending-us-feedback/) to let us know. - The hotkey window may appear on the incorrect monitor under certain window sizes. For example, with GNOME, if the hotkey window is supposed to show on a monitor having the taskbar (GNOME Panel), and the window height is 100%, causing an overlap, the hotkey window may fallback to showing on an external monitor if you have one. Try working around this by setting a window height to a lesser percentage, e.g. 90%. + The hotkey window may appear on the incorrect monitor under certain window sizes. For example, with GNOME, if the hotkey window is supposed to show on a monitor having the taskbar (GNOME Panel), and the window height is 100%, causing an overlap, the hotkey window may fall back to showing on an external monitor if you have one. Try working around this by setting a window height to a lesser percentage, e.g. 90%. diff --git a/src/content/docs/terminal/windows/index.mdx b/src/content/docs/terminal/windows/index.mdx index 5494896e..39066309 100644 --- a/src/content/docs/terminal/windows/index.mdx +++ b/src/content/docs/terminal/windows/index.mdx @@ -10,7 +10,7 @@ import VideoEmbed from '@components/VideoEmbed.astro'; 1. [Tabs](/terminal/windows/tabs/) allow you to organize a window into multiple terminal sessions. 2. [Vertical Tabs](/terminal/windows/vertical-tabs/) replace the horizontal tab bar with a sidebar that shows rich metadata and drag-and-drop management for every tab and pane. 3. [Split Panes](/terminal/windows/split-panes/) allows you to divide a Tab into multiple rectangular _panes_, each of which is a unique terminal session. -4. [Tab Configs](/terminal/windows/tab-configs/) let you define reusable tab setups in a simple TOML file +4. [Tab Configs](/terminal/windows/tab-configs/) let you define reusable tab setups in a simple TOML file. 5. [Global Hotkey](/terminal/windows/global-hotkey/) is a configurable shortcut that can show/hide a dedicated window or all windows on your chosen desktop regardless of whether the app is focused. 6. [Launch Configurations (Legacy)](/terminal/sessions/launch-configurations/) support saving a configuration of windows, tabs, and panes to open later. diff --git a/src/content/docs/terminal/windows/split-panes.mdx b/src/content/docs/terminal/windows/split-panes.mdx index 062d7b4c..4ea4db62 100644 --- a/src/content/docs/terminal/windows/split-panes.mdx +++ b/src/content/docs/terminal/windows/split-panes.mdx @@ -43,7 +43,7 @@ You can quickly find all the **pane** shortcuts by using the [Command Palette](/ ### CTRL-TAB behavior -`CTRL-TAB` shortcut defaults to activate the previous / next [Tabs](/terminal/windows/tabs/). You can configure the shortcut to cycle the most recent session, including any split panes, in **Settings** > **Features** > **Keys** > **Ctrl-Tab behavior** +`CTRL-TAB` shortcut defaults to activate the previous / next [Tabs](/terminal/windows/tabs/). You can configure the shortcut to cycle the most recent session, including any split panes, in **Settings** > **Features** > **Keys** > **Ctrl-Tab behavior**. ## How split panes work diff --git a/src/content/docs/terminal/windows/tab-configs.mdx b/src/content/docs/terminal/windows/tab-configs.mdx index 51e7d927..4bf50a6a 100644 --- a/src/content/docs/terminal/windows/tab-configs.mdx +++ b/src/content/docs/terminal/windows/tab-configs.mdx @@ -58,7 +58,7 @@ Saved Tab Configs appear in the `+` menu for quick access. When you hover a Tab * **Edit config** — Open the underlying `.toml` file for manual editing. The editor also shows a footer to invoke the **update tab config** skill, so you can describe changes in natural language and have Warp's agent apply them. * **Remove** — Remove the Tab Config from the `+` menu. -* **Make default** — Assign the Tab Config as the default `Cmd T` action for new tabs. +* **Make default** — Assign the Tab Config as the default `Cmd+T` action for new tabs.
![Warp's + menu open with a saved screenshots_tab_config entry highlighted, and a sidecar panel showing Make default, Edit config, and Remove action buttons](../../../../assets/terminal/saved-tab-config-menu.png) @@ -250,5 +250,5 @@ You can also create a worktree-based Tab Config directly from the `+` menu by cl * [Tabs](/terminal/windows/tabs/) — tab management, keyboard shortcuts, and behavior settings * [Themes](/terminal/appearance/themes/) — customize the colors used by tab color settings * [Working Directory](/terminal/more-features/working-directory/) — how Warp resolves working directories -* [Third-Party CLI Agents](/agent-platform/cli-agents/overview/) — use the `"agent"` pane type to open tabs in Agent Mode +* [Third-party CLI agents](/agent-platform/cli-agents/overview/) — use the `"agent"` pane type to open tabs in Agent Mode * [Warp URI Scheme](/terminal/more-features/uri-scheme/) — open Tab Configs via `warp://tab_config/` deeplinks diff --git a/src/content/docs/terminal/windows/tabs.mdx b/src/content/docs/terminal/windows/tabs.mdx index 06fbecd0..809335a7 100644 --- a/src/content/docs/terminal/windows/tabs.mdx +++ b/src/content/docs/terminal/windows/tabs.mdx @@ -74,13 +74,13 @@ Learn more about [setting shell tab titles in Windows Terminal](https://learn.mi ### Tab Restoration -Tab Restoration enables you to reopen recently closed tabs for up to 60 seconds. Configure this feature in **Settings** > **Features** > **Session** > **Enable reopening of closed sessions** +Tab Restoration enables you to reopen recently closed tabs for up to 60 seconds. Configure this feature in **Settings** > **Features** > **Session** > **Enable reopening of closed sessions**. -### CTRL-TAB Behavior +### CTRL-TAB behavior -`CTRL-TAB` shortcut defaults to activate the previous / next Tab. You can configure the shortcut to cycle the most recent session, including any [Split Panes](/terminal/windows/split-panes/), in **Settings** > **Features** > **Keys** > **Ctrl-Tab behavior** +`CTRL-TAB` shortcut defaults to activate the previous / next Tab. You can configure the shortcut to cycle the most recent session, including any [Split Panes](/terminal/windows/split-panes/), in **Settings** > **Features** > **Keys** > **Ctrl-Tab behavior**. -### Tabs Behavior +### Tabs behavior Please see our [Appearance > Tabs Behavior](/terminal/appearance/tabs-behavior/) docs for more Tab related settings.