Install

The plugin lives in this repository at editors/vim-org2/.

For Vim 8+ native packages:

git clone https://github.com/aviaviavi/org2.git ~/.vim/pack/plugins/start/org2

Add the plugin runtime directory to your Vim config:

set runtimepath^=~/.vim/pack/plugins/start/org2/editors/vim-org2
filetype plugin indent on
syntax enable

For Neovim, use the equivalent package path, for example ~/.local/share/nvim/site/pack/plugins/start/org2, and point runtimepath at its editors/vim-org2 directory.

Generate help tags after installing:

:helptags ~/.vim/pack/plugins/start/org2/editors/vim-org2/doc

Then read :help org2.

Current features

• *.org2 filetype detection

• syntax highlighting for headings, TODO states, planning lines, drawers, links, blocks, tables, and comments

• folding by heading level

• list/property folding helpers

• <Tab> fold toggle

CLI pairing

The Vim plugin does not yet wrap the Org2 CLI. Use the CLI directly for agenda, roam, formatting, lint, export, and publishing workflows:

org2 agenda --dir /path/to/notes --recursive
org2 fmt --dir /path/to/notes --recursive --check
org2 roam graph --dir /path/to/notes --recursive

Limitations

• no dedicated agenda pane in Vim yet

• no built-in keymap for TODO/planning edits yet

• no LSP wiring is bundled with the Vim plugin yet

For the most complete editor workflow today, use VS Code or the macOS Workspace.