Existing Kite User?
The only prerequisites are that you have Kite Engine running and the Atom plugin installed. If you don't have the Atom plugin installed, you can learn how to do so here.
Note: If you installed the Atom plugin while Atom was already running, you'll need to restart Atom for the plugin to activate.
Checking the Status of Kite
If Kite is installed properly, you should see a small Kite logo at the bottom right corner of the Atom window. Hovering your mouse over this icon will tell you the current status of Kite.
There are a handful of possible states Kite can be in, as described in the following table:
|Kite is not installed||Kite Engine is not installed.|
|Kite is not running||Kite Engine is not running.|
|Kite is ready||Kite is ready to go — start coding!|
|No icon||No message|| This typically means that you are coding in an unsaved file or a filetype that is not
Note: When you first start the editor, Kite takes 15 seconds to load up the machine learning models that power completions. During that time, you will not see Kite completions.
For the first two (red) states, the Atom plugin will generally allow you take action to get out of the invalid state. For example, the plugin will allow you to start Kite Engine from Atom directly.
Clicking on the icon will open a menu that will allow you to access your settings or get help.
Writing Code and Accessing Features
In the following sections, the
$ character indicates the position of your editor's text cursor.
.vue extension. Now type the following code:
A list of suggested completions should automatically appear. Kite's completions are marked with the Kite logo on the left side.
Here are ways Kite completions work differently than your typical autocomplete:
Kite can complete up to multiple lines of code at a time, reducing the time you spend writing repetitive code.
Kite is able to provide completions when editors like VS Code cannot understand the code.
Kite shows completions in more situations, for example after a space.
Kite works alongside your editor’s completions. We use carefully-designed filters to reduce noise.
The Atom plugin provides a number of commands for ease of use. The GitHub repository contains information on the available commands.