Uno.Dsp.Cli 1.4.0

Uno DSP Tooling - Command Line Interface

This is the package that contains the command line interface for the Uno DSP Tooling.

Overview

This is used to generate Color Overrides file for project using Uno.Themes like documented on the official documentation.

How to get your theme file

Theme files are used to define the color palette of a theme and can be generated using the Material V3 Theme Builder website. Simply export using the "Material Theme (JSON)" format and download the generated JSON file.

Installation

The Uno DSP Tooling CLI is available as a dotnet tool.

To install it, run the following command:

dotnet tool install -g Uno.Dsp.Cli

# Or, to update it...
dotnet tool update -g Uno.Dsp.Cli

Usage

To generate the color overrides file, run the following command:

# XAML output (default)
uno-dsp import-colors <path_to_source_theme_file> [<path_to_output_file_or_folder>]

# CSharp output
uno-dsp import-colors <path_to_source_theme_file> [<path_to_output_file_or_folder>] --output-format CSharp

MSBuild Task

If you want this generation to occur automatically when building your project, you may prefer to use the MSBuild task instead.

There is another package that contains a MSBuild task to generate the color overrides file: Uno.Dsp.Tasks.

Using the CLI instead of the MSBuild task is recommended if you want to generate the color overrides file from a theme file that is not in your project or if you need more flexibility on the moment when it is generated.