shadowkun / vscode-plugin-kite

Kite Python Assistant for Visual Studio Code

Kite Python Plugin for Visual Studio Code

Kite is an AI-powered programming assistant that helps you write Python code inside Visual Studio Code. Kite helps you write code faster by showing you the right information at the right time. Learn more about how Kite heightens VS Code's capabilities at https://kite.com/integrations/vs-code/.

At a high level, Kite provides you with:

• 🧠 Line-of-Code Completions powered by machine learning models trained on the entire open source code universe
• 📝 Intelligent Snippets that automatically provide context-relevant code snippets for your function calls
• 🔍 Instant documentation for the symbol underneath your cursor so you save time searching for Python docs

Requirements

• macOS 10.11+, Windows 7+ or Linux
• Visual Studio Code v1.28.0+
• Kite Engine

Use another editor? Check out Kite’s other editor integrations.

Installation

Installing the Kite Engine

The Kite Engine needs to be installed in order for the package to work properly. The package itself provides the frontend that interfaces with the Kite Engine, which performs all the code analysis and machine learning 100% locally on your computer (no code is sent to a cloud server).

macOS Instructions

1. Download the installer and open the downloaded .dmg file.
2. Drag the Kite icon into the Applications folder.
3. Run Kite.app to start the Kite Engine.

Windows Instructions

1. Download the installer and run the downloaded .exe file.
2. The installer should run the Kite Engine automatically after installation is complete.

Linux Instructions

1. Visit https://kite.com/linux/ to install Kite.
2. The installer should run the Kite Engine automatically after installation is complete.

Installing the Kite Plugin for Visual Studio Code

When running the Kite Engine for the first time, you'll be guided through a setup process which will allow you to install the VS Code extension. You can also install or uninstall the VS Code extension at any time using the Kite Engine's plugin manager.

Alternatively, you have 2 options to manually install the package:

1. Search for "Kite" in VS Code's built-in extension marketplace and install from there.
2. Run the command code --install-extension kiteco.kite in your terminal.

Learn about the capabilities Kite adds to VS Code.

Usage

The following is a brief guide to using Kite in its default configuration.

Hover

Hover your mouse cursor over a symbol to view a short summary of what the symbol represents.

Documentation

Click on the Docs link in the hover popup to open the documentation for the symbol inside the Copilot, Kite's standalone reference tool.

Definitions

If a Def link is available in the hover popup, clicking on it will jump to the definition of the symbol.

Autocompletions

Simply start typing in a saved Python file and Kite will automatically suggest completions for what you're typing. Kite's autocompletions are all labeled with the ⟠ symbol.

Function Signatures

When you call a function, Kite will show you the arguments required to call it. Kite's function signatures are also all labeled with the ⟠ symbol.

Note: If you have the Microsoft Python extension installed, Kite will not be able to show you information on function signatures.

Commands

Kite comes with sevaral commands that you can run from VS Code's command palette.

Command	Description
kite.open-copilot	Open the Copilot
kite.docs-at-cursor	Show documentation of the symbol underneath your cursor in the Copilot
kite.engine-settings	Open the settings for the Kite Engine
kite.help	Open Kite's help website in the browser

Contact Us

Feel free to contact us with bug reports, feature requests, or general comments at [email protected].

Happy coding!

---

About Kite

Kite is built by a team in San Francisco devoted to making programming easier and more enjoyable for all. Follow Kite on Twitter and get the latest news and programming tips on the Kite Blog. Kite has been featured in Wired, VentureBeat, The Next Web, and TechCrunch.