JetBrains Plugin User Guide
Complete guide to using Sypha in IntelliJ IDEA, WebStorm, PyCharm, and the broader JetBrains ecosystem.
Sypha for JetBrains brings high-performance agentic AI coding into IntelliJ IDEA, WebStorm, PyCharm, and the broader JetBrains ecosystem. It integrates deeply with the IDE to support intelligent code generation, project-aware assistance, and autonomous debugging workflows.
Key Capabilities
- IDE Integration: Leverages native JetBrains indexing for stronger project awareness.
- Cross-IDE Consistency: Delivers a consistent AI-assisted experience across all JetBrains products.
- Autonomous Agents: Provides specialised modes for planning, execution, and debugging.
Installation
- Open Settings (
Ctrl+Alt+S/⌘,). - Navigate to Plugins.
- Search the Marketplace for Sypha.
- Click Install.
- Restart the IDE to complete setup.
Alternatively, install directly from the JetBrains Marketplace.
Login and Authentication
- Open the Sypha tool window (View → Tool Windows → Sypha).
- Click Login.
- Complete the browser-based sign-in flow.
- Confirm the redirect to link the IDE to your account.
Initial Setup
- Open Sypha Settings via the gear icon in the Sypha tool window.
- Select your preferred Model Provider (Sypha is recommended for the standard managed experience; Custom Provider for custom model configurations).
- Choose a high-capability model such as Claude 4.5 Sonnet.
Modes and Usage
Switch modes using the mode dropdown or slash commands. The mode controls which tools are available and how autonomously Sypha operates.
| Mode | Slash Command | Best For | Description |
|---|---|---|---|
| Orchestrator Mode | /orchestrator | Large, multi-step work | Breaks down complex requests and coordinates sub-tasks |
| Strategist Mode | /strategist | Planning and architecture | Proposes designs and logic without modifying code |
| Chat Mode | /chat | Quick questions | Safe, read-only explanations and support |
| Debugger Mode | /debugger | Bug investigation | Analyses root causes and proposes fixes |
| Developer Mode | /developer | Writing and refactoring code | Main implementation mode for active coding tasks |
| Designer Mode | /designer | UI/UX design components | Builds pixel-perfect, brand-consistent interfaces following design system rules |
Using Context Effectively with @
To improve precision, Sypha allows you to point directly to the files, folders, or issues that matter. Type @ in the chat input to open a context picker.
Available Targets
@file— target a specific file, for example@FastAPIUserService.ts@folder— target a directory, for example@src/services@problems— reference current workspace issues and errors
Example Prompts
Explain @FastAPIUserService.ts
Refactor @controllers/userController
Find bugs in @entire projectWhy This Matters
- Improves response accuracy.
- Reduces hallucinations and irrelevant output.
- Helps Sypha focus exactly where you need it.
Power Features
Enhance Prompt
The Enhance Prompt feature transforms vague requests into clearer, more detailed specifications. Use it when a request feels too vague or when responses are weak or incomplete.
Example:
- Before:
Fix this - After:
Fix null pointer issue in @src/services/fastapi/FastAPIUserService.ts and add proper error handling
YOLO Mode
YOLO Mode enables Sypha to take action without step-by-step confirmation. It can edit multiple files and execute commands automatically.
Use with caution:
- Best used on branches where changes can be reviewed or reverted easily.
- Avoid using it on sensitive production systems without strong safeguards.
See Auto-Approving Actions for full details on enabling YOLO Mode.
Terminal Automation
Sypha can automatically run terminal commands such as tests, builds, and package installations. Command results are fed back into the assistant to validate changes or continue troubleshooting.
Examples:
Run tests and fix failures
Install missing dependenciesSee Terminal Automation for full details.
Browser Mode
Browser Mode allows Sypha to fetch information from the internet. Useful for documentation lookup, API research, and searching for solutions to uncommon errors.
Headless Browser Mode
Headless Browser Mode is a more advanced web interaction capability that allows Sypha to work with page elements directly — useful for end-to-end testing, verifying UI changes, and interacting with internal tools in a browser-like workflow.
Codebase Indexing
Indexing builds a local representation of your codebase by mapping symbols and their relationships, enabling faster and more accurate contextual understanding.
How to trigger indexing:
- In the chat interface, click the left arrow button to expand the toolbar.
- Select the DB option to open indexing settings.
- Configure your embedding provider and vector store.
- Click Start Indexing to begin.
Supported Embedding Providers: Ollama (local), OpenRouter, OpenAI, Amazon Bedrock, Mistral AI, Google Gemini, Vercel AI Gateway.
Supported Vector Databases: LanceDB (local setup), Qdrant (via Docker or WSL).
See Codebase Indexing for full configuration details.
Settings and Preferences
| Setting | Description |
|---|---|
| YOLO Mode | Enables high-autonomy execution |
| Auto-approve | Skips smaller confirmation prompts such as routine reads |
| Auto-run Terminal | Allows Sypha to execute terminal commands automatically |
| Browser / Headless Mode | Enables web access and interactive browser workflows |
MCP Setup
Sypha can connect to external tools through the Model Context Protocol (MCP).
- Open the MCP tab in Settings.
- Install integrations from the Marketplace (Apify, Atlassian, AWS, and hundreds more).
- Add Custom MCPs for private or internal tools when needed.
See MCP Overview for full configuration details.
Recommended Workflow
- Install the plugin and sign in through the browser flow.
- Select your provider and model in Settings.
- Index the workspace using the DB button.
- Start in Chat or Strategist mode for understanding and planning.
- Move to Developer mode for implementation.
- Use Debugger mode when failures appear.
- Add
@context to keep requests focused and efficient.
Best Practices
- Use
@context for precise, lower-noise prompting. - Use Enhance Prompt when task wording is weak or incomplete.
- Avoid YOLO Mode for critical production work unless changes can be safely reviewed and reverted.
- Review terminal activity carefully when enabling command automation.
Troubleshooting
For common issues with the JetBrains plugin — including JCEF rendering, authentication via JetBrains Toolbox, and Node.js requirements — see the JetBrains Troubleshooting Guide.