Intent.MetadataSynchronizer.CSharp.CLI 1.0.0-pre.2

This is a prerelease version of Intent.MetadataSynchronizer.CSharp.CLI.
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet tool install --global Intent.MetadataSynchronizer.CSharp.CLI --version 1.0.0-pre.2                
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.CSharp.CLI --version 1.0.0-pre.2                
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=Intent.MetadataSynchronizer.CSharp.CLI&version=1.0.0-pre.2&prerelease                
nuke :add-package Intent.MetadataSynchronizer.CSharp.CLI --version 1.0.0-pre.2                

Intent C# Metadata Synchronizer

The Intent C# Metadata Synchronizer CLI tool can be used to synchronize your cs files into an Intent Architect Domain package.

This tool can be useful for creating Intent Architect Domain Packages based on your C# Class cs files.

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.CSharp.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-csharp-metadata-synchronizer
Tool 'intent.metadatasynchronizer.csharp.cli' (version 'x.x.x') was successfully installed.

Usage

intent-csharp-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.
--isln-file <isln-file> The Intent Architect solution (.isln) file containing the Intent Architect Application into which to synchronize the metadata.
--domain-entities-folder This folder location will be used to sync the C# Classes contained within it as Domain Entities.
--domain-enums-folder This folder location will be used to sync the C# Enums contained within it as Domain Enums.
--domain-services-folder This folder location will be used to sync the C# Classes contained within it as Domain Services.
--service-dtos-folder This folder location will be used to sync the C# Classes contained within it as Service DTOs.
--service-enums-folder This folder location will be used to sync the C# Classes contained within it as Service Enums.
--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.
--designer-name <designer-name> The name of the Designer where the package is located. i.e. "Domain" or "Services"
--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.
--allow-removal <bool> Remove previously imported data which is no longer being imported?
--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:

{
  "DomainEntitiesFolder": null,
  "DomainEnumsFolder": null,
  "DomainServicesFolder": null,
  "ServiceEnumsFolder": null,
  "ServiceDtosFolder": null,
  "IslnFile": null,
  "ApplicationName": null,
  "PackageId": null,
  "DesignerName": null,
  "TargetFolderId": null,
  "AllowRemoval": true
}
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  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.3 58 9/3/2024
1.0.0-pre.2 39 7/29/2024
1.0.0-pre.1 55 7/1/2024
1.0.0-pre.0 80 4/12/2024