CliFM

The Command Line File Manager

Fast, extensible, lightweight

Linux, Termux (Android), FreeBSD, NetBSD, OpenBSD, MacOS, Haiku, Cygwin | x86, ARM

Downloads · Browse the documentation · Request feature · Report bug

🔸 Brief description
🔸 Introduction video
🔸 Features
🔸 Installation
🔸 Getting started
🔸 Support
🔸 License
🔸 Contributing
🔸 Community

Brief description

CliFM is a Command Line Interface File Manager: all input and interaction is performed via commands. This is its main feature and strength.

Unlike most terminal file managers out there, indeed, CliFM replaces the traditional TUI interface (also known as curses or text-menu based interface) by a command-line interface (CLI),¹ also known as REPL.²

If working with the command-line, your workflow is not affected at all, but just enriched with file management functionalities: automatic files listing, files selection, bookmarks, tags, directory jumper, directory and commands history, auto-cd and auto-open, bulk rename, TAB completion, autosuggestions, and a trash system, among other features. In this sense, CliFM is certainly a file manager, but also a shell extension.

Briefly put, with CliFM the command-line is always already there, never hidden 💪

¹ For more information about these concepts see the resources page .
² For a detailed description consult the introductory section of our Wiki.

CliFM's interface

🎬 Introduction video

Features

Click here to expand

Besides common file operations such as copy, move, remove, etc., CliFM provides the following features:

Specific
- Really CLI-based. No GUI nor TUI at all, but just a command-line
- It can run on the kernel built-in console and even on a SSH or any other remote session
- Highly compatible with old VT102-only terminal emulators (8-colors only and no Unicode support) like Rxvt and Rxvt-based ones. It can run even on an old DEC-VT100 terminal!
- High performance. Incredibly lightweight and fast even on really old hardware
- Short (and even one-character) commands
- Entry list numbers (ELN's) for file names
- Extended color codes for file-types and -extensions
- Files counter for directories and symlinks to directories
- Privacy: Zero data collection and no connection to the outside world at all
- Security: Secure environment and secure commands. See also the stealth mode section
Navigation and file operations
- Bookmarks
- Files tagging
- Files selection (supports both glob and regular expressions and works even across multiple instances of the program)
- Files search (supports both glob and regular expressions)
- copy(-as), move(-as), interactive rename, and open-with functions
- File names cleaner
- Autocommands
- Auto-cd, auto-open, and autols
- Directory jumper, similar to autojump, z.lua, and zoxide
- Fastback function
- Backdir - Quickly change to a parent directory
- A built-in resource opener (supports regular expressions and is able to discern between GUI and non-GUI environments)
- A built-in Freedesktop-compliant trash system
- Files filter
- Up to eight workspaces
- Eleven sorting methods
- Bulk rename and bulk remove
- Batch links
- Copy files to your smart phone (plugin)
- Archiving and compression support (including Zstandard and ISO 9660)
- Symlinks editor
- Remote file systems management
- Mount/unmount storage devices
- Advanced Copy support (just cp and mv with a nice progress bar)
- Directory history map to keep in sight previous, current, and next entries in the directory history list
Shell
- Auto-suggestions
- TAB completion (including an FZF mode)
- Syntax highlighting
- Warning prompt for invalid command names
- Fused parameters for ELN's
- Fuzzy completion for file names and paths
- Wildcards expansion via TAB (s *.[ch]<TAB>)
- File types expansion via TAB (=l<TAB> to list all symlinks in the current dir)
- Bash-like quoting system
- Shell commands execution
- Sequential and conditional commands execution
- Directory and commands history
- Glob and regular expressions (including inverse matching)
- Aliases
- Logs
- Prompt and profile commands (run commands with each new prompt or at program startup)
Modes
- Stealth mode: Leave no trace on the host system. No file is read, no file is written.
- Light mode (just in case it is not fast enough for you)
- Resource opener
- Disk usage analyzer mode
- Files lister (ls-mode)
Customization
- User profiles
- Customizable keyboard shortcuts
- Theming support (more than a dozen color schemes)
- Prompt customization
- Four customizable keybindings for custom plugins
- Compile features in/out
Misc
- Plugins
- Files preview (via BFG, a native file previewer, but including support for Ranger's scope.sh and pistol as well)
- Icons support, including emoji-icons 😏
- Git integration
- Unicode suppport
- Disk usage
- CD on quit and file picker functions
- A built-in pager for files listing
- Read and list files from STDIN (standard input)

Auto-suggestions in action

For a detailed explanation of each of these features, follow the corresponding links or consult the Wiki.

Changelog

Click here to expand

Development:
- NEW: Flat-view for the fzfsel plugin via the -f option
- NEW: Improved VT100 compatibility via the --vt100 switch
- NEW: Cygwin support
- NEW: Improved performance/portability of the suggestions system: no more slow/non-portable CPR-CUP escape sequences! These were replaced by 100% made in-house cursor position calculation plus basic/portable escape sequences: CUU, CUD, CUF, and CUB.
version 1.7 (Elaine):
- Configuration files renamed from .cfm to .clifm (avoid conflict with ColdFusion files)
- Ctrl-l added for screen refresh
- cc command removed to avoid conflicts with /bin/cc (use colors instead)
- --std-tab-comp option renamed to --stdtab (to match --fzytab and --smenutab options)
- Files encryption/decryption plugins
- Allow turning interactivity off when copying, moving, and/or removing files
- Termux support
- Customize properties fields in long view mode
- Desktop notifications
- Virtual directories
- A better organized configuration file
- Improved logs system
- smenu support for TAB completion
- FZY support for TAB completion
- Operate on specific bookmarks
- Named workspaces
version 1.6 (Guybrush):
- ELN's color defaults now to cyan
- --no-folders-first and --folders-first options renamed to --no-dirs-first and --dirs-first respectively. In the same way, the folders-first command was renamed to dirs-first.
- PromptStyle option renamed as Notifications (taking true and false as values)
version 1.5 (Nano):
- Prompt, WarningPromptStr, DividingLine, and FfzTabOptions options were moved from the config file to the color scheme file to get a centralized and single theming file. However, to keep backwards compatibility, the old location is still recognized. If any of these options is found in the color scheme file, values taken from the main configuration file will be overriden.
- The warning prompt color is set now via escape codes (exactly as the regular prompt). The wp color code is used now only for the input text color of the warning prompt.
version 1.4 (Alma):
- In order to make Lira more powerful (it can now match entire file names instead of just file extensions) it was necessary to introduce a little syntax modification in its configuration file.

Installation

Consult the installation page.

Getting started

To start using CliFM you don't need to learn anything new: the usual shell commands will just work. However, there is much more than just shell commands...
✓ The help command gives you a quick introduction to CliFM: once in the CliFM prompt, type help or ?.
✓ Type help and then press TAB to get a list of help topics. Select the one you want and press Enter.
✓ To jump into the COMMANDS section in the manpage, simply enter cmd or press F2.
✓ Press F1 to access the full manpage and F3 to access the keybindings help-page.
✓ To get help about some specific command just type CMD -h. For instance, s -h.

You can also take a look at some of these basic usage-examples to get you started.
For a complete description please consult our Wiki.

Support

CliFM is C99 and POSIX-1.2008 compliant (if compiled with the _BE_POSIX flag). Consult the compilation page.
It works on Linux, Termux (Android), FreeBSD, NetBSD, OpenBSD, MacOS, Haiku, and Cygwin, on x86 and ARM architectures.

License

This project is licensed GPL version 2 (or later).
See the LICENSE file for details.

Contributing

Yes. Please see our contribution guidelines for details. at Hosted Weblate.

Community

Join our Gitter discussion room and let us know what you think: ideas, comments, observations and questions are always welcome.
The Discussions section of this repo is also open to input.

vaginessa / clifm Goto Github PK

clifm's Introduction