Skip to content
Branch: master
Find file History
Latest commit c647255 May 23, 2019
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs/assets update READMEs Mar 1, 2019 update READMEs May 22, 2019

Kite Python Assistant

Kite is an AI-powered programming assistant that helps you write Python code inside Sublime Text 3. 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.


Kite's goal is to help you write code faster by showing you the right information at the right time. At a high level, Kite provides you with:

  • 🧠 Smart autocompletions powered by machine learning models trained on the entire open source code universe
  • 👀 Advanced function signatures that show you not only the official signature of a function, but also the most popular ways other developers call the function
  • 🔍 Instant documentation for the symbol underneath your cursor


  • macOS 10.10+ or Windows 7+ or Linux (Ubuntu, Debian, Fedora, Arch Linux, Linux Mint, openSUSE, KDE, XFCE, Gnome 2, Gnome 3)
  • Sublime Text build 3000+
  • Kite Engine


Installing the Kite Engine

macOS Instructions

  1. Download the installer and open the downloaded .dmg file.
  2. Drag the Kite icon into the Applications folder.
  3. Run 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. Follow our instructions to install Kite.
  2. The installer should run the Kite Engine automatically after installation is complete.

Installing the Kite Assistant for Sublime

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

Alternatively, you can git clone this repository directly into your Sublime Packages directory. You can locate your Packages directory by opening Sublime, clicking on the Preferences menu item, then selecting Browse Packages....

Learn more about Kite for Sublime.


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


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


If the built-in show_definition preference is enabled, Kite will show you the definitions and references found in the Sublime index as usual.



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



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


Simply start typing in a saved Python file and Kite will automatically suggest completions for what you're typing.


Function Signatures

When you call a function, Kite will show you the arguments required to call it.


Kite also shows you How others used this function, which are the most popular calling patterns inferred from all the open source code on the internet.

Commands and Keyboard Shortcuts

In case you prefer to not use the mouse, most of Kite's features can be triggered from the command palette.


Furthermore, Kite comes with the following default keyboard shortcuts:

Command Shortcut Description
Hover ctrl+alt+h Show the hover popup at your current cursor position
Documentation ctrl+alt+d Show documentation in the Copilot
Function Signatures ctrl+alt+u Show the function signature panel
Keyword Arguments ctrl+alt+y Show/hide keyword arguments (when function signature panel is shown)
Popular Patterns ctrl+alt+p Show/hide popular calling patterns (when function signature panel is shown)


You can change Kite's settings by clicking on Preferences, then Package Settings, then Kite. Alternatively, you can access the preferences files from the command palette using Kite: Package Settings. The default preferences file should be self documenting.

Known Issues

  • On Sublime 3200+, the function signature UI is truncated in some situations. (Issue)

Contact Us

Feel free to contact us with bug reports, feature requests, or general comments at

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.

You can’t perform that action at this time.