# quickVim

**Repository Path**: liuvvming/quick-vim

## Basic Information

- **Project Name**: quickVim
- **Description**: 全能的代码补全以及脱离鼠标操作的vim配置
- **Primary Language**: Unknown
- **License**: MPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 3
- **Created**: 2021-10-30
- **Last Updated**: 2026-03-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# quickVim
面向 Vim/Neovim、tmux、WezTerm 与 AI 协作辅助的个人开发环境仓库，统一配置、统一安装，兼容 Linux/macOS/Windows，方便在多平台之间携带和复刻开发环境。

```
               _      __  _    ___
  ____ ___  __(_)____/ /_| |  / (_)___ ___
 / __ `/ / / / / ___/ //_/ | / / / __ `__ \
/ /_/ / /_/ / / /__/ ,<  | |/ / / / / / / /
\__, /\__,_/_/\___/_/|_| |___/_/_/ /_/ /_/
  /_/
```

## 核心能力
- 统一 Vim、Neovim、tmux 和 WezTerm 的配置、快捷键与外观，让多终端体验一致。
- 预置 cscope/ctags/Astyle/clang-format 快速跳转与格式化命令，适配 C/C++/Shell 等项目。
- 提供 `install.sh`/`clean.sh` 快速部署与清理脚本，覆盖 Vim、tmux、WezTerm、Neovim 和缓存数据。
- 附带 AI 协作技能 `ai-skills/`，包含需求分析、方案设计、开发计划与提交记录的模板与引导。
- 支持定制扩展：`scripts/` 提供常用辅助（like cscope 生成、format 脚本），`docs/` 提供平台相关文档。

## 目录说明
- `vim-config/`：Vim 核心配置与 Windows 工具（cscope/ctags 的 Windows wrapper）。
- `nvim-config/`：Neovim 用户目录（含插件、settings、模板）。
- `tmux-config/`：tmux 配置与快捷键定义。
- `wezterm-config/`：WezTerm Lua 配置（包含窗口与状态行自定义）。
- `ai-skills/`：Codex/AI 协作技能，提供 `git-commit`、`requirements-analysis`、`solution-outline-design`、`development-planning` 逻辑与模板。
- `scripts/`：辅助脚本（cscope 索引、格式化、技能安装等）。
- `docs/`：说明文档（Windows 说明、`gc-提交变更记录` 等）。
- `install.sh`：一键部署 Vim、tmux、Neovim 与 WezTerm 配置。
- `clean.sh`：清理运行时缓存、备份与插件（支持 `backups`、`nvim cache/plugins/reset` 语义）。

## 安装与部署
### Linux / macOS
```bash
cd quick-vim
source ./install.sh
```
脚本会：
1. 复制 Vim、Neovim、tmux 与 WezTerm 配置到各自的用户目录。
2. 初始化插件依赖并生成 cscope/ctags 索引（若系统已安装）。
3. 预设环境变量，便于跨项目跳转与格式化工具使用。

### Windows
```bash
cd quick-vim
source ./install.sh
```
额外建议：
- 先在 Git Bash 中安装 git、cscope、ctags。
- 将 `vim-config/windows-tools` 加入系统 PATH，确保 `cscope`/`ctags` 命令可在普通终端中访问。

## 清理与恢复
```bash
./clean.sh backups      # 清理 install.sh 生成的旧备份
./clean.sh nvim cache   # 清空 Neovim 缓存与状态
./clean.sh nvim plugins # 卸载插件并清理 mason
./clean.sh nvim reset   # 备份当前配置并重置所有运行数据
```
每个子命令都可以加 `-d <dir>` 指定目标目录（参考 `clean.sh --help`）。

## 常用工具说明
- `scripts/cscope-index.sh`：进入项目目录后 `source scripts/cscope-index.sh`，生成 `cscope.out` 与 `ctags`，配合 Vim/Neovim 的跳转功能。
- `scripts/format-astyle.sh`：默认 `style=linux`，支持无参、`-r`（递归）和 `-f <file>`（指定文件）三种模式；Windows 用户可参考 `vim-config/windows-tools/readme.txt`。
- `scripts/install-to-codex.sh`：批量安装 `ai-skills/` 中的技能到 `~/.codex/skills`，支持 `symlink` 与 `copy`。

## AI 协作技能
`ai-skills/` 目录内的 skill 是 Codex/AI 工作流的输入模板与规则，包含四个阶段：
1. `requirements-analysis`（需求澄清）- 收集问题并生成落库文档。
2. `solution-outline-design`（方案/概要设计）- 提炼可行路线和技术选型。
3. `development-planning`（开发计划）- 拆分任务与验收标准。
4. `git-commit`（提交收口）- 规范提交信息、变更记录与文档。

## 贡献
- 欢迎通过 `pull request` 提交新插件、脚本或 AI 技能模板。
- 改变配置时请优先保持跨平台兼容（特别是 WezTerm、tmux 的主题与快捷键）。
- 变更记录请同步更新 `docs/gc-提交变更记录.md`，保持阶段性提交的可跟踪性。

## 其他资源
- `docs/windows` 中包含 Windows 下的额外说明与工具安装步骤。
- `docs/gc-提交变更记录.md` 记录每次阶段性提交的摘要，按时间倒序增量。