@zygon/cli v0.8.0

Zygon

Zygon's frontend allows you to manage accounts from any application, on one platform. This package allows you to interact with the Zygon platform from your terminal.

Installation

Global

To install the latest version of the Zygon CLI globally, run this command:

npm i -g @zygon/cli

Local to a folder

If you do want to install the command in a specific folder, use the following command:

npm i @zygon/cli

Please note that this will create an npm project within that folder (if there isn't already one), to track the installed version. You will also need to rely on npx to call the CLI (see the No installation section below)

No installation

If you do not want to install the CLI permanently, you can skip the previous steps, and prefix all the following commands with npx. Note that you can specify a version like so:

npx zygon@0.9.0 <command>

The first time npx is run, a cache with the corresponding version will be created. This cache will be used on the next use of npx.

Usage

Email extraction

All commands for email extraction are available under this command:

zygon email

Exchange

To extract metadata from Exchange, run the following command:

zygon email exchange <user_email> <pst_path> <dest_path>

You can extract a PST backup with the command New-MailboxExportRequest, check this for more info: https://learn.microsoft.com/fr-fr/powershell/module/exchange/new-mailboxexportrequest?view=exchange-ps

Gmail

To extract metadata from Gmail, run the following command:

zygon email gmail <key_file> <user_key>

Microsoft 365

To extract metadata from Microsoft 365, run the following command:

zygon email 365 <user_key>

Upload

To upload the extracted emails, run the following command:

zygon email upload <api_key> <csv_path>