Skip to content

Latest commit

 

History

History

README.md

files-widget

In-terminal file browser and diff viewer widget for Pi. Navigate files, view diffs, select code, and send comments to the agent without leaving the terminal and without interrupting your agent.

Install

Quick install (Pi package manager):

pi install npm:@tmustier/pi-files-widget

Required deps (needed for /readfiles):

# macOS (Homebrew)
brew install bat git-delta glow

# Ubuntu/Debian
sudo apt-get install -y bat git-delta glow
pi install git:github.com/tmustier/pi-extensions

Then add to ~/.pi/agent/settings.json:

{
  "packages": [
    {
      "source": "git:github.com/tmustier/pi-extensions",
      "extensions": ["files-widget/index.ts"]
    }
  ]
}

Local clone:

Add to your Pi extensions list:

{
  "extensions": [
    "~/pi-extensions/files-widget"
  ]
}

If you prefer symlinking into ~/.pi/agent/extensions:

ln -sfn ~/pi-extensions/files-widget ~/.pi/agent/extensions/files-widget

Then reference it in your settings:

{
  "extensions": [
    "~/.pi/agent/extensions/files-widget"
  ]
}

Dependencies (required)

  • bat: syntax highlighting
  • delta: formatted diffs
  • glow: markdown rendering

The /readfiles browser requires these tools and will refuse to open until they are installed.

Commands

  • /readfiles - open the file browser
  • /review - open tuicr review flow
  • /diff - open critique (bunx critique)

Review/Diff Dependencies

brew install agavra/tap/tuicr
brew install oven-sh/bun/bun
  • tuicr is required for /review
  • bun is required for /diff

If missing, /review or /diff will show a clear install prompt.

Browser Keybindings

  • j/k or ↑/↓: move
  • Enter: open file / expand folder
  • h/l or ←/→: collapse/expand folder
  • PgUp/PgDn: page up/down
  • c: toggle changed-only view
  • ] / [: next/prev changed file
  • /: search (type to filter, Esc to exit)
  • + / -: increase/decrease browser height
  • q: close

Viewer Keybindings

  • j/k or ↑/↓: scroll
  • PgUp/PgDn: page up/down
  • g/G: top/bottom
  • d: toggle diff (tracked files only)
  • /: search (type to search)
  • n / N: next/prev match
  • v: select mode (line selection)
  • c: comment on selected lines (inline prompt)
  • ] / [: next/prev changed file
  • + / -: increase/decrease viewer height
  • q: back to browser

Notes

  • Untracked files show as [UNTRACKED] and open in normal view.
  • Folder LOCs are shown only when the folder is collapsed (expanded folders would duplicate counts).
  • Line counts load asynchronously; the header shows activity while counts are computed.
  • Large non-git folders load progressively and may show [partial] while loading in safe mode.
  • Git status refreshes every 3 seconds while /readfiles is open.