Skip to content

Home

Jump to bottom
Frank edited this page Jan 30, 2026 · 4 revisions

CupidFM Wiki

Welcome to the CupidFM documentation! CupidFM is a powerful, terminal-based file manager written in C, featuring syntax highlighting, plugin support, and advanced file operations.

Quick Links

Getting Started

Configuration & Customization

Advanced Features

Features

Modern File Management

  • Fast directory navigation with arrow keys
  • File preview with syntax highlighting
  • Archive support (tar, zip, 7z, etc.)
  • MIME type detection

Syntax Highlighting

  • Built-in support for C/C++, Bash, Markdown
  • Extensible with .cupidconf files
  • Monokai color scheme
  • Advanced features: escape sequences, function calls, typedef detection

Plugin System

  • CupidScript scripting language
  • Hooks for key events, directory changes, selection changes
  • Rich API for file operations, editor control, HTTP requests
  • Auto-loading from ~/.cupidfm/plugins/

File Operations

  • Copy/cut/paste with Ctrl+C/X/V
  • Rename with Ctrl+R
  • Delete with confirmation (Ctrl+D)
  • Create files (Ctrl+N) and directories (Shift+N)
  • Edit files in built-in editor (Ctrl+E)

System Requirements

  • OS: Linux or POSIX-compliant system (macOS, *BSD, WSL)
  • Terminal: Any modern terminal with Unicode support
  • Font: Nerd Font recommended for best icon display

Quick Installation

# Install dependencies (Ubuntu/Debian)
sudo apt install build-essential libncurses-dev libmagic-dev libssl-dev \
                 zlib1g-dev libbz2-dev liblzma-dev xclip

# Build
make

# Run
./cupidfm

See Installation for detailed instructions.

Community & Support

Quick Tips

Press F1 to exit
Use Tab to switch between directory and preview panes
Press Ctrl+E to edit files
Press Ctrl+N to create a new file
Press Shift+N to create a new directory

Navigate: Next: Installation →

Clone this wiki locally