Menu

VS Code

Org2's most complete editor integration today is VS Code.

Install instructions

The extension currently lives in this repository at editors/vscode-org2/.

  1. Build Org2 CLI and repository artifacts:

git clone https://github.com/aviaviavi/org2.git
cd org2
npm ci
npm run build

  1. Install extension dependencies:

cd editors/vscode-org2
npm ci

  1. Install/run the extension:

  • Use VS Code Extension Development Host from this folder, or

  • Package to VSIX and install via Install from VSIX....

  1. Ensure org2 CLI is available:

  • Repo-built fallback is supported, or

  • Provide org2 on your PATH.

For settings and command behavior details, see editors/vscode-org2/README.md and Tooling reference.

Keyboard shortcuts

This list is comprehensive for current default bindings declared in editors/vscode-org2/package.json.

Direct bindings

Linux/WindowsmacOSCommand IDAction
ctrl+alt+tctrl+alt+torg2.toggleTodoToggle TODO status
ctrl+alt+octrl+alt+oorg2.toggleFoldHereToggle fold at cursor
ctrl+alt+dctrl+alt+dorg2.debugFoldingRangesDebug folding ranges
jjcursorDownVisible-line down (with VSCodeVim + org2.vim.visibleLineNavigation=true)
kkcursorUpVisible-line up (with VSCodeVim + org2.vim.visibleLineNavigation=true)

Power keymap

When org2.keymap.power=true (default), prefix is:

  • Linux/Windows: ctrl+;

  • macOS: cmd+;

Then use the second key (or namespace chord).

Agenda

Linux/WindowsmacOSCommand IDAction
ctrl+; a ocmd+; a oorg2.openAgendaOpen agenda
ctrl+; a rcmd+; a rorg2.refreshAgendaRefresh agenda
ctrl+; a fcmd+; a forg2.pickAgendaFilterAgenda filter picker

Roam

Linux/WindowsmacOSCommand IDAction
ctrl+; r bcmd+; r borg2.openBacklinksOpen backlinks pane
ctrl+; r hcmd+; r horg2.roamShowBacklinksByIdShow backlinks for prompted link/ID
ctrl+; r lcmd+; r lorg2.roamCopyIdLinkCopy ID link for current heading/file
ctrl+; r ccmd+; r corg2.roamCopyIdLinkByIdCopy ID link for prompted target
ctrl+; r icmd+; r iorg2.roamInsertBacklinkInsert backlink
ctrl+; r ocmd+; r oorg2.roamOpenIdOpen ID link target
ctrl+; r pcmd+; r porg2.roamOpenBacklinkOpen backlink source (current heading/file)
ctrl+; r gcmd+; r gorg2.roamOpenBacklinkByIdOpen backlink source by prompt
ctrl+; r tcmd+; r torg2.roamDailiesGotoTodayDailies: today
ctrl+; r ycmd+; r yorg2.roamDailiesGotoYesterdayDailies: yesterday
ctrl+; r mcmd+; r morg2.roamDailiesGotoTomorrowDailies: tomorrow
ctrl+; r dcmd+; r dorg2.roamDailiesGotoDateDailies: pick date
ctrl+; r ncmd+; r norg2.roamNodeNewNew roam node
ctrl+; r scmd+; r sorg2.roamDbSyncRoam DB sync

TODO status

Linux/WindowsmacOSCommand IDAction
ctrl+; t tcmd+; t torg2.setTodoStatusSet TODO (args: todo)
ctrl+; t icmd+; t iorg2.setTodoStatusSet IN_PROGRESS (args: in_progress)
ctrl+; t dcmd+; t dorg2.setTodoStatusSet DONE (args: done)
ctrl+; t ccmd+; t corg2.setTodoStatusSet CANCELED (args: canceled)

Planning, archive, capture, export, folding

Linux/WindowsmacOSCommand IDAction
ctrl+; scmd+; sorg2.setScheduledSet SCHEDULED (prompt date)
ctrl+; s tcmd+; s torg2.setScheduledTodaySet SCHEDULED to today
ctrl+; dcmd+; dorg2.setDeadlineSet DEADLINE (prompt date)
ctrl+; d tcmd+; d torg2.setDeadlineTodaySet DEADLINE to today
ctrl+; xcmd+; xorg2.archiveSubtreeArchive subtree
ctrl+; c qcmd+; c qorg2.captureQuickEntryQuick capture
ctrl+; p hcmd+; p horg2.exportCurrentFileHtmlExport current file HTML
ctrl+; p wcmd+; p worg2.exportWorkspaceHtmlExport workspace HTML
ctrl+; 1cmd+; 1editor.foldLevel1Fold level 1
ctrl+; 2cmd+; 2editor.foldLevel2Fold level 2
ctrl+; 3cmd+; 3editor.foldLevel3Fold level 3
ctrl+; 4cmd+; 4editor.foldLevel4Fold level 4

Commands without default keybindings

Available from command palette (Cmd/Ctrl+Shift+P):

  • org2.refreshBacklinks

  • org2.formatWorkspaceCheck

  • org2.formatWorkspaceApply

  • org2.formatCurrentFileCheck

  • org2.formatCurrentFilePreviewDiff

  • org2.formatCurrentFileApply

  • org2.pickAgendaStatusFilter

  • org2.openAgendaItem

  • org2.setTodoTODO

  • org2.setTodoInProgress

  • org2.setTodoDone

  • org2.setTodoCanceled

  • org2.setScheduledTomorrow

  • org2.setScheduledNextWeek

  • org2.setScheduledNextMonth

  • org2.cryptDecryptSubtree

  • org2.cryptEncryptSubtree

  • org2.refileSubtree

  • org2.roamOpenTitle

  • org2.roamShowBacklinks

  • org2.rerunAutoFold

  • org2.debugListLinks