Skip to main content
Version: v12.x - Umbraco 12

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 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
commandName of the command to run
-pParameters to add to the command
-sURL of the server to connect to
-userUsername to connect with
-passPassword of user
-keyHMAC 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 user@jumoo.co.uk -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