Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Exafunction/codeium.nvim
A native neovim extension for Codeium
https://github.com/Exafunction/codeium.nvim
Last synced: 14 days ago
JSON representation
A native neovim extension for Codeium
- Host: GitHub
- URL: https://github.com/Exafunction/codeium.nvim
- Owner: Exafunction
- License: mit
- Created: 2023-01-29T07:31:06.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-04T20:02:55.000Z (5 months ago)
- Last Synced: 2024-06-07T10:16:18.969Z (5 months ago)
- Language: Lua
- Size: 157 KB
- Stars: 604
- Watchers: 8
- Forks: 47
- Open Issues: 46
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-neovim - Exafunction/codeium.nvim - Free, ultrafast Copilot alternative. Supports LSP and Tree-sitter. (AI / (requires Neovim 0.5))
README
---
[](https://discord.gg/3XFf78nAx5)
[](https://twitter.com/intent/follow?screen_name=codeiumdev)
[](https://docs.codeium.com)
[](https://codeium.canny.io/feature-requests/)
[](https://codeium.com?repo_name=exafunction%2Fcodeium.nvim)
[](https://marketplace.visualstudio.com/items?itemName=Codeium.codeium)
[](https://plugins.jetbrains.com/plugin/20540-codeium/)
[](https://open-vsx.org/extension/Codeium/codeium)
[](https://chrome.google.com/webstore/detail/codeium/hobjkcpmjhlegmobgonaagepfckjkceh)
# codeium.nvim
Native [Codeium](https://www.codeium.com/) plugin for Neovim.
## Contributing
Feel free to create an issue/PR if you want to see anything else implemented.
## Screenshots
[Completion in Action](https://user-images.githubusercontent.com/522465/215312040-d5e91a6b-cffa-48f1-909f-360328b5af79.webm)
## Installation
### [packer.nvim](https://github.com/wbthomason/packer.nvim)
```lua
use {
"Exafunction/codeium.nvim",
requires = {
"nvim-lua/plenary.nvim",
"hrsh7th/nvim-cmp",
},
config = function()
require("codeium").setup({
})
end
}
```
### [lazy.nvim](https://github.com/folke/lazy.nvim)
```lua
{
"Exafunction/codeium.nvim",
dependencies = {
"nvim-lua/plenary.nvim",
"hrsh7th/nvim-cmp",
},
config = function()
require("codeium").setup({
})
end
},
```
## Usage
After installation and configuration, you will need to authenticate with
Codeium. This can be done by running `:Codeium Auth`, copying the token from
your browser and pasting it into API token request.
To use Codeium Chat, execute the `:Codeium Chat` command. The chat will be opened
in your default browser using the xdg-open command.
## Options
- `config_path`: the path to the config file, used to store the API key.
- `bin_path`: the path to the directory where the Codeium server will be downloaded to.
- `api`: information about the API server to use:
- `host`: the hostname. Example: `"codeium.example.com"`. Required when using enterprise mode
- `port`: the port. Defaults to `443`
- `path`: the path prefix to the API server. Default for enterprise: `"/_route/api_server"`
- `portal_url`: the portal URL to use (for enterprise mode). Defaults to `host:port`
- `enterprise_mode`: enable enterprise mode
- `detect_proxy`: enable or disable proxy detection
- `enable_chat`: enable chat functionality
- `workspace_root`:
- `use_lsp`: Use Neovim's LSP support to find the workspace root, if possible.
- `paths`: paths to files that indicate a workspace root when not using the LSP support
- `find_root`: An optional function that the plugin will call to find the workspace root.
- `tools`: paths to binaries used by the plugin:
- `uname`: not needed on Windows, defaults given.
- `uuidgen`
- `curl`:
- `gzip`: not needed on Windows, default implemenation given using powershell.exe Expand-Archive instead
- `language_server`: The path to the language server downloaded from the [official source.](https://github.com/Exafunction/codeium/releases/tag/language-server-v1.1.32)
- `wrapper`: the path to a wrapper script/binary that is used to execute any
binaries not listed under `tools`. This is primarily useful for NixOS, where
a FHS wrapper can be used for the downloaded codeium server.
### [nvim-cmp](https://github.com/hrsh7th/nvim-cmp)
After calling `setup`, this plugin will register a source in nvim-cmp. nvim-cmp
can then be set up to use this source using the `sources` configuration:
```lua
cmp.setup({
-- ...
sources = {
-- ...
{ name = "codeium" }
}
})
```
If you are seeing the `codeium` source as unused in `:CmpStatus`, make sure that `nvim-cmp` setup happens before the `codeium.nvim` setup.
To set a symbol for codeium using lspkind, use the `Codeium` keyword. Example:
```lua
cmp.setup({
-- ...
formatting = {
format = require('lspkind').cmp_format({
mode = "symbol",
maxwidth = 50,
ellipsis_char = '...',
symbol_map = { Codeium = "", }
})
}
})
```
### Workspace Root Directory
The plugin uses a few techniques to find the workspace root directory, which helps to inform the autocomplete and chat context.
1. Call the optional `workspace_root.find_root` function, if provided. This is described below.
2. Query Neovim's built-in LSP support for the workspace root, if `workspace_root.use_lsp` is not set to `false`.
3. Search upward in the filesystem for a file or directory in `workspace_root.paths` that indicates a workspace root.
The default configuration is:
```lua
require('codeium').setup({
workspace_root = {
use_lsp = true,
find_root = nil,
paths = {
".bzr",
".git",
".hg",
".svn",
"_FOSSIL_",
"package.json",
}
}
})
```
The `find_root` function can help the plugin find the workspace root when you are not using Neovim's built-in LSP
provider. For example, this snippet calls into `coc.nvim` to find the workspace root.
```lua
require('codeium').setup({
workspace_root = {
find_root = function()
return vim.fn.CocAction("currentWorkspacePath")
end
}
})
```
## Troubleshooting
The plugin log is written to `~/.cache/nvim/codeium/codeium.log`.
You can set the logging level to one of `trace`, `debug`, `info`, `warn`,
`error` by exporting the `DEBUG_CODEIUM` environment variable.
## Credits
This plugin was initially developed by [@jcdickinson](https://github.com/jcdickinson).