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

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

Add JetBrains IDE instructions to ACP documentation #163

neubig wants to merge 1 commit into from

Conversation

@neubig
Copy link
Contributor

@neubig neubig commented Dec 8, 2025

  • I have read and reviewed the documentation changes to the best of my ability.
  • If the change is significant, I have run the documentation site locally and confirmed it renders as expected.

Summary of changes

This PR adds comprehensive documentation for using OpenHands CLI with JetBrains IDEs (IntelliJ IDEA, PyCharm, WebStorm, etc.) through the Agent Client Protocol.

Changes made:

  • Added a new "JetBrains IDEs" section to the ACP documentation
  • Included step-by-step instructions for configuring OpenHands CLI with JetBrains IDEs
  • Added guidance on how to find the full path to the openhands executable using which openhands
  • Provided example configuration for ~/.jetbrains/acp.json file
  • Added a helpful example showing a complete configuration with a real path
  • Included a note about JetBrains AI Assistant requirements
  • Added link to official JetBrains ACP documentation in the "See Also" section

Fixes #162

@neubig can click here to continue refining the PR

@openhands-agent
Add JetBrains IDE instructions to ACP documentation
f88e6e2 
- 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-ai openhands-ai bot mentioned this pull request Dec 8, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mamoodi mamoodi Awaiting requested review from mamoodi mamoodi will be requested when the pull request is marked ready for review mamoodi is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Document how to use OpenHands in Jetbrains IDEs

3 participants

@neubig @openhands-agent