tomboulier / file-inventory

File and Directory Inventory Tool

Overview

This Rust-based command-line tool efficiently inventories all .nii.gz files within a specified directory and its subdirectories. It's designed to provide a quick overview of the directory's contents, making it particularly useful for managing and analyzing large collections of .nii.gz files.

Current Features

• .nii.gz File Counting: Counts the number of .nii.gz files within the directory and its subdirectories.
• Recursive Analysis: Performs a deep analysis by recursively processing all subdirectories to ensure a comprehensive inventory.

Future Features

• File Counting by Extension: Counts the number of files for each file extension within the directory and its subdirectories. (Planned)
• Subdirectory Counting: Tallies the total number of subdirectories within the specified directory. (Planned)

Getting Started

Prerequisites

Ensure you have Rust installed on your machine. If not, follow the installation instructions on the official Rust website.

Installation

1. Clone this repository to your local machine:

   git clone https://github.com/yourusername/file-directory-inventory.git

2. Navigate to the project directory:

   cd file-directory-inventory

3. Build the project using Cargo (Rust's package manager and build system):

   cargo build --release

4. The executable will be located in ./target/release/.

Usage

To use this tool, simply run the executable from the command line, passing the target directory as an argument:

./target/release/file_directory_inventory <path_to_directory>

Replace <path_to_directory> with the path to the directory you wish to inventory.

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests with improvements or new features.

License

This project is licensed under the MIT License - see the LICENSE file for details.