Skip to main content
Version: v13.x - Umbraco 13

List

The List command lists all the available commands on a remote server.

Operation

The List command connects to a remote Umbraco installation and retrieves a list of commands that are avalible.

Options

Remote connection options require a server address -s and ether a username -user and password -pass for basic auth or the Key -key if you are using HMAC auth.

OptionNote
-sURL of the server to connect to
-userUsername to connect with
-passPassword of user
-keyHMAC key to use for authentication

Example

uSync list -s https://my-server.com/umbraco -user user@jumoo.co.uk -pass somepassword 

Output

  *** uSync Command Line ***

Remote commands available for https://my-server.com/umbraco :

Info : Information about the Umbraco installation
Ping : Ping a server, returns true when server is ready
Rebuild-DbCache : Rebuilds the database cache (Expensive)
Rebuild-Index : Rebuilds an examine index
Reload-MemCache : Reloads the in-memory cache
Test : A test command, to check things work
uSync-Export : Run an uSync export
uSync-Import : Run an uSync import
uSync-Report : Run a uSync report

For specific information on a single command :
> uSync list <command-name> ...
To run a command :
> uSync run <command-name> ...

Help

Description:
List server commands

Usage:
uSync list [<command>] [options]

Arguments:
<command> Command to get information about []

Options:
-s, --server <server> (REQUIRED) Name or URL of server to connect to
-k, --key <key> AuthKey to use when connecting to the server
-user, --username <username> Username to use when logging into server
-pass, --password <password> Password to use when logging into server
-?, -h, --help Show help and usage information