Quickstart

System requirements

Kite currently works on macOS 10.10 or greater and Windows 7 or greater. Linux support is in development and will be available soon.

Downloading Kite

You can download the latest version of Kite here.

Installing Kite

macOS

Open the .dmg file and drag the Kite icon into your Applications folder. Within the Applications folder, double-click on the Kite icon to run it.

Windows

Open the .exe file and click “Yes” when the installer asks for permissions to install Kite. The installer will run Kite automatically after it finishes installing.

Running Kite for the first time

The following steps are only relevant if you're running Kite on your computer for the first time. The screenshots shown here are for macOS but the Windows experience is identical.

Creating an account

When you open Kite for the first time, the Sidebar will appear and ask you to login to your account.

If you don't have a Kite account yet, then you'll need to create one at this screen. Otherwise, you can choose to log in to your Kite account now.

Choosing your editors

Next, you'll be greeted by a welcome screen. Click “Continue” and you'll get to choose which editors to integrate Kite with.

Kite currently supports the following editors:

  • Atom
  • Sublime Text 3
  • VS Code
  • IntelliJ & PyCharm
  • Vim & Neovim
  • Emacs

You'll be able to manage which editors are integrated with Kite afterwards as well.

Whitelisting a directory

In order for Kite to work properly, you'll have to give it read-access to a directory that you'll be coding in.

Important: Since code analysis happens in the cloud, Kite will be able to upload any source code file that resides in this directory, or any of its subdirectories, to our remote servers.

Historically, most users have been fine with the provided default, but please be mindful if there are source code files with sensitive contents on your computer. You may also skip whitelisting a directory now and instead do it later, though Kite won't work until you've set this up. A proceeding section will explain in-depth how to manage Kite's access more precisely.

Help us improve Kite!

Next, you can fill out an optional survey to help us learn about what kind of features would help you code better. This step is optional and can be skipped.

Toggling the menubar icon

You have the option to hide or show the menubar icon.

The menubar icon provides a number of commands you can run while Kite is running, such as opening and closing the Sidebar window. If you choose to hide the menubar icon now, you can always change your settings later.

Start coding!

At this point, you're ready to start writing some code with Kite. We have some guides for your favorite editor(s) to help you get familiar with what Kite can do.