10 stable releases
|1.0.10||Apr 27, 2019|
|1.0.8||Jan 6, 2019|
|1.0.6||Dec 1, 2018|
|1.0.4||Nov 25, 2018|
#51 in Filesystem
64 downloads per month
Written in Rust, this program collects file metadata and stores it in a PostgreSQL database. Some things it gathers include:
- File name
- XxHash checksum
In addition to collecting data about files, the program assists in indexing files with tools such as file tagging, search, and more. Development on these features is underway... stay tuned!
To run the project, you will need a PostgreSQL database setup and configure the
.env file in this project to point to your database. See Configuration section
Next, you will need to use diesel to run the database migrations necessary to create tables needed for the project.
diesel migration run
Next, set any remaining configuration values as detailed in Configuration.
Once the prerequisites are met, you may run or build the project with:
# To see help cargo run -- --help # To run cargo run # To build for release cargo build --release
See Arguments section for details on the arguments this program accepts.
Note: if running on Ubuntu, you may need to install libpq-dev in order for Diesel to compile when cargo builds.
sudo apt install libpq-dev
This app takes a minimum of one command line argument before it will perform any action beyond simply terminating. This section is divided into commands subcommands.
You can specify one of several actions to use via the
flags followed by an action name. For now configuration beyond selecting an
action to perform is handled in the
.env file, see Configuration. Valid
- duplicates - finds duplicate files within database via matching hashes.
- hash - computes hashes, file size, etc and stores results in database.
- orphans - iterates all database entries computed by hash action and does a simple check to see if files are still present. If a file is not present, its entry in the database will be removed.
# Start hashing files: cargo run -- --action hash
To create a tag without applying it to a listing, eg "puppy" use
cargo run -- new-tag puppy
To aid in searching for any given file, you can apply tags to a listing id which
in the future will be used as a search mechanism. For example, you could search
for all files containing the tag
vacation and viola 🎻, all files with
the tag applied are returned!
To tag a listing, whose id is 56982fc3-091a-489c-bd6c-c7f916965d4b, with tags
cargo run -- tag 56982fc3-091a-489c-bd6c-c7f916965d4b -- summer beach vacation
To remove a single tag applied to a listing, use the UUID in the id column of
listing_tags to remove the applied tag association.
cargo run -- delete-tag-listing 56982fc3-091a-489c-bd6c-c7f916965d4b
Deleting a tag will remove it from the
tags table and all entries of where the
tag was in use on the
listing_tags table. Proceed with caution! To make this a
little harder to accidentally run, for now tags must be deleted with their UUID
in the id column within the
cargo run -- delete-tag 56982fc3-091a-489c-bd6c-c7f916965d4b
.env configuration setting include:
- DATABASE_URL - PostgreSQL connection string.
- DIRECTORY_TO_SCAN - root directory location to start scanning files from.
documentation folder for more information including how to host a PostgreSQL
database setup with pgAdmin compatible with this project.
License is MIT. See LICENSE file.