项目介绍:Neural
项目概述
Neural是一个旨在提升Vim和Neovim文本编辑体验的插件,它集成了多种机器学习工具,包括ChatGPT、OpenAI等,帮助用户在Vim或Neovim中进行代码自动生成、文本生成以及其他诸多便捷操作。
主要功能
Neural具备以下主要功能:
- 文本生成:使用简单的命令如
:Neural write a story
即可生成文本。 - 多模型支持:兼容多种机器学习模型,让生成更具灵活性。
- 隐私保障:专注于保护用户隐私,避免数据泄露给第三方。
- 代码解释:能够快速请求AI解释代码或段落,使用命令如
:NeuralExplain
。 - 兼容性:适用于Vim 8.0+和Neovim 0.8+,支持Linux、Mac OSX和Windows系统。
- 依赖要求:仅需Python 3.7+。
Neural提供异步流式处理,带来极速的代码生成和补全体验。此外,它还可以在各种文本文档中进行操作,如生成Python文档字符串、修复拼写或语法错误、生成创意等。
插件集成
Neural可与以下插件整合,以提供更好的使用体验:
- nui.nvim - 提供Neovim的UI支持。
- significant.nvim - 提供Neovim的动画标记支持。
- ALE - 用于修正生成代码中的问题。
安装指南
要将Neural添加到您的运行环境中,可以通过以下方式进行安装:
-
Vim
packload
:git clone --depth 1 https://github.com/dense-analysis/neural.git ~/.vim/pack/git-plugins/start/neural
-
Neovim
packload
:git clone --depth 1 https://github.com/dense-analysis/neural.git ~/.local/share/nvim/site/pack/git-plugins/start/neural
-
Windows
packload
:git clone --depth 1 https://github.com/dense-analysis/neural.git ~/vimfiles/pack/git-plugins/start/neural
-
使用 vim-plug:
Plug 'dense-analysis/neural'
-
使用 Vundle:
Plugin 'dense-analysis/neural'
使用方法
为Neural配置一个第三方的机器学习工具,让其可以与OpenAI等交互。可以通过获取OpenAI API密钥,并在Vim或Lua配置中配置该密钥。例如:
-
Vimscript配置:
let g:neural = { \ 'source': { \ 'openai': { \ 'api_key': $OPENAI_API_KEY, \ }, \ }, \}
-
Lua配置:
require('neural').setup({ source = { openai = { api_key = vim.env.OPENAI_API_KEY, }, }, })
尝试输入:Neural say hello
,如果成功,机器学习工具将在当前缓冲区中向你问好。键入:help neural
可以查看完整文档。
命令说明
:NeuralExplain
:用于请求Neural解释代码或文本。可通过选择目标并运行该命令实现。:NeuralStop
:停止Neural的工作。默认情况下Ctrl+C可用于停止命令。
鸣谢
Neural由Anexon创建,并由Dense Analysis团队维护。特别感谢w0rp、Munif Tanjim和Luis Poloto的贡献。
免责声明
Neural生成的所有输入数据将被发送至第三方服务器以查询机器学习模型。请在将生成代码用于生产系统时仔细评估其正确性,并建议使用ALE等工具进行代码检验。
许可协议
Neural采用MIT许可协议发布,详情请见LICENSE。