tabby/clients/vim/README.md

# Tabby VIM extension

## Requirements

1. VIM 9.0+ with `+job` and `+textprop` features enabled, or NeoVIM 0.6.0+.
2. Node.js 16.0+.

## Getting started

### Plug
```
" Make sure that the filetype plugin has been enabled.
filetype plugin on

" Assume using vim-plug as plugin manager
Plug 'TabbyML/tabby', {'rtp': 'clients/vim'}

" Set URL of Tabby server
let g:tabby_server_url = 'http://127.0.0.1:5000'
```

## Usage

1. 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.
2. Use command `:Tabby enable` to enable, `:Tabby disable` to disable Tabby, and `:Tabby status` to check status.
3. Use command `:help Tabby` for more information.
feat: improve vim extension user experience (#71) * chore: checkin dist file for vim extension * use getbufline * do not invoke tabby if file type is unknown * update readme * Update README.md * Update README.md * Update README.md * Update tabby.vim 2023-04-09 12:26:54 +00:00			`# Tabby VIM extension`
Add VIM client. (#63) * Add vim client. * Checking global flag to avoid duplicated loading. 2023-04-08 05:20:27 +00:00
			`## Requirements`

Add neovim support. (#87) * Add neovim support. * Fix lint. 2023-04-11 19:36:27 +00:00			1. VIM 9.0+ with `+job` and `+textprop` features enabled, or NeoVIM 0.6.0+.
feat: improve vim extension user experience (#71) * chore: checkin dist file for vim extension * use getbufline * do not invoke tabby if file type is unknown * update readme * Update README.md * Update README.md * Update README.md * Update tabby.vim 2023-04-09 12:26:54 +00:00			`2. Node.js 16.0+.`

			`## Getting started`

			`### Plug`
			```
Update README.md 2023-04-11 17:46:03 +00:00			`" Make sure that the filetype plugin has been enabled.`
feat: improve vim extension user experience (#71) * chore: checkin dist file for vim extension * use getbufline * do not invoke tabby if file type is unknown * update readme * Update README.md * Update README.md * Update README.md * Update tabby.vim 2023-04-09 12:26:54 +00:00			`filetype plugin on`

VIM plugin: Improve commands, and help document. (#113) * VIM plugin: Add help and improve commands. * Improve help command and command completion. 2023-04-21 05:06:16 +00:00			`" Assume using vim-plug as plugin manager`
feat: improve vim extension user experience (#71) * chore: checkin dist file for vim extension * use getbufline * do not invoke tabby if file type is unknown * update readme * Update README.md * Update README.md * Update README.md * Update tabby.vim 2023-04-09 12:26:54 +00:00			`Plug 'TabbyML/tabby', {'rtp': 'clients/vim'}`
VIM plugin: Improve commands, and help document. (#113) * VIM plugin: Add help and improve commands. * Improve help command and command completion. 2023-04-21 05:06:16 +00:00
			`" Set URL of Tabby server`
feat: improve vim extension user experience (#71) * chore: checkin dist file for vim extension * use getbufline * do not invoke tabby if file type is unknown * update readme * Update README.md * Update README.md * Update README.md * Update tabby.vim 2023-04-09 12:26:54 +00:00			`let g:tabby_server_url = 'http://127.0.0.1:5000'`
			```
Add VIM client. (#63) * Add vim client. * Checking global flag to avoid duplicated loading. 2023-04-08 05:20:27 +00:00
			`## Usage`

			1. 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.
			2. Use command `:Tabby enable` to enable, `:Tabby disable` to disable Tabby, and `:Tabby status` to check status.
VIM plugin: Improve commands, and help document. (#113) * VIM plugin: Add help and improve commands. * Improve help command and command completion. 2023-04-21 05:06:16 +00:00			3. Use command `:help Tabby` for more information.