An Introduction to SkySync Command Line Interface (CLI)


Is the GUI dead? Nope, but SkySync provides IT Pros the option of using the excellent SkySync web application or the SkySync Command Line Interface (CLI). The CLI is a first-class citizen in the SkySync architecture, and abstracts many of the common API calls into a succinct and powerful command library.

In this post, we are going to install the SkySync Command Line Interface, configure the SkySync CLI authorization, and execute a simple command.

SkySync CLI Install

Before we get started, we recommend downloading and installing NodeJS. This is the only prerequisite outside of the SkySync components.

Ensure you have a fresh release of SkySync and install the SkySync CLI via NPM. From the command line execute

npm install -g skysync-cli

SkySync CLI Configuration

Create a configuration file named ‘skysync-cli.json’ with the format below, and place the file one directory above the context of your skysync-cli command line. You can optionally provide these parameters on each command; however, it is much easier to define them once and store in a file for context.

"server": "",
"username": "admin",
"password": "my crazy secret password"

SkySync Command Line Interface Usage

The SkySync CLI should now be ready to go.  You can always get more information about the available commands  and format via the –help parameter.

skysync-cli -–help

With the CLI installed and configured, let’s validate and ensure a connection to a platform exists. Execute the following command to list all connections.

skysync-cli connections list

Success! In this post, we reviewed the prerequisites, installation, configuration, and basic usage of the SkySync CLI.  For more information, check out the full featured SkySync CLI documentation and see what is possible with SkySync.


Next up: Using SkySync CLI: Surface User Accounts from Disparate Storage Platforms:
Would you like insight into your organization’s surface user accounts across multiple on-premise or cloud platforms? Using the SkySync CLI and ReST API, the job can be accomplished quickly and easily.