Syntool Overview

General Usage

The syntool.py program is used to control your Volumes, Gateways, and user account, as well as request access to and add/remove people from Volumes. It does so by letting you directly call methods in the MS API. The general way you invoke a method is via:

$ syntool.py [opts] METHOD [positional arguments] [keyword arguments]

syntool.py maintains a key database in $HOME/.syndicate. Treat it like your .ssh directory: back it up, don't lose it, and don't share it.

Activating your Account

Before you can do anything with syntool.py, you'll need to activate your account. Once an administrator creates your user account, you can activate it with:

$ syntool.py --user_id=YOUR.USER.ID@EXAMPLE.COM \
             --url=https://YOUR.SYNDICATE.INSTANCE
             setup

You will be prompted for your account activation password (the one sent to you by the admin) and for your Syndicate password.

Getting Help

Each method in syntool.py has a built-in help feature, that can be accessed with the "help" directive. For example:

$ syntool.py help create_volume

will print the built-in documentation for create_volume.