tabby/clients/vscode/README.md

29 lines
2.1 KiB
Markdown
Raw Normal View History

2023-04-06 09:54:00 +00:00
# Tabby VSCode Extension
2023-04-06 10:23:30 +00:00
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
2023-04-11 07:46:46 +00:00
[![VSCode Extension Version](https://img.shields.io/visual-studio-marketplace/v/TabbyML.vscode-tabby)](https://marketplace.visualstudio.com/items?itemName=TabbyML.vscode-tabby)
[![VSCode Extension Installs](https://img.shields.io/visual-studio-marketplace/i/TabbyML.vscode-tabby)](https://marketplace.visualstudio.com/items?itemName=TabbyML.vscode-tabby)
[![Slack Community](https://shields.io/badge/Tabby-Join%20Slack-red?logo=slack)](https://join.slack.com/t/tabbycommunity/shared_invite/zt-1xeiddizp-bciR2RtFTaJ37RBxr8VxpA)
2023-04-06 10:23:30 +00:00
Tabby is an AI coding assistant that can suggest multi-line code or full functions in real-time.
Tabby VSCode extension is compatible with `VSCode ≥ 1.70.0`, as well as web environments like [vscode.dev](https://vscode.dev).
For more information, please check out our [Website](https://tabbyml.com/) and [GitHub](https://github.com/TabbyML/tabby).
2023-04-06 09:54:00 +00:00
If you encounter any problem or have any suggestion, please [open an issue](https://github.com/TabbyML/tabby/issues/new)!
## Demo
Try our online demo [here](https://tabbyml.github.io/tabby/playground).
![Demo](https://tabbyml.github.io/tabby/img/demo.gif)
2023-04-06 09:54:40 +00:00
## Get Started
If you have installed the Tabby VSCode extension, you can follow the built-in walkthrough guides to get started. You can also reopen walkthrough page anytime by using command `Tabby: Getting Started`.
1. Setup the Tabby server: you can get a Tabby Cloud hosted server [here](https://app.tabbyml.com), or build your self-hosted Tabby server following [this guide](https://tabbyml.github.io/tabby/docs/self-hosting/).
2. Use the command `Tabby: Specify API Endpoint of Tabby` to connect the extension to your Tabby server. If you are using a Tabby Cloud server endpoint, please follow the popup messages to complete authorization.
Once setup is complete, Tabby will provide inline suggestions automatically, and you can accept suggestions by just pressing the Tab key. You can hover on the inline suggestion text to find more useful actions such as partially accepting by word or by line.