User Guide
important
There are different methods to install Excavator, and it depends on your profile to select how you are going to install it. If you are not a developer, please refer to the "Non-Developer Guide". Otherwise, please follow the instructions from the "Developer guide".
Non-Developer Guide#
Go to our GitHub page.
You should see the last release on your screen (v0.2.0 when we are writing this).
Depending on your OS (Windows, Linux or Mac), click on one the three files highlighted.
It should download the file on your device. Then you need to uncompress it.
Windows#
We are using 7zip to unzip sieving-windows.tar.gz.
Put the extracted file in C:\Windows\System32, and the installation is completed. You should now be able to use sieving in a terminal.
Linux#
Extract sieving-linux.tar.gz wherever you want on your device.
Finally, open a terminal and type the following command sudo cp PATH_TO_SIEVING /usr/local/bin (replace PATH_TO_SIEVING by the path to where you extracted sieving in the previous step).
The installation is completed, you should now be able to use sieving in a terminal.
MacOS#
Extract sieving-linux.tar.gz in usr/local/bin.
The installation is completed, you should now be able to use Excavator in a terminal.
Developer guide#
This part is meant to users who want to contribute to the development of sieving. You will need first to have the Rust Programming Language installed on your device.
Once, you have Rust, you can easily install sieving from crates.io.
How to use sieving?#
sieving takes only one argument : the path to the file (or directory) you want to analyze and protect.
Open a terminal and type the following command:
Then sieving will analyze your files and eventually detect some sensitive data.
For example with this file:
if we run sieving:
You need to type yes or no depending on if you want to hide data or not.
For our example, here is the file after scanning it:
