noxdir

command module
v0.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 5, 2025 License: MIT Imports: 21 Imported by: 0

README ΒΆ

🧹 NoxDir

NoxDir is a fast, cross-platform CLI tool for scanning your file system. It detects mounted drives or volumes and displays space usage in a clean, interactive terminal UI. Ideal for figuring out what’s eating up your disk space and where to clean up first.

πŸš€ Features

  • βœ… Detects drives/mount points on Windows, macOS, and Linux
  • πŸ“Š Shows disk usage (used, free, total, percentage usage) per drive
  • πŸ–₯️ Interactive terminal UI (keyboard navigation)
  • ⚑ Fast and efficient scanning, using native system calls
  • πŸ”’ No telemetry, no BS β€” just your drives and the data

πŸ“Έ Preview

Drives list

The San Juan Mountains are beautiful!

Directories list

The San Juan Mountains are beautiful!

πŸ“¦ Installation

Download Binaries

Grab the latest binary from the Releases page for your platform. Run it from wherever you want.

Or build from source (Go 1.24+)
git clone https://github.com/crumbyte/noxdir.git
cd noxdir
make build

./noxdir

πŸ›  Usage

Just run in the terminal:

noxdir

No flags, no fuss. It starts the interactive UI immediately.

βš™οΈ How It Works

  • Windows: Uses GetLogicalDrives and GetDiskFreeSpaceExW through direct syscalls for optimal performance.
  • Linux/macOS: Uses statfs and parses /proc/mounts or mount command output to find mounted volumes.

🧩 Planned Features

  • Listen for FS event for rendering
  • Dirs/files management (delete, rename, add, etc.)
  • Sort directories by usage, free space, etc. (already done for drives)
  • Theming / color customization

πŸ™‹ FAQ

  • Q: Can I use this in scripts or headless environments?

  • A: Not yet β€” it's designed for interactive use.

  • Q: Is this safe to run?

  • A: Yes β€” it’s strictly read-only and does not touch any files.

  • Q: Can I delete dirs/files from the application?

  • A: Not yet. Already in the roadmap.

  • Q: I don't see the icons and everything looks ugly.

  • A: It depends solely on your terminal's settings and fonts. Theming your terminal application is another topic.

πŸ§ͺ Contributing

Pull requests are welcome! If you’d like to add features or report bugs, please open an issue first to discuss.

πŸ“ License

MIT Β© crumbyte


NoxDir is built with πŸ’» and ❀️ to help you take back control of your storage.

Documentation ΒΆ

The Go Gopher

There is no documentation for this package.

Directories ΒΆ

Path Synopsis
pkg

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL