Project Icon

win-vind

将Windows界面Vim化的开源工具

win-vind是Windows平台上的开源工具,实现了命令行与图形界面的混合系统。它可让用户使用Vim风格的方式操作Windows界面,支持Vim式的配置和模式。内置多种命令,无需复杂脚本即可自定义。作为便携单文件程序,win-vind能通过命令行执行界面操作,为用户提供类似Vim的Windows操作方式。

Coverity Scan Build Status

What is this?

win-vind provides a lightweight hybrid UI system of CUI and GUI for Windows.
By installing this tool, you will be able to control the Windows GUI in the same way as Vim.

1. Vim-user friendly.

All configuration methods and mode concepts are derived from Vim, allowing for Vim-like UI operation.
Vim users only need to understand win-vind's macro features and additional mode concepts with little learning cost.

2. There are many useful built-in commands.

You don't have to worry about complicated scripts and dependencies like with traditional key binding tools.
You can freely create user-defined commands by combining low-level optimized built-in commands.

3. Very portable and fully open source.

win-vind is a small single binary with no dependencies that runs with user permissions.
It is also available from the command line as a command for UI operations like $ win-vind -c "ggyyGp".

Top Feature Demo


Installation

win-vind supports a variety of installation methods.

Chocolatey

$ choco install win-vind

winget

$ winget install win-vind

Scoop

This has been added to Scoop Extras thanks to contributors and is automatically updated by the autoupdate feature of scoop.

$ scoop bucket add extras
$ scoop install win-vind

Executable Installer

Portable Zip

Usage

Usage is mainly described in easy-to-read documentation pages with plenty of diagrams. Here, only a sample .vindrc is shown below. As you can see, it is Vim user-friendly.

The file is located at C:\Users\[USERNAME]\.win-vind\.vindrc

.vindrc sample

" Choose the version of {tiny, small, normal, big, huge}.
version normal

" Change parameters
set shell = cmd
set cmd_fontsize = 14
set cmd_fontname = Consolas
set easyclick_bgcolor=E67E22
set easyclick_fontcolor=34495E

" Map capslock to ctrl.
imap <capslock> {<ctrl>}

" Define useful shortcuts
inoremap <ctrl-shift-f> <easyclick><click_left>
inoremap <ctrl-shift-m> <gridmove><click_left>
inoremap <ctrl-shift-s> <switch_window><easyclick><click_left>

" Register application launchers
noremap <ctrl-1> :! gvim<cr>
noremap <ctrl-2> :e http://example.com<cr>

" Define macros like Vim
enoremap t ggyyGp

" Apply auto-commands
autocmd AppLeave * <to_insert>
autocmd AppEnter,EdiNormalEnter vim.exe <to_resident>

Default Mappings

win-vind has many features, but you can use a simpler one for your purposes by putting the version command at the beginning of your .vindrc. If you want to use tiny version, write the following. It is important to note that nothing but comments can be written before the version command. If you do not write the version command, huge will be loaded.

" Only comments can be written in here.
version tiny
" Any command can be written from.
" For example
set shell = cmd
TierSupported Features
tiny+mouse +syscmd
small+mouse +syscmd +window +process
normal+mouse +syscmd +window +process +vimemu
big+mouse +syscmd +window +process +vimemu +hotkey +gvmode
huge+mouse +syscmd +window +process +vimemu +hotkey +gvmode +experimental

Following Vim, there are five tiers.

  • tiny has minimal commands for mouse moving and clicking from the keyboard (e.g., GridMove and EasyClick).
  • small allows more flexible handling of window controls and process launches, etc.
  • normal has Vim emulation mappings and allows text editing in text areas, etc.
  • big adds several hotkeys that redefine some of the shortcut keys in Windows to operate Windows with more Vim-like ways. It also provides GUI Visual Mode (+gvmode), which allows for holding down the mouse.
  • huge allows win-vind to have experimental features for more complex operations.

For more information on default mappings, please visit our website.

Known Issues

  • EasyClick does not seem to work properly for some applications on older Windows 10 before 1803. The cause is not known, but we have confirmed that it works after 1909. (#11)

  • Windows 10/11 Single Language does not seem to be able to map toggle keys such as <Capslock>. (#40)

  • If you want to use word motion (e.g. w, B, e) in MS Office Word, it is recommended to disable Use smart paragraph selection.

Build

All you have to do is install cmake, Visual Sudio and Windows SDK, then do the following.

$ cmake -B build
$ cmake --build build
$ ./build/Debug/win-vind.exe

If you want to build with MinGW or create an installer, see here.

Test

Tests can be run using ctest and python.

Unit Test

Run source code level tests.

$ cd tests
$ cmake -B build unit
$ cmake --build build
$ ctest -C Debug --test-dir build --output-on-failure
$ cd ..

Runtime Test

Runtime tests check the behavior of the built binaries.

$ cd tests
$ python runtime/test.py "../bin_64/win-vind/win-vind.exe"  # Specifies the binary for release.
$ cd ..

See this document for details.

Contribute

If you would like to contribute to win-vind, see CONTRIBUTING.md.

The project is managed with GitHub Projects.

Similar Projects

License

This software is provided by pit-ray under the MIT License.

项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。

Project Cover

问小白

问小白是一个基于 DeepSeek R1 模型的智能对话平台,专为用户提供高效、贴心的对话体验。实时在线,支持深度思考和联网搜索。免费不限次数,帮用户写作、创作、分析和规划,各种任务随时完成!

Project Cover

白日梦AI

白日梦AI提供专注于AI视频生成的多样化功能,包括文生视频、动态画面和形象生成等,帮助用户快速上手,创造专业级内容。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

讯飞绘镜

讯飞绘镜是一个支持从创意到完整视频创作的智能平台,用户可以快速生成视频素材并创作独特的音乐视频和故事。平台提供多样化的主题和精选作品,帮助用户探索创意灵感。

Project Cover

讯飞文书

讯飞文书依托讯飞星火大模型,为文书写作者提供从素材筹备到稿件撰写及审稿的全程支持。通过录音智记和以稿写稿等功能,满足事务性工作的高频需求,帮助撰稿人节省精力,提高效率,优化工作与生活。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术,为商家提供一键生成商品图和营销文案的服务,显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台,让商品第一时间被种草。

Project Cover

Trae

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

Project Cover

AIWritePaper论文写作

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号