Skip to content
Kevin Jump edited this page Oct 20, 2022 · 1 revision

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 requires 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.

option Note
-s url of the server to connect to
-user username to connect with
-pass password of user
-key HMAC key to use for authentication

Example

uSync list -s https://my-server.com/umbraco -user [email protected] -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
Clone this wiki locally