Intent.MetadataSynchronizer.Json.CLI 1.0.0-pre.1

This is a prerelease version of Intent.MetadataSynchronizer.Json.CLI.
dotnet tool install --global Intent.MetadataSynchronizer.Json.CLI --version 1.0.0-pre.1                
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest # if you are setting up this repo
dotnet tool install --local Intent.MetadataSynchronizer.Json.CLI --version 1.0.0-pre.1                
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=Intent.MetadataSynchronizer.Json.CLI&version=1.0.0-pre.1&prerelease                
nuke :add-package Intent.MetadataSynchronizer.Json.CLI --version 1.0.0-pre.1                

Intent JSON Metadata Synchronizer

The Intent JSON Metadata Synchronizer CLI tool can be used to synchronize an object graph in a JSON file into an Intent Architect Document DB Domain Package.

This can be useful for doing most, if not all, the work of capturing a pre-existing a JSON document's object graph in the Domain designer for when you are using a Document store as your persistence.

Pre-requisites

Latest Long Term Support (LTS) version of .NET.

Installation

The tool is available as a .NET Tool and can be installed with the following command:

dotnet tool install Intent.MetadataSynchronizer.Json.CLI --global --prerelease

[!NOTE] If dotnet tool install fails with an error to the effect of The required NuGet feed can't be accessed, perhaps because of an Internet connection problem. and it shows a private NuGet feed URL, you can try add the --ignore-failed-sources command line option (source).

You should see output to the effect of:

You can invoke the tool using the following command: intent-json-metadata-synchronizer
Tool 'intent.metadatasynchronizer.json.cli' (version 'x.x.x') was successfully installed.

Usage

intent-json-metadata-synchronizer [options]

Options

Option Description
--config-file <config-file> Path to a JSON formatted file containing options to use for execution of this tool as an alternative to using command line options. The --generate-config-file option can be used to generate a file with all the possible fields populated with null.
--generate-config-file Scaffolds into the current working directory a "config.json" for use with the --config-file option.
--source-json-file <source-json-file> The name of the JSON file to parse and synchronize into the Intent Architect Package.
--isln-file <isln-file> The Intent Architect solution (.isln) file containing the Intent Architect Application into which to synchronize the metadata.
--application-name <application-name> The name of the Intent Architect Application (as per the Application Settings view) containing the Intent Architect Package into which to synchronize the metadata.
--package-id <package-id> The id of the Intent Architect Package containing the Intent Architect Package into which to synchronize the metadata.
--target-folder-id <target-folder-id> The target folder within the Intent Architect package into which to synchronize the metadata. If unspecified then the metadata will be synchronized into the root of the Intent Architect package.
--version Show version information
-?, -h, --help Show help and usage information

Configuration file

The --config-file option expects the name of a file containing configuration options to be used as an alternative to adding them as CLI options. A template for the configuration file can be generated using the --generate-config-file option. The content of the generated template is as follows:

{
  "SourceJsonFile": null,
  "IslnFile": null,
  "ApplicationName": null,
  "PackageId": null,
  "TargetFolderId": null
}
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)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last updated
1.0.0-pre.1 209 10/17/2023
1.0.0-pre.0 87 6/24/2023