peek-cli
| Crates.io | peek-cli |
| lib.rs | peek-cli |
| version | 0.1.12 |
| created_at | 2025-11-06 18:47:20.066317+00 |
| updated_at | 2025-11-07 15:14:55.399131+00 |
| description | A fast CLI tool to open files and directories in your default browser |
| homepage | |
| repository | https://github.com/lyznne/peek |
| max_upload_size | |
| id | 1920113 |
| size | 89,282 |
enos muthiani (lyznne)
documentation
README
peek-cli
A simple, fast, and elegant file viewer that opens files in your default web browser.
Overview
peek-cli lets you open any file directly in your default web browser from the terminal. It’s lightweight, blazingly fast, and perfect for developers who want quick file previews without the bloat.
Features
- Open any file type instantly in your browser
- Smart file detection
- Cross-platform support (Linux, macOS, Windows)
- Written in Rust — safety, performance, reliability
- Available on AUR, Crates.io, and GitHub Releases
Installation
From Cargo
cargo install peek-cli
From Source
git clone https://github.com/lyznne/peek.git
cd peek
cargo build --release
Arch Linux (AUR)
yay -S peek-cli
Windows Installation
- Download
peek-windows-x86_64.zipfrom releases - Extract the archive
- Add the extracted folder to your PATH, or:
- Move
peek.exeto a folder already in PATH (e.g.,C:\Windows\System32)
- Move
- Run
peek <file>from any terminal
Usage
peek <file-path>
peek --help
Examples:
peek #open current dir
peek README.md
peek index.html
peek ./docs/guide.pdf
Development
To contribute or customize peek-cli, clone the repo and build:
git clone https://github.com/lyznne/peek.git
cd peek
cargo run -- <file>
Roadmap
- Add interactive TUI mode
- Support remote file URLs
- Add colorized output for logs
- Integrate with file explorers
Contributing
Pull requests are welcome! If you have suggestions or bug reports, please open an issue.
License
Licensed under the MIT and Apache-2.0 licenses. See LICENSE for more information.
