From f88e6e2abf07afed8ced8d5bc5f6e5997ff729ed Mon Sep 17 00:00:00 2001
From: openhands <openhands@all-hands.dev>
Date: Mon, 8 Dec 2025 21:29:27 +0000
Subject: [PATCH] Add JetBrains IDE instructions to ACP documentation

- Document how to configure OpenHands CLI with JetBrains IDEs
- Add step-by-step instructions for finding openhands executable path
- Include example configuration for ~/.jetbrains/acp.json
- Add link to official JetBrains ACP documentation
- Fixes #162
---
 openhands/usage/run-openhands/acp.mdx | 48 +++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)

diff --git a/openhands/usage/run-openhands/acp.mdx b/openhands/usage/run-openhands/acp.mdx
index 69cff159..d2988e3b 100644
--- a/openhands/usage/run-openhands/acp.mdx
+++ b/openhands/usage/run-openhands/acp.mdx
@@ -106,9 +106,57 @@ The debug logs can help you identify configuration issues, connection problems,
 If you encounter persistent issues, verify that OpenHands CLI is properly configured (see [Prerequisites](#prerequisites)) and that all server commands are executable from your system PATH.
 </Note>
 
+### JetBrains IDEs
+
+[JetBrains IDEs](https://www.jetbrains.com/) (IntelliJ IDEA, PyCharm, WebStorm, etc.) support the Agent Client Protocol through JetBrains AI Assistant.
+
+To configure OpenHands CLI with JetBrains IDEs:
+
+1. Ensure OpenHands CLI is installed and configured (see [Prerequisites](#prerequisites))
+
+2. Find the full path to the `openhands` executable by running in your terminal:
+
+```bash
+which openhands
+```
+
+3. Create or edit the file `$HOME/.jetbrains/acp.json` and add the following configuration, replacing `{full_path_to_openhands}` with the actual full path from step 2:
+
+```json
+{
+  "agent_servers": {
+    "OpenHands": {
+      "command": "{full_path_to_openhands}",
+      "args": ["acp"],
+      "env": {}
+    }
+  }
+}
+```
+
+For example, if `which openhands` returns `/Users/username/.local/bin/openhands`, your configuration should look like:
+
+```json
+{
+  "agent_servers": {
+    "OpenHands": {
+      "command": "/Users/username/.local/bin/openhands",
+      "args": ["acp"],
+      "env": {}
+    }
+  }
+}
+```
+
+4. Follow the [JetBrains ACP instructions](https://www.jetbrains.com/help/ai-assistant/acp.html) to open and use an agent in your JetBrains IDE
+
+<Note>
+Make sure you have JetBrains AI Assistant enabled in your IDE. The AI Assistant is available in JetBrains IDEs version 2024.3 or later.
+</Note>
 
 ## See Also
 
 - [CLI Mode](/openhands/usage/run-openhands/cli-mode) - Learn about using OpenHands CLI interactively
 - [ACP Documentation](https://agentclientprotocol.com/protocol/overview) - Full Agent Client Protocol specification
 - [Zed Documentation](https://zed.dev/docs) - Learn more about using Zed editor
+- [JetBrains ACP Documentation](https://www.jetbrains.com/help/ai-assistant/acp.html) - Learn more about using ACP in JetBrains IDEs