User Guide

Welcome to the wiki of Sky, here is the user guide!

Installation

You can install this application using prebuilt binary. Make sure you have curl and zip installed.

Linux

1. curl -L https://sourceforge.net/projects/sky-gl02/files/sky.zip > sky.zip
2. unzip ./sky.zip -d sky
3. cd ./sky/linux-x64
4. chmod u+x ./sky
5. ./sky

MacOs

1. curl -L https://sourceforge.net/projects/sky-gl02/files/sky.zip > sky.zip
2. unzip ./sky.zip -d sky
3. cd ./sky/osx-x64
4. chmod u+x ./sky
5. ./sky

Windows

1. curl -L https://sourceforge.net/projects/sky-gl02/files/sky.zip > sky.zip
2. unzip .\sky.zip -d sky
3. cd .\sky\osx-x64
4. .\sky.exe

Currently, prebuilt binary is not very stable, you may encounter some issues. If that happens please try to clone this project and install dependencies by your own.

Usage

If you are using windows, please replace ./sky by .\sky.exe.

1. Load emails of specific period

./sky lms \
    /path/to/data \ 
    --date-from="[dd/][mm/]yyyy" \
    --date-to="[dd/][mm/]yyyy"

1. Show exchanged emails of an employee

./sky nms \
    /path/to/data \
    <employee's name  | employee's email address> \ 
    --date-from="[dd/][mm/]yyyy" \
    --date-to="[dd/][mm/]yyyy"

1. Show busy days of an employee

./sky bsd \
    /path/to/data <employee's name | employee's email address> \
    --date-from="[dd/][mm/]yyyy" \
    --date-to="[dd/][mm/]yyyy"

1. Show the top 10 contacts of an employee

./sky tpc \
    /path/to/data \
    <employee's name | employee's email address> \
    --date-from="[dd/][mm/]yyyy" \
    --date-to="[dd/][mm/]yyyy"

1. Show the top 10 words used by an employee in his email subject

./sky tpw \ 
    /path/to/data <employee's name | employee's email address> \
    --date-from="[dd/][mm/]yyyy" \
    --date-to="[dd/][mm/]yyyy"

1. Visualize sent and received emails of an employee

./sky emp \
    /path/to/data <employee's name | employee's email address> \
    --date-from="[dd/][mm/]yyyy" \
    --date-to="[dd/][mm/]yyyy"

1. Visualize sent emails of all collaborators

./sky nbmc \
    /path/to/data \
    --file="/path/to/save/svg/or/png" \
    --date-from="[dd/][mm/]yyyy" \
    --date-to="[dd/][mm/]yyyy"

1. Visualize employee's frequency of sending emails

./sky fmu \
    /path/to/data \
    --file="/path/to/save/svg/or/png" \
    --employee="<employee's name|employee's email address>" \
    --date-from="[dd/][mm/]yyyy" \
    --date-to="[dd/][mm/]yyyy"

1. Search emails by name of employee or email's content and subject

./sky sbc \
    /path/to/data \
    --employee="<employee's name|employee's email address>" \
    --date-from="[dd/][mm/]yyyy" \
    --date-to="[dd/][mm/]yyyy" \
    --subject="text" \
    --content="text"

Redirect

Click here to read the developper guide.