Skip to content

Commit 272c6e2

Browse files
authored
A rose by any other name (Exafunction#493)
1 parent 000de97 commit 272c6e2

File tree

5 files changed

+32
-107
lines changed

5 files changed

+32
-107
lines changed

README.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
11
<p align="center">
2-
<img width="300" alt="Codeium" src="codeium.svg"/>
2+
<img width="300" alt="Windsurf" src="windsurf.png"/>
33
</p>
44

55
---
66

77
[![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/badge/style--blue?style=social&logo=twitter&label=Follow%20%40codeiumdev)](https://twitter.com/intent/follow?screen_name=codeiumdev)
9-
![License](https://img.shields.io/github/license/Exafunction/codeium.vim)
10-
[![Docs](https://img.shields.io/badge/Codeium%20Docs-09B6A2)](https://docs.codeium.com)
11-
[![Canny Board](https://img.shields.io/badge/Feature%20Requests-6b69ff)](https://codeium.canny.io/feature-requests/)
12-
[![built with Codeium](https://codeium.com/badges/main)](https://codeium.com?repo_name=exafunction%2Fcodeium.vim)
8+
[![Twitter Follow](https://img.shields.io/badge/style--blue?style=social&logo=twitter&label=Follow%20%40windsurf_ai)](https://twitter.com/intent/follow?screen_name=windsurf_ai)
9+
![License](https://img.shields.io/github/license/Exafunction/windsurf.vim)
10+
[![Docs](https://img.shields.io/badge/Windsurf%20Docs-09B6A2)](https://docs.windsurf.com)
11+
[![Canny Board](https://img.shields.io/badge/Feature%20Requests-6b69ff)](https://windsurf.canny.io/feature-requests/)
12+
[![built with Windsurf](https://windsurf.com/badges/main)](https://windsurf.com?repo_name=exafunction%2Fwindsurf.vim)
1313

1414
[![Visual Studio](https://img.shields.io/visual-studio-marketplace/i/Codeium.codeium?label=Visual%20Studio&logo=visualstudio)](https://marketplace.visualstudio.com/items?itemName=Codeium.codeium)
1515
[![JetBrains](https://img.shields.io/jetbrains/plugin/d/20540?label=JetBrains)](https://plugins.jetbrains.com/plugin/20540-codeium/)
1616
[![Open VSX](https://img.shields.io/open-vsx/dt/Codeium/codeium?label=Open%20VSX)](https://open-vsx.org/extension/Codeium/codeium)
1717
[![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)
1818

19-
# codeium.vim
19+
# windsurf.vim
2020

2121
_Free, ultrafast Copilot alternative for Vim and Neovim_
2222

23-
Codeium autocompletes your code with AI in all major IDEs. We [launched](https://www.codeium.com/blog/codeium-copilot-alternative-in-vim) this implementation of the Codeium plugin for Vim and Neovim to bring this modern coding superpower to more developers. Check out our [playground](https://www.codeium.com/playground) if you want to quickly try out Codeium online.
23+
Windsurf autocompletes your code with AI in all major IDEs. We [launched](https://www.windsurf.com/blog/codeium-copilot-alternative-in-vim) this implementation of the Windsurf plugin for Vim and Neovim to bring this modern coding superpower to more developers. Check out our [playground](https://www.windsurf.com/playground) if you want to quickly try out Windsurf online.
2424

2525
Contributions are welcome! Feel free to submit pull requests and issues related to the plugin.
2626

@@ -35,13 +35,13 @@ Contributions are welcome! Feel free to submit pull requests and issues related
3535
1. Install [Vim](https://github.com/vim/vim) (at least 9.0.0185) or [Neovim](https://github.com/neovim/neovim/releases/latest) (at
3636
least 0.6)
3737

38-
2. Install `Exafunction/codeium.vim` using your vim plugin manager of
38+
2. Install `Exafunction/windsurf.vim` using your vim plugin manager of
3939
choice, or manually. See [Installation Options](#-installation-options) below.
4040

41-
3. Run `:Codeium Auth` to set up the plugin and start using Codeium.
41+
3. Run `:Codeium Auth` to set up the plugin and start using Windsurf.
4242

4343
You can run `:help codeium` for a full list of commands and configuration
44-
options, or see [this guide](https://www.codeium.com/vim_tutorial) for a quick tutorial on how to use Codeium.
44+
options, or see [this guide](https://www.windsurf.com/vim_tutorial) for a quick tutorial on how to use Windsurf.
4545

4646
## 🛠️ Configuration
4747

@@ -50,7 +50,7 @@ A few of the most popular options are highlighted below.
5050

5151
### ⌨️ Keybindings
5252

53-
Codeium provides the following functions to control suggestions:
53+
Windsurf provides the following functions to control suggestions:
5454

5555
| Action | Function | Default Binding |
5656
| --------------------------- | ------------------------------ | --------------- |
@@ -62,7 +62,7 @@ Codeium provides the following functions to control suggestions:
6262
| Accept word from suggestion | `codeium#AcceptNextWord()` | `<C-k>` |
6363
| Accept line from suggestion | `codeium#AcceptNextLine()` | `<C-l>` |
6464

65-
Codeium's default keybindings can be disabled by setting
65+
Windsurf's default keybindings can be disabled by setting
6666

6767
```vim
6868
let g:codeium_disable_bindings = 1
@@ -93,7 +93,7 @@ Or in Neovim (using [wbthomason/packer.nvim](https://github.com/wbthomason/packe
9393
```lua
9494
-- Remove the `use` here if you're using folke/lazy.nvim.
9595
use {
96-
'Exafunction/codeium.vim',
96+
'Exafunction/windsurf.vim',
9797
config = function ()
9898
-- Change '<C-g>' here to any keycode you like.
9999
vim.keymap.set('i', '<C-g>', function () return vim.fn['codeium#Accept']() end, { expr = true, silent = true })
@@ -106,9 +106,9 @@ use {
106106

107107
(Make sure that you ran `:Codeium Auth` after installation.)
108108

109-
### ⛔ Disabling Codeium
109+
### ⛔ Disabling Windsurf
110110

111-
Codeium can be disabled for particular filetypes by setting the
111+
Windsurf can be disabled for particular filetypes by setting the
112112
`g:codeium_filetypes` variable in your vim config file (vimrc/init.vim):
113113

114114
```vim
@@ -118,7 +118,7 @@ let g:codeium_filetypes = {
118118
\ }
119119
```
120120

121-
Codeium is enabled by default for most filetypes.
121+
Windsurf is enabled by default for most filetypes.
122122

123123
You can also _disable_ codeium by default with the `g:codeium_enabled` variable,
124124
and enable it manually per buffer by running `:CodeiumEnable`:
@@ -163,32 +163,32 @@ To disable automatic text rendering of suggestions (the gray text that appears f
163163
let g:codeium_render = v:false
164164
```
165165

166-
### Show Codeium status in statusline
166+
### Show Windsurf status in statusline
167167

168-
Codeium status can be generated by calling the `codeium#GetStatusString()` function. In
168+
Windsurf status can be generated by calling the `codeium#GetStatusString()` function. In
169169
Neovim, you can use `vim.api.nvim_call_function("codeium#GetStatusString", {})` instead.
170-
It produces a 3 char long string with Codeium status:
170+
It produces a 3 char long string with Windsurf status:
171171

172172
- `'3/8'` - third suggestion out of 8
173-
- `'0'` - Codeium returned no suggestions
174-
- `'*'` - waiting for Codeium response
173+
- `'0'` - Windsurf returned no suggestions
174+
- `'*'` - waiting for Windsurf response
175175

176-
In normal mode, status shows if Codeium is enabled or disabled by showing
176+
In normal mode, status shows if Windsurf is enabled or disabled by showing
177177
`'ON'` or `'OFF'`.
178178

179179
In order to show it in status line add following line to your `.vimrc`:
180180

181181
```set statusline+=\{…\}%3{codeium#GetStatusString()}```
182182

183-
Shorter variant without Codeium logo:
183+
Shorter variant without Windsurf logo:
184184

185185
```set statusline+=%3{codeium#GetStatusString()}```
186186

187187
Please check `:help statusline` for further information about building statusline in VIM.
188188

189-
vim-airline supports Codeium out-of-the-box since commit [3854429d](https://github.com/vim-airline/vim-airline/commit/3854429d99c8a2fb555a9837b155f33c957a2202).
189+
vim-airline supports Windsurf out-of-the-box since commit [3854429d](https://github.com/vim-airline/vim-airline/commit/3854429d99c8a2fb555a9837b155f33c957a2202).
190190

191-
### Launching Codeium Chat
191+
### Launching Windsurf Chat
192192

193193
Calling the `codeium#Chat()` function or using the `Codeium Chat` command will enable search and indexing in the current project and launch Codeium Chat in a new browser window.
194194

@@ -209,27 +209,27 @@ Note that launching chat enables telemetry.
209209

210210
```lua
211211
{
212-
'Exafunction/codeium.vim',
212+
'Exafunction/windsurf.vim',
213213
event = 'BufEnter'
214214
}
215215
```
216216

217217
### 🔌 vim-plug
218218

219219
```vim
220-
Plug 'Exafunction/codeium.vim', { 'branch': 'main' }
220+
Plug 'Exafunction/windsurf.vim', { 'branch': 'main' }
221221
```
222222

223223
### 📦 Vundle
224224

225225
```vim
226-
Plugin 'Exafunction/codeium.vim'
226+
Plugin 'Exafunction/windsurf.vim'
227227
```
228228

229229
### 📦 packer.nvim:
230230

231231
```vim
232-
use 'Exafunction/codeium.vim'
232+
use 'Exafunction/windsurf.vim'
233233
```
234234

235235
### 💪 Manual
@@ -240,7 +240,7 @@ Run the following. On windows, you can replace `~/.vim` with
240240
`$HOME/vimfiles`:
241241

242242
```bash
243-
git clone https://github.com/Exafunction/codeium.vim ~/.vim/pack/Exafunction/start/codeium.vim
243+
git clone https://github.com/Exafunction/windsurf.vim ~/.vim/pack/Exafunction/start/windsurf.vim
244244
```
245245

246246
#### 💻 Neovim
@@ -249,5 +249,5 @@ Run the following. On windows, you can replace `~/.config` with
249249
`$HOME/AppData/Local`:
250250

251251
```bash
252-
git clone https://github.com/Exafunction/codeium.vim ~/.config/nvim/pack/Exafunction/start/codeium.vim
252+
git clone https://github.com/Exafunction/windsurf.vim ~/.config/nvim/pack/Exafunction/start/windsurf.vim
253253
```

assets/codeium_logo.svg

Lines changed: 0 additions & 32 deletions
This file was deleted.

assets/simple_logo.svg

Lines changed: 0 additions & 34 deletions
This file was deleted.

0 commit comments

Comments
 (0)