Skip to content
Documentation

f:ist Documentation

F:ist (Fist: Interactive Search Tool) is a fast, keyboard-first browser and launcher for your filesystem. It wraps fd, ripgrep, eza, and a zoxide-style jump database in one cohesive, extensible terminal interface.

Apology for this documentation. These pages are an AI-drafted, incomplete scaffold — the prose will be rewritten by hand later.

The main interface

Browse by topic

Getting started

Get up and running with installation, first launch, and core navigation.

Menu & Scripting

User-defined actions, their Lua, and the queue they schedule.

Configuration

Config files, preview presets (lessfilter), the pager, and the matchmaker UI layer.

Mechanics & Extensibility

Shell hooks, the command line, tools, and output formatting.

The mental model

Everything in f:ist happens inside a pane — a filterable, sortable, previewable list of paths — and the stack of panes you've visited:

  • The Nav pane browses a directory.
  • Find, Search, History, Apps, Stash and Custom panes produce lists from different sources (fd, ripgrep, the history database, your app registry, a stash, or any command's output).
  • Undo / Redo (ctrl-z / ctrl-shift-z) walk back and forth through your pane history. There is no way to get lost.
  • The queue holds pending file operations (copy/cut/paste).
  • The menu (ctrl-e) exposes context-aware actions for the current selection.

You rarely switch "modes". Instead you filter what you see (type to fuzzy-match, ctrl-s to show hidden files, ctrl-d to show only directories) and act on the result with one or two keys.

Quick keybinding cheat sheet

ShortcutActionScope
EnterAccept item (cd directory / open file)Everywhere
ctrl-fOpen Find pane (fd recursive filename search)Everywhere
ctrl-rOpen Search pane (rg full-text search)Everywhere
ctrl-gOpen History pane (recents database)Everywhere
ctrl-eOpen Context Menu (actions & tools)Everywhere
ctrl-z / ctrl-shift-zUndo / Redo pane navigationEverywhere
?Toggle file previewEverywhere
alt-hIn-app keybinding helpEverywhere
Need full reference? Run fs :tool show-binds from your shell or check the menu actions chapter for Lua action schemas.