1
- # Codeium.vim
1
+ <p align =" center " >
2
+ <img width =" 300 " alt =" Codeium " src =" codeium.svg " />
3
+ </p >
2
4
3
- ## Getting started
5
+ ---
6
+
7
+ [ ![ Discord] ( https://img.shields.io/discord/1027685395649015980?label=community&color=5865F2&logo=discord&logoColor=FFFFFF )] ( https://discord.gg/3XFf78nAx5 )
8
+ [ ![ Twitter Follow] ( https://img.shields.io/twitter/follow/codeiumdev )] ( https://twitter.com/intent/follow?screen_name=codeiumdev )
9
+ ![ License] ( https://img.shields.io/github/license/Exafunction/codeium.vim )
10
+
11
+ [ ![ Visual Studio] ( https://img.shields.io/visual-studio-marketplace/d/Codeium.codeium?label=Visual%20Studio&logo=visualstudio )] ( https://marketplace.visualstudio.com/items?itemName=Codeium.codeium )
12
+ [ ![ JetBrains] ( https://img.shields.io/jetbrains/plugin/d/20540?label=JetBrains )] ( https://plugins.jetbrains.com/plugin/20540-codeium/ )
13
+ [ ![ Open VSX] ( https://img.shields.io/open-vsx/dt/Codeium/codeium?label=Open%20VSX )] ( https://open-vsx.org/extension/Codeium/codeium )
14
+ [ ![ Google Chrome] ( https://img.shields.io/chrome-web-store/users/hobjkcpmjhlegmobgonaagepfckjkceh?label=Google%20Chrome&logo=googlechrome&logoColor=FFFFFF )] ( https://chrome.google.com/webstore/detail/codeium/hobjkcpmjhlegmobgonaagepfckjkceh )
15
+
16
+ # codeium.vim
17
+
18
+ _ Free, ultrafast Copilot alternative for Vim and Neovim_
19
+
20
+ Codeium autocompletes your code with AI in all major IDEs. This repository contains the implementation of the Codeium plugin for Vim and Neovim. Check out our [ playground] ( https://www.codeium.com/playground ) if you want to quickly try out Codeium online.
21
+
22
+ Contributions are welcome! Feel free to submit pull requests and issues related to the plugin.
23
+
24
+ ![ Example] ( https://user-images.githubusercontent.com/1908017/213154744-984b73de-9873-4b85-998f-799d92b28eec.gif )
25
+
26
+ ## 🚀 Getting started
4
27
5
28
1 . Install [ Vim] ( https://github.com/vim/vim ) (at least 9.0.0185) or [ Neovim] ( https://github.com/neovim/neovim/releases/latest ) (at
6
- least 0.6)
29
+ least 0.6)
7
30
8
- 2 . Install ` Exafunction/codeium.vim ` using your vim plugin manager of
9
- choice, or manually. See [ Installation Options] ( #installation-options ) below.
31
+ 2 . Install ` Exafunction/codeium.vim ` using your vim plugin manager of
32
+ choice, or manually. See [ Installation Options] ( #- installation-options ) below.
10
33
11
34
3 . Run ` :Codeium Auth ` to set up the plugin and start using Codeium.
12
35
13
36
You can run ` :help codeium ` for a full list of commands and configuration
14
37
options.
15
38
16
- ## Configuration
39
+ ## 🛠️ Configuration
17
40
18
41
Codeium can be disabled for particular filetypes by setting the
19
42
` g:codeium_filetypes ` variable in your vim config file (vimrc/init.vim):
20
43
21
- ``` vimscript
44
+ ``` vim
22
45
let g:codeium_filetypes = {
23
46
\ "bash": v:false,
24
47
\ "typescript": v:true,
@@ -27,47 +50,51 @@ let g:codeium_filetypes = {
27
50
28
51
Codeium is enabled by default for most filetypes.
29
52
30
- You can also * disable * codeium by default with the ` g:codeium_enabled `
53
+ You can also _ disable _ codeium by default with the ` g:codeium_enabled `
31
54
variable:
32
55
33
- ``` vimscript
56
+ ``` vim
34
57
let g:codeium_enabled = v:false
35
58
```
36
59
37
60
For a full list of configuration options you can run ` :help codeium ` .
38
61
39
- ## Installation Options
62
+ ## 💾 Installation Options
40
63
41
- ### vim-plug
42
- ```
64
+ ### 🔌 vim-plug
65
+
66
+ ``` vim
43
67
Plug 'Exafunction/codeium.vim'
44
68
```
45
69
46
- ### Vundle
47
- ```
70
+ ### 📦 Vundle
71
+
72
+ ``` vim
48
73
Plugin 'Exafunction/codeium.vim'
49
74
```
50
75
51
- ### packer.nvim:
52
- ```
76
+ ### 📦 packer.nvim:
77
+
78
+ ``` vim
53
79
use 'Exafunction/codeium.vim'
54
80
```
55
81
56
- ### Manual
82
+ ### 💪 Manual
57
83
58
- #### Vim
84
+ #### 🖥️ Vim
59
85
60
86
Run the following. On windows, you can replace ` ~/.vim ` with
61
87
` $HOME/vimfiles ` :
62
- ```
88
+
89
+ ``` bash
63
90
git clone https://github.com/Exafunction/codeium.vim ~ /.vim/pack/Exafunction/start/codeium.vim
64
91
```
65
92
66
- #### Neovim
93
+ #### 💻 Neovim
67
94
68
95
Run the following. On windows, you can replace ` ~/.config ` with
69
96
` $HOME/AppData/Local ` :
70
97
71
- ```
98
+ ``` bash
72
99
git clone https://github.com/Exafunction/codeium.vim ~ /.config/nvim/pack/Exafunction/start/codeium.vim
73
100
```
0 commit comments