Skip to content

Universal terminal file viewer is a lightweight CLI tool written in Rust to display images, PDFs, and plain text files directly in your terminal, without needing any GUI tools.

License

Notifications You must be signed in to change notification settings

JoseLucasapp/Universal-terminal-file-viewer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Universal terminal file viewer 🧾

Rust License Build

Universal terminal file viewer is a lightweight CLI tool written in Rust to display images, PDFs, and plain text files directly in your terminal, without needing any GUI tools. It supports colorful image rendering with ASCII blocks, PDF viewing, and structured terminal output.



📦 Installation

Download the latest installer from the Releases page and run the .exe file:

see_file_installer.exe

This will:

  • Install see_file.exe to C:\Program Files\see_file
  • Automatically add it to your system PATH
  • Allow you to run see_file from any terminal

After installation, try:

see_file --help

🔧 Manual install (optional)

Alternatively, if you prefer to build manually from source:

git clone https://github.com/JoseLucasapp/Universal-terminal-file-viewer
cd Universal-terminal-file-viewer
cargo build --release

To make it available globally:

copy target\release\see_file.exe C:\Users\<your-user>\.cargo\bin

Or add its folder to your PATH manually.


📖 Usage

see_file [OPTIONS] --image <path>
see_file [OPTIONS] --pdf <path>
see_file [OPTIONS] --text <path>

⚙️ Global Options

Option Description
--width, -w Horizontal scale factor for block size (1–2)
--height, -v Vertical scale factor (1–9)

🖼️ Image Mode

Display any image in the terminal using RGB ASCII blocks.

see_file --image ./example.jpg -w 2 -v 3

📄 PDF Mode

Extract and print PDF text:

see_file --pdf ./resume.pdf

📜 Text Mode

Display plain text files directly:

see_file --text ./notes.txt

🤝 Contributing

Contributions are welcome! Feel free to submit issues, ideas, or pull requests on GitHub.


📄 License

MIT © joselucasapp

About

Universal terminal file viewer is a lightweight CLI tool written in Rust to display images, PDFs, and plain text files directly in your terminal, without needing any GUI tools.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages