Skip to content

realzhangshen/croot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

91 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

croot

A terminal file explorer that brings the VS Code sidebar experience to your command line — built with Rust and Ratatui.

Features

  • Git status integration — see modified, staged, and untracked files at a glance
  • Real-time filesystem watching — tree auto-refreshes on file changes
  • Syntax-highlighted preview — preview files with full syntax highlighting (150+ languages)

Pair with cmux

croot works great alongside cmux for a full vibe coding setup in the terminal — file tree on one side, editor and shell on the other.

Installation

Homebrew (macOS)

brew install realzhangshen/croot/croot

From source

git clone https://github.com/realzhangshen/croot.git
cd croot
cargo build --release
# Binary is at target/release/croot

Usage

croot            # Browse current directory
croot ~/projects # Browse a specific directory

Configuration

Config file: ~/.config/croot/config.toml (or $XDG_CONFIG_HOME/croot/config.toml)

Development

make install-hooks   # Set up pre-commit and pre-push hooks
make ci              # Run all CI checks locally (fmt, check, clippy, test)
make fix             # Auto-format code

The pre-commit hook runs cargo fmt --check (sub-second). The pre-push hook mirrors CI with all four checks. Both are skippable with --no-verify.

License

MIT

About

A VS Code-style file explorer sidebar for your terminal

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages