Added a section that explains how to install the extension on packer and lazy. |
||
|---|---|---|
| .. | ||
| autoload | ||
| doc | ||
| node_scripts | ||
| plugin | ||
| .gitignore | ||
| README.md | ||
| package.json | ||
| yarn.lock | ||
README.md
Tabby VIM extension
Requirements
- VIM 9.0+ with
+joband+textpropfeatures enabled, or NeoVIM 0.6.0+. - Node.js 16.0+.
Getting started
🔌 Vim-Plug
" Make sure that the filetype plugin has been enabled.
filetype plugin on
" Add this to the vim-plug config
Plug 'TabbyML/tabby', {'rtp': 'clients/vim'}
" Set URL of Tabby server
let g:tabby_server_url = 'http://127.0.0.1:8080'
📦 Packer and Lazy
In this case, you first need to clone the repo in your machine
git clone https://github.com/TabbyML/tabby.git ~/tabby
Then on the config file:
" For lazy
return { name = "tabby", dir = '~/tabby/clients/vim', enabled = true }
" For packer
use {'~/tabby/clients/vim', as = 'tabby', enabled = true}
" Set URL of Tabby server
" With Lua
vim.g.tabby_server_url = 'http://127.0.0.1:8080'
" With VimScript
let g:tabby_server_url = 'http://127.0.0.1:8080'
In the future, the ideal would be to export the Vim extension to a separate Git repository. This would simplify the installation process #252.
Usage
- In insert mode, Tabby will show code suggestion when you stop typing. Press
<Tab>to accpet the current suggestion,<M-]>to see the next suggestion,<M-[>to see previous suggestion, or<C-]>to dismiss. - Use command
:Tabby enableto enable,:Tabby disableto disable Tabby, and:Tabby statusto check status. - Use command
:help Tabbyfor more information.