pi-side-preview
v0.1.1
Published
Right-side file and image preview extension for pi.
Maintainers
Readme
pi-side-preview
Right-side file, code, and image preview extension for pi.
Features
- Opens text and code files in a right-side overlay preview.
- Keeps pi's input editor usable while the preview is open.
- Syntax highlighting for common file types through pi's Markdown/code renderer.
- Opens images (
png,jpg,jpeg,gif,webp) in a full custom view so terminal inline images can render correctly. - Remembers preview width/height between openings in the current pi process.
- Resizable preview width and height.
- Mouse wheel scrolling, with a toggle for native terminal text selection.
- Copy visible text or the entire text file to clipboard on macOS via
pbcopy. - Configurable open shortcuts and in-preview keys.
Install
From npm:
pi install npm:pi-side-previewFrom GitHub/Git:
pi install git:github.com/samo33ddd/pi-side-previewWith a pinned tag or branch:
pi install git:github.com/samo33ddd/[email protected]From a local checkout:
pi install /path/to/pi-side-previewFor development/testing without installing:
pi -e /path/to/pi-side-previewAfter installing or editing the extension, run:
/reloadCommands
Open a file/image preview:
/side-preview <path>If no path is passed, the extension tries the first line of the clipboard, then asks for a path.
Configure global shortcut(s) used to open/toggle the preview:
/side-preview-bind show
/side-preview-bind reset
/side-preview-bind ctrl+alt+o ctrl+shift+oChanging open shortcuts requires /reload.
Configure keys used inside the preview:
/side-preview-keys show
/side-preview-keys reset
/side-preview-keys toggleWheel=ctrl+m copyView=ctrl+y copyAll=ctrl+shift+y widthGrow=alt+left widthShrink=alt+right heightShrink=alt+up heightGrow=alt+down close=escapeReopen the preview to apply in-preview key changes.
Default shortcuts
Open/toggle preview:
Ctrl+Shift+OCtrl+Alt+O
Default preview controls:
Ctrl+M: toggle mouse wheel modeCtrl+Y: copy visible viewCtrl+Shift+Y: copy all textAlt+Left/Alt+Right: resize widthAlt+Up/Alt+Down: resize heightEsc: close
Selection and scrolling
By default, mouse wheel mode is enabled for convenient scrolling. Toggle it with Ctrl+M:
- wheel on: scroll the preview with mouse/trackpad wheel;
- wheel off/select: use native terminal mouse selection to copy selected text.
Keyboard copy is also available with Ctrl+Y and Ctrl+Shift+Y for text files.
Config
User config is stored at:
~/.pi/agent/side-preview.json