uSync.Commands 10.0.2

There is a newer version of this package available.
See the version list below for details.
dotnet add package uSync.Commands --version 10.0.2
NuGet\Install-Package uSync.Commands -Version 10.0.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="uSync.Commands" Version="10.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add uSync.Commands --version 10.0.2
#r "nuget: uSync.Commands, 10.0.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install uSync.Commands as a Cake Addin
#addin nuget:?package=uSync.Commands&version=10.0.2

// Install uSync.Commands as a Cake Tool
#tool nuget:?package=uSync.Commands&version=10.0.2

uSync.Commands

The uSync specific command library for the uSync command line.

This package includes the core uSync command line libraries and specific ones for uSync (e.g uSync-Import).

dotnet install package uSync.Commands

Commands

Included in this package are :

uSync-Export
uSync-Import
uSync-Report

Options

Option Details
Set Handler set to use (default is 'default')
Groups Handler groups to use (default is the current UIEnabledGroups)
Folder Folder to run command agaisnt (default is /uSync/v9)
Verbose True if you want to get the full results json back not a summary

Example

1. Default Import

Run a usync import against the usync folder (as if you have pressed the import everything button in the dashboard)

uSync run usync-import  [url] -user <user> -pass <pass>

Import just settings

uSync run usync-import -p groups=settings [url] -user <user> -pass <pass>

Import content from a diffrent folder

uSync run usync-import -p folder=uSync\content [url] -user <user> -pass <pass>

Configuration

By default the command line library is disabled for your site, to enable it you need to add values to the appsettings.json file for your site.

 "uSync": {
    "Commands": {
      "Enabled": "hmac,basic",
      "key": "HMAC-KEY-VALUE",
      "UserId" : -1
    }
  }

Options

Enabled

Turns on the Authentication methods for the command line - acceptible values are hmac (key based) and basic (username and password based)

Key

The security key to use when using hmac (key based) authentication, this is the key that you would then need to use on the command line when running remote commands against your site.

usync run [command] https://you-site.com/umbraco -k <KEY-VALUE-HERE>

UserId

When using Key based authentication Umbraco will authenticate the commands against the default user (-1) unless you set the UserId value - this will then set the permissions for the user to be the same as for the user id you set.

Configuration

Configuration

By default the command line library is disabled for your site, to enable it you need to add values to the appsettings.json file for your site.

 "uSync": {
    "Commands": {
      "Enabled": "hmac,basic",
      "key": "HMAC-KEY-VALUE",
      "UserId" : -1
    }
  }

Options

Enabled

Turns on the Authentication methods for the command line - acceptible values are hmac (key based) and basic (username and password based)

Key

The security key to use when using hmac (key based) authentication, this is the key that you would then need to use on the command line when running remote commands against your site.

usync run [command] https://you-site.com/umbraco -k <KEY-VALUE-HERE>

UserId

When using Key based authentication Umbraco will authenticate the commands against the default user (-1) unless you set the UserId value - this will then set the permissions for the user to be the same as for the user id you set.

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
10.0.4 4,392 2/13/2023
10.0.3 935 1/30/2023
10.0.2 260 1/30/2023
10.0.1 252 1/27/2023

10.0 Initial release