Skip to content

Add JetBrains IDE instructions to ACP documentation #163

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
neubig wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Add JetBrains IDE instructions to ACP documentation #163

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions openhands/usage/run-openhands/acp.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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