Skip to content
Open
Show file tree
Hide file tree
Changes from 5 commits
Commits
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
34 changes: 12 additions & 22 deletions docs/installation/ides.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,37 +146,27 @@ Emacs users have 3 options:

## PyCharm

=== "PyCharm Community"
PyCharm users can enable native basedpyright support in the settings:

1. install the [LSP4IJ](https://plugins.jetbrains.com/plugin/23257-lsp4ij) plugin
2. install the [Pyright](https://plugins.jetbrains.com/plugin/24145) plugin
3. configure it to use basedpyright by specifying `basedpyright-langserver` as the executable and check the "Resolve against interpreter directory, ignoring extension" checkbox:\
![](./pycharm-lsp-exe.png)
4. set "Running mode" to "LSP4IJ":\
![](./lsp4ij.png)
1. Go to **Python > Tools > Pyright** in the Settings dialog.
2. Select the **Enable** checkbox.
3. In the Execution mode setting, select how PyCharm should search for the executable:

=== "PyCharm Professional / IntelliJ IDEA Ultimate"
**Interpreter** mode (recommended): PyCharm searches for an executable installed in your interpreter. To install the basedpyright package for the selected interpreter, click _Install basedpyright_.

1. install the [Pyright](https://plugins.jetbrains.com/plugin/24145) plugin
3. configure it to use basedpyright by specifying `basedpyright-langserver` as the executable and check the "Resolve against interpreter directory, ignoring extension" checkbox:\
![](./pycharm-lsp-exe.png)
3. set "Running mode" to "Native LSP client":\
![](./native-lsp.png)
**Path** mode: PyCharm searches for an executable in `$PATH`. If the executable is not found, you can specify the path by clicking the Browse... icon.

!!! tip "pinning basedpyright as a development dependency to your project (recommended)"

we recommend configuring these settings as overrides in the "Appearance & Behavior > Required Plugins" menu, and configuring the pyright plugin (and LSP4IJ if using pycharm community) as a recommended dependency:
4. Select which options should be enabled.

![](pycharm-recommended-dependency.png)
For more information, refer to [PyCharm documentation](https://www.jetbrains.com/help/pycharm/2025.3/lsp-tools.html#pyright).

!!! tip "pinning basedpyright as a development dependency to your project (recommended)"

you should then commit the following generated config files, so that others working on your repo are prompted to install the plugin and don't have to manually configure it themselves:
you should commit the following generated config file, so that others working on your repo don't have to manually configure it themselves:

- `.idea/pyright-overrides.xml`
- `.idea/pyright.xml`
- `.idea/externalDependencies.xml`
- `.idea/misc.xml`
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


(note that pycharm hides the `.idea` directory by default, so you will need to `git add` the files via the CLI instead.)
(note that pycharm hides the `.idea` directory by default, so you will need to `git add` the file via the CLI instead.)

## Helix

Expand Down
Binary file removed docs/installation/lsp4ij.png
Binary file not shown.
Binary file removed docs/installation/native-lsp.png
Binary file not shown.
Binary file removed docs/installation/pycharm-lsp-exe.png
Binary file not shown.
Binary file removed docs/installation/pycharm-recommended-dependency.png
Binary file not shown.