Pyright for PyCharm user documentation

This site serves as the user documentation for the Pyright for PyCharm project. The project includes two plugins:

	The CLI-based plugin	The LSP-based plugin
Repository	pyright-for-pycharm	pyright-langserver-for-pycharm
Marketplace name	Pyright	Pyright Language Server
Codename	CLI	LSP

In this documentation, the two plugins will be referred to using their codenames.

Choosing the right plugin

TLDR: Professional → LSP; Community → CLI.

These two plugins have the same naming conventions, are maintained by the same person, have similar (but not identical) configurations, but are meant for different target users.

LSP is dependent on the experimental language server protocol APIs which are only available for PyCharm Professional and other paid IDEs since 2023.2. This means that PyCharm Community users cannot use it.

On the other hand, CLI can be used by both. However, due to its limited capabilities and performance reason, it is recommended that PyCharm Professional users use LSP instead.

Warning

Do not install both plugins. While doing so will likely cause no technical issues, their functionalities overlap a lot.