mirror of
https://github.com/kiteco/vscode-plugin.git
synced 2024-09-11 16:08:10 +03:00
144 lines
6.5 KiB
Markdown
144 lines
6.5 KiB
Markdown
# Kite Autocomplete Plugin for Visual Studio Code
|
||
|
||
[![Report an issue](https://img.shields.io/badge/-Report%20an%20issue-critical)](https://github.com/kiteco/issue-tracker/issues)
|
||
|
||
![GitHub Repo stars](https://img.shields.io/github/stars/kiteco/vscode-plugin?style=social)
|
||
![Twitter Follow](https://img.shields.io/twitter/follow/kitehq?style=social)
|
||
![YouTube Video Views](https://img.shields.io/youtube/views/L2vpOL-jHpQ?label=Kite%20Youtube&style=social)
|
||
|
||
Kite is an **AI-powered** programming assistant that helps you **write code faster inside Visual Studio Code**. Kite helps you write code faster by saving you keystrokes and showing you the right information at the right time.
|
||
|
||
**Kite works for all major programming languages:** Python, Java, Go, PHP, C/C#/C++, Javascript, HTML/CSS, Typescript, React, Ruby, Scala, Kotlin, Bash, Vue and React.
|
||
|
||
![kite vs no kite](https://kite-public-assets.s3-us-west-1.amazonaws.com/kite-public/plugin_vs/kite_vs_nokite.gif)
|
||
|
||
## Features
|
||
### Completions Powered by Machine Learning
|
||
Kite’s code completions are powered by **machine learning** models trained on over 25 million open-source code files. **Kite also runs locally**. Your code is private and does not leave your machine.
|
||
|
||
![](https://kite-public-assets.s3-us-west-1.amazonaws.com/kite-public/plugin-intellij/python_intellij_v1.gif)
|
||
|
||
|
||
### Instant Code Documentation
|
||
|
||
Get instant documentation for the symbol underneath your cursor so you save time searching for Python docs (not yet available for JavaScript docs).
|
||
|
||
![](https://kite-public-assets.s3-us-west-1.amazonaws.com/kite-public/plugin-intellij/kite_documentation.gif)
|
||
|
||
|
||
## Requirements
|
||
|
||
* macOS 10.11+, Windows 7+ or Linux
|
||
* Visual Studio Code v1.28.0+
|
||
* [Kite Engine](https://kite.com/)
|
||
|
||
Use another editor? Check out [Kite’s other editor integrations](https://kite.com/integrations/).
|
||
|
||
|
||
## Installation
|
||
|
||
### Installing the Kite Engine
|
||
|
||
The [Kite Engine](https://kite.com/) 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](https://kite.com/download/) 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](https://kite.com/download/) 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](https://help.kite.com/article/62-managing-editor-plugins).
|
||
|
||
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.](https://kite.com/integrations/vs-code/)
|
||
|
||
|
||
## Usage
|
||
|
||
The following is a brief guide to using Kite in its default configuration.
|
||
|
||
### Autocompletions
|
||
|
||
Simply start typing in a saved Python or JavaScript file and Kite will automatically suggest completions for what you're typing. Kite's autocompletions are all labeled with the `⟠` symbol.
|
||
|
||
![completions](https://s3.amazonaws.com/helpscout.net/docs/assets/589ced522c7d3a784630c348/images/5c3eb54f04286304a71e4292/file-jJZznGIq2t.png)
|
||
|
||
### Hover (Python only)
|
||
|
||
Hover your mouse cursor over a symbol to view a short summary of what the symbol represents.
|
||
|
||
![hover](https://s3.amazonaws.com/helpscout.net/docs/assets/589ced522c7d3a784630c348/images/5c3eb72c2c7d3a3194501270/file-LaHSHhYTkH.png)
|
||
|
||
### Documentation (Python only)
|
||
|
||
Click on the `Docs` link in the hover popup to open the documentation for the symbol inside the Copilot, Kite's standalone
|
||
reference tool.
|
||
|
||
![copilot](https://github.com/kiteco/atom-plugin/blob/master/docs/images/copilot.png?raw=true)
|
||
|
||
### Definitions (Python only)
|
||
|
||
If a `Def` link is available in the hover popup, clicking on it will jump to the definition of the symbol.
|
||
|
||
### Function Signatures (Python only)
|
||
|
||
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.
|
||
|
||
![signature](https://s3.amazonaws.com/helpscout.net/docs/assets/589ced522c7d3a784630c348/images/5c3eb6ad2c7d3a319450126e/file-j1bl9zETcx.png)
|
||
|
||
> __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.related-code-from-file`|Search for code related to the current file in the Copilot|
|
||
|`kite.related-code-from-line`|Search for code related to the current line in the Copilot|
|
||
|`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.python-tutorial`|Open the Kite Python tutorial file|
|
||
|`kite.javascript-tutorial`|Open the Kite JavaScript tutorial file|
|
||
|`kite.go-tutorial`|Open the Kite Go tutorial file|
|
||
|`kite.help`|Open Kite's help website in the browser|
|
||
|
||
|
||
## Troubleshooting
|
||
|
||
Visit our [help docs](https://help.kite.com) for FAQs and troubleshooting support.
|
||
|
||
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](https://twitter.com/kitehq) and get the latest news and programming tips on the
|
||
[Kite Blog](https://kite.com/blog/).
|
||
Kite has been featured in [Wired](https://www.wired.com/2016/04/kites-coding-asssitant-spots-errors-finds-better-open-source/),
|
||
[VentureBeat](https://venturebeat.com/2019/01/28/kite-raises-17-million-for-its-ai-powered-developer-environment/),
|
||
[The Next Web](https://thenextweb.com/dd/2016/04/14/kite-plugin/), and
|
||
[TechCrunch](https://techcrunch.com/2019/01/28/kite-raises-17m-for-its-ai-driven-code-completion-tool/).
|