noxdir

command module
v0.0.3 Latest Latest
Warning

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

Go to latest
Published: May 16, 2025 License: MIT Imports: 18 Imported by: 0

README ΒΆ

🧹 NoxDir

NoxDir is a high-performance, cross-platform command-line tool for visualizing and exploring your file system usage. It detects mounted drives or volumes and presents disk usage metrics through a responsive, keyboard-driven terminal UI. Designed to help you quickly locate space hogs and streamline your cleanup workflow.

πŸš€ Features

  • βœ… Cross-platform drive and mount point detection (Windows, macOS, * Linux*)
  • πŸ“Š Real-time disk usage insights: used, free, total capacity, and utilization percentage
  • πŸ–₯️ Interactive and intuitive terminal interface with keyboard navigation
  • ⚑ Built for speed β€” uses native system calls for maximum performance
  • πŸ”’ Fully local and privacy-respecting β€” no telemetry, ever
  • 🧰 Minimal dependencies β€” single binary, portable

πŸ“Έ Preview

Drives list Directories list
The San Juan Mountains are beautiful! The San Juan Mountains are beautiful!

πŸ“¦ Installation

Pre-compiled Binaries

Obtain the latest optimized binary from the Releases repository. The application is self-contained and requires no installation process.

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

./bin/noxdir

πŸ›  Usage

Just run in the terminal:

noxdir

The interactive interface initializes immediately without configuration requirements.

βš™οΈ 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

  • Real-time filesystem event monitoring and interface updates
  • Exportable reports in various formats (JSON, CSV, HTML)
  • Comprehensive file management capabilities (deletion, renaming, creation operations)
  • Sort directories by usage, free space, etc. (already done for drives)
  • Customizable interface aesthetics with theme support

πŸ™‹ FAQ

  • Q: Can I use this in scripts or headless environments?
  • A: Not yet β€” it's designed for interactive use.

  • Q: What are the security implications of running NoxDir?
  • A: NoxDir operates in a strictly read-only capacity with no file modification capabilities in the current release.

  • Q: Does NoxDir support file management operations?
  • A: File manipulation features are currently under development and prioritized in our roadmap.

  • Q: The interface appears to have rendering issues with icons or formatting.
  • A: Visual presentation depends on terminal capabilities and font configuration. For optimal experience, a terminal with Unicode and glyph support is recommended.

πŸ§ͺ 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


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