tabby/clients/vim/doc/tabby.txt

86 lines
2.8 KiB
Plaintext

tabby.txt Tabby
*Tabby* *tabby* *Tabby-doc*
Tabby is a self-hosted AI coding assistant that can suggest multi-line code or
full functions in real-time. For more information, please check out our
{Website}{1} and {Github}{2}. If you encounter any problem or have any
suggestion, please {open_an_issue}{3} or join our {Slack_community}{4} for
support.
{1} https://www.tabbyml.com/
{2} https://github.com/TabbyML/tabby
{3} https://github.com/TabbyML/tabby/issues/new
{4} https://join.slack.com/t/tabbycommunity/shared_invite/zt-1xeiddizp-bciR2RtFTaJ37RBxr8VxpA
*Tabby-compatibility* *Tabby-NeoVim*
Compatibility~
This plugin is compatible with VIM 9.0+ with `+job` and `+textprop` features
enabled, or NeoVIM 0.6.0+.
*Tabby-commands*
Commands~
*:Tabby*
:Tabby Same as |:Tabby-status|.
*:Tabby-status*
:Tabby status Check the status of Tabby. Report error message if any
issue exists.
*:Tabby-version*
:Tabby version Print the version of Tabby plugin.
*:Tabby-auth*
:Tabby auth Start to complete the authentication process. Only used
when you are using a Tabby Cloud endpoint.
*:Tabby-help*
:Tabby help [subject] Search for help information in this document using
VIM command `:help`.
*Tabby-options*
Options~
*g:tabby_node_binary* *Tabby-node*
g:tabby_node_binary Tabby plugin will try to find the Node.js binary in
your `PATH` environment variable. If you have installed
Node.js in a non-standard location, or you are using a
version manager such as nvm, you can set the Node.js
binary path here.
>
let g:tabby_node_binary = '/path/to/node'
<
*g:tabby_trigger_mode* *Tabby-trigger*
g:tabby_trigger_mode Completion trigger mode.
- 'auto': Trigger completion automatically when you
stop typing.
- 'manual': Only trigger completion when you press
`<C-\>`.
Default value is 'auto'.
>
let g:tabby_trigger_mode = 'auto'
let g:tabby_trigger_mode = 'manual'
<
*g:tabby_filetype_dict* *Tabby-filetype*
g:tabby_filetype_dict This option is a dictionary that map from the Vim
`:filetype` to {VSCode_Language_Identifier}{1}. Not
listed filetype will be used as language identifier
directly.
The following mappings are provided by default, you can
add your own mappings to override them.
{1} https://code.visualstudio.com/docs/languages/identifiers
>
let g:tabby_filetype_dict = #{
\ bash: "shellscript",
\ sh: "shellscript",
\ cs: "csharp",
\ objc: "objective-c",
\ objcpp: "objective-cpp",
\ make: "makefile",
\ cuda: "cuda-cpp",
\ text: "plaintext",
\ }
<
*Tabby-keybindings* *Tabby-map*
Keybindings~
<Tab> Accept the current completion, fallback to normal
`<Tab>` if no completion is shown.
<C-\> Trigger completion if not shown. Dismiss the current
completion if shown.
vim:tw=78:ts=8:noet:ft=help:norl: