---

codeium.el

免费、超快速、可扩展的 Emacs AI 代码补全工具

Codeium 可在各大主流 IDE 中利用 AI 自动补全代码。我们已推出适用于 Emacs 的 Codeium 插件实现，旨在将这一现代化的编码利器带给更多开发者。如果您想快速在线体验 Codeium，可以访问我们的 游乐场。

codeium.el 提供了一个 completion-at-point-functions 后端，专为与前端配合使用而设计，例如 company-mode、corfu，或 Emacs 内置的 completion-at-point。

codeium.el 是一个开源客户端，主要由 Alan Chen 编写。它使用专有的语言服务器二进制文件，目前会自动从 这里 下载（需确认）。您可以使用 M-x codeium-diagnose 查看将发送到本地语言服务器的 API 和字段，以及运行本地语言服务器的命令。通过自定义 codeium-api-enabled、codeium-fields-regexps 和 codeium-command 来进行相应调整。

欢迎贡献！请随时提交与该包相关的拉取请求和问题。

🚀 开始使用

1. 安装 Emacs。请确保您运行的 Emacs 版本已编译了 libxml2。您可以在 Emacs Lisp 中使用 (libxml-available-p) 函数来检查：如果当前 Emacs 会话中可用 libxml2，该函数将返回 t（真）。

2. 安装您选择的文本补全前端。（我们推荐 company-mode 或 corfu。）

3. 使用您喜欢的 Emacs 包管理器或手动方式安装 Exafunction/codeium.el。详情请参阅下方的 安装选项。

4. 运行 M-x codeium-install 来设置该包。

5. 将 codeium-completion-at-point 添加到您的 completion-at-point-functions 列表中。

6. 开始查看建议吧！

🛠️ 配置

您可以通过 M-x customize 查看所有自定义选项。 （更详细的文档即将发布！）

以下是一个配置示例：

;; 我们建议使用 use-package 来组织你的 init.el 文件
(use-package codeium
    ;; 如果你使用 straight
    ;; :straight '(:type git :host github :repo "Exafunction/codeium.el")
    ;; 否则，请确保 codeium.el 文件位于 load-path 中

    :init
    ;; 全局启用
    (add-to-list 'completion-at-point-functions #'codeium-completion-at-point)
    ;; 或者在某个钩子中启用
    ;; (add-hook 'python-mode-hook
    ;;     (lambda ()
    ;;         (setq-local completion-at-point-functions '(codeium-completion-at-point))))

    ;; 如果你想使用多个补全后端，可以使用 cape (https://github.com/minad/cape)：
    ;; (add-hook 'python-mode-hook
    ;;     (lambda ()
    ;;         (setq-local completion-at-point-functions
    ;;             (list (cape-capf-super #'codeium-completion-at-point #'lsp-completion-at-point)))))
    ;; 一个异步的 company 后端即将推出！

    ;; codeium-completion-at-point 是自动加载的，但你也可以
    ;; 选择设置一个定时器，这可能会加快速度，因为
    // codeium 的本地语言服务器大约需要 0.2 秒才能启动
    ;; (add-hook 'emacs-startup-hook
    ;;  (lambda () (run-with-timer 0.1 nil #'codeium-init)))

    ;; :defer t ;; 如果需要懒加载
    :config
    (setq use-dialog-box nil) ;; 不使用弹出框

    ;; 如果你不想通过 customize 来保存 API 密钥
    ;; (setq codeium/metadata/api_key "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")

    ;; 在模式行显示 codeium 状态
    (setq codeium-mode-line-enable
        (lambda (api) (not (memq api '(CancelRequest Heartbeat AcceptCompletion)))))
    (add-to-list 'mode-line-format '(:eval (car-safe codeium-mode-line)) t)
    ;; 或者使用更丰富的模式行
    ;; (add-to-list 'mode-line-format '(-50 "" codeium-mode-line) t)

    ;; 使用 M-x codeium-diagnose 可以查看将发送到本地语言服务器的 API 和字段
    (setq codeium-api-enabled
        (lambda (api)
            (memq api '(GetCompletions Heartbeat CancelRequest GetAuthToken RegisterUser auth-redirect AcceptCompletion))))
    ;; 你也可以为单个缓冲区设置配置，例如：
    ;; (add-hook 'python-mode-hook
    ;;     (lambda ()
    ;;         (setq-local codeium/editor_options/tab_size 4)))

    ;; 你可以覆盖所有的 codeium 配置！
    ;; 例如，我们建议限制发送给 codeium 的字符串长度以提高性能
    (defun my-codeium/document/text ()
        (buffer-substring-no-properties (max (- (point) 3000) (point-min)) (min (+ (point) 1000) (point-max))))
    ;; 如果你更改了文本，你也应该相应地调整光标偏移量
    ;; 注意：这是以 UTF-8 编码的字节数来衡量的
    (defun my-codeium/document/cursor_offset ()
        (codeium-utf8-byte-length
            (buffer-substring-no-properties (max (- (point) 3000) (point-min)) (point))))
    (setq codeium/document/text 'my-codeium/document/text)
    (setq codeium/document/cursor_offset 'my-codeium/document/cursor_offset))

以下是 company-mode 的一个配置示例。

(use-package company
    :defer 0.1
    :config
    (global-company-mode t)
    (setq-default
        company-idle-delay 0.05
        company-require-match nil
        company-minimum-prefix-length 0

        // 只显示预览
        company-frontends '(company-preview-frontend)
        // 也可以同时显示下拉菜单
        // company-frontends '(company-pseudo-tooltip-frontend company-preview-frontend)
        ))

你也可以通过 Elisp 访问 codeium.el；以下是一个返回 GetCompletions 请求完整响应的代码片段：

(cl-letf*
    (
        // 创建一个新的 codeium-state（即一个新的本地语言服务器进程）
        // 大约需要 0.2 秒；尽量避免频繁创建
        (state (codeium-state-make :name "example"))
        ((codeium-config 'codeium/document/text state) "def fibi(n):")
        ((codeium-config 'codeium/document/cursor_offset state) 12)
        ((codeium-config 'codeium-api-enabled state) (lambda (api) (eq api 'GetCompletions))))
    (unwind-protect
        (progn
            (codeium-init state)
            // 使用 codeium-request 发起异步请求
            (cdr (codeium-request-synchronously 'GetCompletions state nil)))
        // 清理临时文件并终止进程。该状态下的任何计划中的异步请求都将被取消。
        (codeium-reset state)))

请注意，除了其他信息外，你还会得到每个标记的概率！我们非常欢迎你提交 PR 或开发自己的包来利用这些概率！

🔓 身份验证

如果你想自动进行身份验证，可以将你的 codeium API 密钥添加到 auth-sources 中。例如：

~/.authinfo.gpg:

machine codeium.com login apikey secret <insert_api_key_here>

💾 安装选项

➡️ straight.el

(straight-use-package '(codeium :type git :host github :repo "Exafunction/codeium.el"))

💀 Doom Emacs

在 packages.el 中添加以下内容：

(package! codeium :recipe (:host github :repo "Exafunction/codeium.el"))

然后将示例配置添加到你的 config.el 文件中。

💪 手动安装

运行以下命令：

git clone --depth 1 https://github.com/Exafunction/codeium.el ~/.emacs.d/codeium.el

然后在你的 ~/.emacs.d/init.el 文件中添加以下内容：

(add-to-list 'load-path "~/.emacs.d/codeium.el")

你是否为其他 Emacs 环境（如 Spacemacs）提供了可用的安装方法？请提交 PR，以便我们与大家分享！

自托管企业版

如果你正在使用 Windsurf 自托管企业版部署插件，你需要在你的 vim 配置文件中设置 Portal 和 API 的 URL，以便 Windsurf 知道将补全请求发送到哪里。在你的 ~/.emacs.d/init.el 文件中添加以下行：

(setq-default codeium-enterprise t)
(setq-default codeium-portal-url "<PORTAL URL>")
(setq-default codeium-api-url "<PORTAL URL>/_route/api_server")

Codeium.el 快速上手指南

Codeium.el 是一款免费、超快且可扩展的 Emacs AI 代码补全工具。它通过本地语言服务器提供智能代码建议，支持与公司模式（company-mode）、Corfu 等前端配合使用。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

1. Emacs 版本：安装最新版 Emacs。
   • 关键依赖：Emacs 必须编译时包含 libxml2 支持。
   • 验证方法：在 Emacs 中运行 (libxml-available-p)，若返回 t 则表示支持。
2. 补全前端：安装并配置任意一种文本补全前端，推荐使用：
   • company-mode
   • corfu

安装步骤

您可以选择以下任一方式进行安装：

方式一：使用 straight.el (推荐)

(straight-use-package '(codeium :type git :host github :repo "Exafunction/codeium.el"))

方式二：Doom Emacs

在 packages.el 中添加：

(package! codeium :recipe (:host github :repo "Exafunction/codeium.el"))

并在 config.el 中加入后续的配置代码。

方式三：手动安装

1. 克隆仓库：

   git clone --depth 1 https://github.com/Exafunction/codeium.el ~/.emacs.d/codeium.el
   

2. 在 ~/.emacs.d/init.el 中添加加载路径：

   (add-to-list 'load-path "~/.emacs.d/codeium.el")
   

基本使用

安装完成后，请在您的配置文件（如 init.el）中进行如下基础配置以启用功能：

1. 基础配置示例

建议使用 use-package 管理配置：

(use-package codeium
    :init
    ;; 全局启用 Codeium 补全后端
    (add-to-list 'completion-at-point-functions #'codeium-completion-at-point)
    
    :config
    ;; 禁用弹窗对话框
    (setq use-dialog-box nil)
    
    ;; 可选：在模型栏显示状态
    (setq codeium-mode-line-enable
        (lambda (api) (not (memq api '(CancelRequest Heartbeat AcceptCompletion)))))
    (add-to-list 'mode-line-format '(:eval (car-safe codeium-mode-line)) t))

2. 初始化插件

重启 Emacs 或重新加载配置后，运行以下命令完成首次设置（会自动下载本地语言服务器二进制文件）：

M-x codeium-install

3. 身份验证

首次使用时需绑定 API Key。您可以通过以下方式之一进行认证：

• 交互式认证：运行 M-x codeium-auth 按提示操作。
• 自动认证：将 API Key 添加到 auth-sources (例如 ~/.authinfo.gpg)：

  machine codeium.com login apikey secret <您的_API_Key>
  

  或者直接在配置文件中设置（不推荐硬编码密钥）：

  (setq codeium/metadata/api_key "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")
  

4. 开始使用

配置完成后，在编写代码时即可看到 AI 提供的补全建议。

• 如果使用 company-mode，建议配合以下配置以获得最佳体验（仅显示预览或下拉列表）：

  (setq-default
      company-idle-delay 0.05
      company-require-match nil
      company-minimum-prefix-length 0
      company-frontends '(company-preview-frontend))
  

提示：如需查看诊断信息或当前发送的语言服务器命令，可运行 M-x codeium-diagnose。