Skip to content

Oil Plugin

Help query: "What does the oil plugin do?" / "How do I use oil in Volt?"

The oil plugin provides directory manipulation buffers inspired by oil.nvim. Open a directory as an editable buffer, preview entries, open splits, cycle sort modes, toggle hidden files/trash, and jump to workspace or git worktree roots.

Package nameoil
Moduleuser/oil.rs

What it does

  • Open directories (including parent and workspace root) as buffers
  • Open entries in the current pane, splits, or a new pane
  • Preview, refresh, cycle sort, toggle hidden/trash
  • Set roots and open git worktrees

Commands

CommandDescription
oil.open-directoryOpens a directory in an oil buffer.
oil.open-parentOpens the parent directory.
oil.open-entryOpens the entry under the cursor.
oil.open-vertical-splitOpens the entry in a vertical split.
oil.open-horizontal-splitOpens the entry in a horizontal split.
oil.preview-entryPreviews the entry under the cursor.
oil.refreshRefreshes the oil buffer.
oil.closeCloses the oil buffer.
oil.open-workspace-rootOpens the workspace root in oil.
oil.set-rootSets the oil root from the current entry.
oil.show-helpShows oil help.
oil.cycle-sortCycles oil sort mode.
oil.toggle-hiddenToggles hidden files.
oil.toggle-trashToggles trash behavior.
oil.git-worktreeOpens a git worktree flow.

Keybindings

ChordCommandScope
g w noil.git-worktreeWorkspace (Normal)

Notes

Most oil chords (Enter, preview, hidden toggle, and similar) come from user/config/oil.yaml defaults rather than package keybindings. Edit that YAML to rebind without rebuilding.

Volt — modal editor platform · docs optimized for in-editor help search