How to use the Copilot

Kite ships with a desktop application called the Copilot that allows you to look up information while you code. This article will teach you how to use all the features of the Copilot.

Accessing the Copilot

You can access the Copilot from the menu bar icon by clicking on "Open Copilot". If the menu bar icon is not shown, then you can visit kite://home in your browser.

Search Documentation

Search for documentation manually

You can search for Python documentation by identifier name (e.g. json.dumps) using the search bar. The Copilot will autocomplete search suggestions for you based on the most popular search terms that match your query.

Use the arrow keys to navigate the search results and enter to select a search result. You can also use your mouse to select a search result.

Search for documentation using your current cursor position

The Copilot can also automatically search for documentation as you code by looking up the object underneath your editor's cursor. To enable this feature, click on the “Click for docs to follow cursor” button to the right of the search bar.

⚠ Important: You must have the Kite plugin installed for your editor to allow the Copilot to follow your cursor. You can use the plugin manager to install editor plugins.

You can click on the same button to toggle the feature off/on afterwards.

Note: Documentation at your cursor only works when your code is completely indexed, which may take several minutes if you are running Kite for the first time. Kite displays a status symbol within your editor while indexing. Refer to our editor integration guides to learn more about checking Kite's indexing status.

Top window setting

If you would like to prevent the Copilot from being hidden by other windows while you code, you can set the Copilot window to be always-on-top. To do so, click on the gear icon at the lower right corner and then check the checkbox labeled "Set your Copilot to always be your top window".

Documentation in the Copilot

The Copilot shows several pieces of information about an expression.

Title (1)

This is the full name of the identifier, as well as the type of the value the identifier refers to. You may also navigate through the history of viewed identifiers using the arrow icons on the very right.

Type specific information (2)

The information displayed here depends on the type of the expression. In the example above, since json.dumps is a function, this area will display the function signature as well as popular calling patterns. If the expression refers to a module, we show the top members of that module.

Likewise, if the expression refers to a type, the dashboard will show the top attributes of the type.

Documentation (3)

This section contains the actual documentation for the expression, if available.

Code examples (4)

The dashboard will also show curated code examples for the expression, if available. You can click on the title of a code example to see the example in its entirety, as well as other related code examples.

Known Issues

If you are having issues using the Copilot, please refer to the known issues to troubleshoot.