Skip to content
TyrnBeta

Project panel

The project panel shows the files and folders of your project. Toggle focus on it with cmd-shift-e, or use the button in the status bar. It opens on the right by default. Set project_panel.dock to "left" to move it.

  • Arrow keys move through entries. right expands a folder and left collapses it.
  • cmd-right expands every folder. cmd-left collapses every folder.
  • space or a single click opens a file in a preview tab. Editing the file, or double-clicking it, makes the tab permanent. enter renames the selected entry, so use space to open.
  • Middle-click opens a file in a permanent tab right away.
  • Hold shift with up or down to mark several entries. Cut, copy, trash and drag then apply to all of them.

Switching to a file in the editor reveals it in the panel. Turn that off with project_panel.auto_reveal_entries. With project_panel.sticky_scroll on (default), parent folders stay pinned at the top as you scroll.

To open files with one click as permanent tabs, set preview_tabs.enable_preview_from_project_panel to false.

Create, rename and move

Right-click an entry for the full list, or use keys.

Task Keybinding
New file cmd-n
New folder alt-cmd-n
Rename enter or f2
Cut, copy, paste cmd-x, cmd-c, cmd-v
Duplicate cmd-d
Move to Trash backspace, or cmd-backspace to skip the prompt
Delete permanently cmd-delete
Undo, redo a file operation cmd-z, cmd-shift-z
Copy path cmd-alt-c
Copy relative path alt-cmd-shift-c
Reveal in Finder alt-cmd-r
Open with the default app ctrl-shift-enter
Search inside the selected folder cmd-alt-shift-f
Compare two marked files alt-d

Pasting a file whose name already exists adds a “copy” suffix. Drag entries to move them, and hold alt while dropping to copy. Drag files in from Finder to copy them into the project. Turn dragging off with project_panel.drag_and_drop.

A new, pasted or dropped file opens automatically. Control that with project_panel.auto_open (on_create, on_paste, on_drop, all true).

Folded folders

When a folder holds only one subfolder, the chain shows as one row such as src/utils/helpers. Right-click and choose Unfold Directory or Fold Directory, or turn folding off with project_panel.auto_fold_dirs.

Git status and diagnostics

  • File names are tinted by git status when project_panel.git_status is true (default). Add a letter badge with project_panel.git_status_indicator.
  • project_panel.show_diagnostics marks files with errors or warnings ("off", "errors", "all"). Add counts with project_panel.diagnostic_badges.
  • The right-click menu has Restore File, View History, Add to .gitignore and permalink options for files in git repositories.

Show, hide and sort

settings.json
{
  "project_panel": {
    "hide_gitignore": false,
    "hide_hidden": false,
    "hide_root": false,
    "file_icons": true,
    "folder_indicator": "icon",
    "sort_mode": "directories_first",
    "sort_order": "default",
    "entry_spacing": "comfortable",
    "indent_size": 20,
    "default_width": 240
  }
}
  • sort_mode is "directories_first", "mixed" or "files_first".
  • sort_order is "default", "upper", "lower" or "unicode".
  • folder_indicator is "icon", "chevron" or "both".
  • hide_hidden hides entries that match the global hidden_files globs (dotfiles by default).
  • file_scan_exclusions removes entries from the panel and from search entirely.

Vim

With Vim mode on, the panel supports hjkl navigation, o to open in a split, t to open permanently, % for a new file and d for a new folder.