Highlights
- Normal, Insert, Visual, Visual-Line, and Visual-Block editing with motions, operators, text objects, counts, registers, dot-repeat, and branching undo.
- Split windows with independent cursors and viewports, mouse interaction, scrollbars, and persistent resizing.
- Editable two-file diffs with aligned scrolling and undoable hunk transfers.
- Tree-sitter highlighting and rendered Markdown with heading hierarchy and source-preserving inline HTML/custom wrappers.
- LSP diagnostics, completion, hover, definitions, inlay hints, document outline, Health reporting, and managed language-server installation.
- Generic command, file, buffer, diagnostics, and search pickers.
- A full-screen Explorer workspace with Commander, read-only Git, and Workspaces surfaces.
- Git signs, read-only changed-file navigation with staged/unstaged previews, and focused hunk review/stage/discard.
- GitHub/GitHub Enterprise PR Review with threads, private persistent drafts, explicit review submission, and diff-aware live Copilot handoff.
- External formatting and format-on-save.
- Provider-neutral prompt actions with Claude and GitHub Copilot adapters, plus Copilot popup completion.
- Data-only configuration: editor settings, keymaps, themes, language servers, formatters, and AI choices live in TOML. There is no embedded scripting language.
Platforms
kvim targets Windows, Linux, and macOS. Windows is the primary development platform. It expects a modern terminal emulator with true color and the Kitty or iTerm2 keyboard protocol; legacy and dumb terminals are not supported.
Installation
Every release ships:
- Windows x86_64: signed
kvim-<version>-x86_64-pc-windows-msvc.zip - macOS arm64 and x86_64:
kvim-<version>-<target>.tar.gz - Fedora x86_64 and aarch64:
kvim-<version>-1.<arch>.rpm
Unpack the archive and keep kvim and kvim-copilot-bridge together in a directory on your PATH (both have .exe suffixes on Windows). The companion is used only for live Copilot CLI handoff; ordinary editing works without it. On Fedora, install the RPM with dnf; it also installs kvim-update, which downloads and installs the newest release in place. See docs/fedora.md for the full workflow.
Building from source
kvim is a Cargo workspace containing kvim-core, kvim-tui, the kvim application, and the kvim-copilot-bridge companion. It requires Rust 1.94 or newer.
cargo build --workspace --release
./target/release/kvim path/to/file
./target/release/kvim --goto 42 -- path/to/file
./target/release/kvim --diff -- before.txt after.txtBuilding only package kvim does not build the companion executable. Copy both binaries from the same release directory when installing manually.
Since 0.18.0, --goto <line> opens one file at a positive, 1-based source line, overriding its saved cursor position. Use -- for literal paths beginning with a dash. Invalid options and extra operands are errors; see command-line startup for the full contract.
The standard repository-wide checks are:
cargo test --workspace
cargo clippy --workspace --all-targets --all-features -- -D warnings
cargo fmt --all -- --checkDocumentation
- docs/lsp.md: language-server configuration and managed installation.
- docs/formatting.md: formatter configuration and format-on-save behavior.
- docs/files.md: the Explorer workspace and file operations.
- docs/git.md: changed-file navigation, Git signs, and hunk review.
- docs/review.md: PR Review, enterprise authentication, comments, drafts, and explicit publication.
- docs/markdown.md: rendered headings, inline HTML, custom wrappers, and source-preserving editing.
- docs/spell-check.md: spell checking.
- docs/copilot.md: Copilot installation, authentication, completion, and privacy boundary.
- docs/ai.md: prompt-provider selection, Claude setup, and transmitted data.
- docs/kterm.md: cooperative split navigation between kvim and Kterm panes.
- docs/debugging.md: logging and troubleshooting.
- docs/third-party-notices.md: vendored/generated-data attribution.
Non-goals
- Plugin systems, dynamic loading, Vimscript, or another embedded language.
- A general-purpose Ex implementation beyond the supported fixed commands.
- A GUI or legacy-terminal compatibility layer.
- A full Git client for branching, merging, or rebasing.
- Automatic AI-driven commits or filesystem/repository mutation.