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

Operation

the run command connects to the remote Umbraco instance and executes the given command. it passes any parameters (supplied with the -p options) to the command.

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
command name of the command to run
-p parameters to add to the command
-s url of the server to connect to
-user username to connect with
-pass password of user
-key HMAC key to use for authentication

parameters are passed either with multiple -p options or one -p option with spaces between the parameters

for example

-p option=value other=value2

or

-p option=value -p other=value2

Example

uSync run info -s https://my-server.com/umbraco -user [email protected] -pass somepassword 

Output

  *** uSync Command Line ***

{
  "version": "10.2.0",
  "level": "Run",
  "role": 1,
  "servers": "https://localhost:44315/",
  "environment": "Development",
  "applicatioName": "UmbracoTenTwo",
  "contentRootPath": "C:\\Source\\Testing\\Umbraco\\10\\UmbracoTenTwo"
}

Help

  *** uSync Command Line ***

Description:
  Run a command against a server

Usage:
  uSync run <command> [options]

Arguments:
  <command>  Command to issue to server

Options:
  -s, --server <server> (REQUIRED)  Name or URL of server to connect to
  -p, --parameters <parameters>     Parameters to pass to server command
  -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