jvim

Terminal-native, AI-first text editor with a markdown-strong knowledge workspace. Opens any text file (markdown, yaml, toml, shell, config, source); first-class markdown features (wikilinks, backlinks, tag index, heading outline) activate automatically on .md. Obsidian's portable data model, Notion-style block editing, Claude-Code-grade AI, Windows-friendly keymap — in a single binary.

Status: Pre-alpha. Design is complete, and main already contains substantial editor, indexing, AI, git, and CLI slices. No user-facing release yet. See docs/roadmap.md and docs/backlog.md.

What is jvim?

jvim is a terminal UI (TUI) text editor for people who live in tmux, ssh, and the command line but want the ergonomics of Obsidian and Notion when they're writing markdown:

• Edits any text file. Markdown is the sweet spot, but the file tree and editor also handle .yaml / .toml / .json / .ini / .env, shell/python/go/rust/ts sources, Makefile / Dockerfile / README, etc. Markdown-specific features (backlinks, tag index, wikilink autocomplete, heading outline) activate only on .md / .markdown.
• Your vault is plain files. No proprietary format, no database lock-in. Any editor can read it.
• Block-style editing — slash commands, inline tags, [[wikilinks]], callouts, tables — without forcing you into modal keybindings.
• AI as a first-class citizen — provider-agnostic (OpenAI-compatible, Anthropic, local Ollama), MCP-based tool use, streaming inline completions.
• Git-first sync — every vault is a git repo by default; AI edits land as reviewable diffs.
• One binary, five platforms — Linux (x64/arm64), macOS (x64/arm64), Windows (x64). Download, chmod +x, run.

Read the full vision in docs/vision.md and the competitive positioning in docs/strategy/.

Why another editor?

Terminal-native knowledge workers today compromise between three bad options — Vim (steep curve, no native notes stack), Obsidian (GUI-only), Notion (cloud lock-in, no terminal). jvim argues a fourth option is overdue. See docs/vision.md.

Installation

Not yet released. Once 0.1 lands, instructions will look like this:

Pre-built binaries (planned)

# Linux / macOS
curl -fsSL https://github.com/jhl-labs/jvim/releases/latest/download/install.sh | sh

# Windows (PowerShell)
iwr -useb https://github.com/jhl-labs/jvim/releases/latest/download/install.ps1 | iex

Build from source (works today for contributors)

git clone https://github.com/jhl-labs/jvim.git
cd jvim
bun install
bun run build:compile   # single-binary output in ./dist/jvim

See docs/design/build-distribution.md for supported targets and checksums.

Quick Tour (planned surface)

jvim                            # open $PWD as a vault
jvim ~/notes                    # open a specific vault
jvim --new-vault ~/work         # scaffold a new vault with templates
jvim doctor                     # config/security self-check
jvim --help                     # full CLI reference

Inside jvim:

| Key | Action | |-----|--------| | Ctrl+P / Ctrl+O | Command palette / open file | | Ctrl+N | New untitled buffer | | Ctrl+W | Close active buffer | | Ctrl+S | Save | | Ctrl+F | Find in file | | Ctrl+T | Replace in file | | Ctrl+Shift+F | Search across vault | | Ctrl+B | Backlinks graph | | Ctrl+C / Ctrl+X / Ctrl+V | Copy / cut / paste | | Ctrl+A | Select all | | Ctrl+Z / Ctrl+Y | Undo / redo | | / | Slash menu (blocks) | | Ctrl+Space | AI inline suggestion | | F10 / Ctrl+K | Settings | | F1 | Help overlay | | F2 | Outline (headings) | | Ctrl+Q | Quit |

Full keymap spec: docs/design/keybindings.md.

Documentation Map

| You want... | Read | |-------------|------| | The 60-second pitch | docs/vision.md | | What it does | docs/prd.md, docs/use-cases.md | | How it's built | docs/architecture.md, docs/trd.md, docs/adr/ | | Roadmap / what's next | docs/roadmap.md, docs/backlog.md | | Security & privacy | SECURITY.md, docs/ops/security-privacy.md | | Obsidian migration | docs/ops/obsidian-compat.md | | Writing plugins | docs/design/plugin-api.md | | CLI recipes (13 subcommands) | docs/cli-examples.md | | Index of all docs | docs/README.md |

Contributing

Start here: CONTRIBUTING.md. Be respectful: CODE_OF_CONDUCT.md.

The project is well past the initial scaffolding phase. For current shipped work and open follow-ups, start with docs/backlog.md, the phase status docs in docs/, and CONTINUE.md only as historical context.

License

jvim Software License — custom proprietary license with free use of the compiled Binaries (install, run, redistribute, integrate, commercial use all permitted) and proprietary source code (reverse engineering prohibited; unauthorized use of source obtained by any means, including accidental disclosure, is strictly forbidden).

Full terms: LICENSE. Summary for end users: public/README.md § License. Third-party components shipped in each release are listed in THIRD_PARTY_NOTICES.md and attached per-release as third-party-notices.txt.

Source-code licensing, partnerships, security reports: [email protected].

Acknowledgements

jvim stands on the shoulders of the Vim, Obsidian, Ink, Bun, and MCP communities. See NOTICE for attribution and THIRD_PARTY_NOTICES.md for component details.