facad(1)
| FACAD(1) | User Commands | FACAD(1) |
NAME
facad - modern, colorful directory listing tool for the command line
SYNOPSIS
facad [OPTION]... [FILE]...
DESCRIPTION
facad is an advanced directory listing tool that provides a colorful and intuitive display of file and directory information in the terminal. It enhances the file management experience with a blend of functionality and simplicity.
Key features include:
- •
- Intuitive file type representation using emojis
- •
- Sorted output with directories listed first
- •
- Multi-column layout for quick directory analysis
- •
- Support for symlinks and executable files
- •
- Git integration for repositories (in default mode)
- •
- Detailed analytics for directories
- •
- Unicode-aware formatting
OPTIONS
- -h, –help
- Display help information and exit.
- -v, –version
- Output version information and exit.
- -l, –long
- Display detailed directory listing, including file sizes, permissions, modification times, and other attributes.
- -a, –analytics
- Display directory analytics, including total size, file counts, depth analysis, and information about largest and newest files.
DISPLAY FORMATS
Default Display
The default display shows a grid layout with the following information:
- •
- File/directory name
- •
- File type emoji
- •
- Git status (if in a Git repository)
Files are sorted with directories first, then by file extension and name.
Long Listing (-l)
The long listing format provides detailed information:
-
SIZE MOD_TIME OWNER PERMISSIONS TYPE NAME
- SIZE
- Human-readable file size
- MOD_TIME
- Last modification time (relative to current time)
- OWNER
- File owner’s username
- PERMISSIONS
- User permissions represented by emojis:
- •
- Read: 👀
- •
- Write: ✏️
- •
- Execute: 🚀
- •
- No Permission: ❌
- TYPE
- File type emoji
- NAME
- File or directory name
Analytics (-a)
The analytics output provides an overview of directory contents:
- •
- Total size of all files
- •
- Number of directories and files
- •
- Maximum directory depth
- •
- Information about the largest and newest files
- •
- Count of empty files
GIT INTEGRATION
When used in a Git repository (in default mode), facad displays Git status information:
- [M]
- Modified
- [A]
- Added
- [D]
- Deleted
- [R]
- Renamed
- [C]
- Copied
- [U]
- Updated but unmerged
- [?]
- Untracked
- [!]
- Ignored
These indicators appear after the file name in the default display mode.
SPECIAL BEHAVIORS
- 1.
- /dev Directory: When listing /dev, facad uses a specialized 6-column format optimized for device files.
- 2.
- Glob Patterns: facad supports glob patterns for file selection (e.g., *.txt).
- 3.
- Hidden Files: By default, hidden files (starting with `.') are displayed and sorted after non-hidden entries.
EXAMPLES
List contents of the current directory: facad
Display detailed information for a specific directory: facad -l /home/user/Documents
Show analytics for the current directory: facad -a
List contents of multiple directories: facad /home/user/Documents /home/user/Pictures
Use glob pattern to list specific files: **facad *.txt**
Combine options (long listing of txt files): **facad -l *.txt**
ENVIRONMENT
- TERM
- Determines the terminal type for color support.
LIMITATIONS
- •
- Does not currently support file operations (copy, move, delete).
- •
- Analytics on very large directories may be slow.
- •
- Emoji display depends on terminal and font support.
- •
- Git integration is not available in long listing mode (-l option).
NOTES
- •
- Ensure your terminal supports Unicode characters for optimal emoji display.
- •
- For best performance, avoid using analytics (-a) on directories with a large number of files.
AUTHOR
Written by Sergey Veneckiy.
REPORTING BUGS
Report bugs to: <https://github.com/yellow-footed-honeyguide/facad/issues>
COPYRIGHT
Copyright © 2024 Sergey Veneckiy. License MIT: <https://opensource.org/licenses/MIT>
This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.
SEE ALSO
ls(1), tree(1), du(1), stat(1), git(1)
For full documentation and the latest updates, visit: <https://github.com/yellow-footed-honeyguide/facad>
AUTHORS
Sergey Veneckiy.
| October 2024 | facad 1.0 |