Peekly

   ┏━━┓┏━━┓┏━━┓╻┏ ╻  ╻ ╻
   ┣━━┛┣━━ ┣━━ ┣┻┓┃  ┗┳┛
   ╹   ┗━━┛┗━━┛╹ ╹┗━━┛╹

Beautiful markdown viewer for the terminal.

Install

npm install -g peekly

Usage

# Open a file in the interactive viewer
peekly README.md

# Print styled output to stdout (non-interactive)
peekly README.md --static

# Use a specific theme
peekly README.md --theme dracula

# Read from stdin
cat README.md | peekly

# Open the config menu
peekly --config

Themes

• midnight (default) - Dark purple/cyan palette
• dracula - Classic Dracula colors
• nord - Arctic, north-bluish palette
• catppuccin - Soothing pastel theme
• gruvbox - Retro groove colors

Set a theme per-session with --theme <name> or save a default via peekly --config.

Keybindings

| Key | Action | |---|---| | j / k / ↑ / ↓ | Scroll up / down | | h / l / ← / → | Scroll left / right | | d / u | Half page down / up | | g / G | Jump to top / bottom | | 0 | Reset horizontal scroll | | [ / ] | Jump to prev / next heading | | / | Search in document | | n / N | Next / prev search match | | t | Toggle table of contents | | c | Copy nearest code block to clipboard | | ? | Show keybinding help | | q / Esc | Quit |

Configuration

Peekly stores its config at ~/.peekly/config.json. Run peekly --config to open an interactive menu where you can:

• Pick a color theme with live preview
• Choose heading fonts per level (H1-H6)

Options

--help, -h          Show help
--version, -v       Show version
--theme <name>      Color theme
--width <n>         Force output width (default: terminal width)
--config            Interactive config menu
--static            Non-interactive output (for piping)
--no-color          Disable colored output

License

Apache-2.0