Synapse command line client

The Synapse Python Client can be used from the command line via the synapse command.

Installation

The command line client is installed along with installation of the Synapse Python client.

Help

For help, type:

synapse -h.

For help on specific commands, type:

synapse [command] -h

Optional arguments

-h, --help            show this help message and exit
--version             show program's version number and exit
-u SYNAPSEUSER, --username SYNAPSEUSER
                    Username used to connect to Synapse
-p SYNAPSEPASSWORD, --password SYNAPSEPASSWORD
                    Password used to connect to Synapse

Commands

  • login - login to Synapse and (optionally) cache credentials
  • get - download an entity and associated data
  • add - add or modify content to Synapse
  • delete - removes a dataset from Synapse
  • mv - move a dataset in Synapse
  • cp - copy an entity/dataset in Synapse
  • query - performs SQL like queries on Synapse
  • submit - submit an entity for evaluation
  • set-provenance - create provenance records
  • get-provenance - show provenance records
  • set-annotations - create annotations
  • get-annotations - show annotations
  • show - show metadata for an entity
  • onweb - opens Synapse website for Entity
  • show - Displays information about a Entity

A few more commands (cat, create, update, associate)