Introduction to the Harmony Core CLI Tool

The Harmony Core CLI Tool is a utility for managing, extending, and regenerating Harmony Core solutions. It is a replacement for regen.bat and includes a graphical interface that provides click-driven access to common Harmony Core tasks, such as:

• Configuring code generation options
• Regenerating Harmony Core components
• Managing OData settings and authentication
• Adding Traditional Bridge projects

---

System Requirements

• .NET 8 SDK - Verify by running:

  dotnet --version
  

• A Harmony Core solution. The CLI Tool can be run only in the solution directory for a Harmony Core solution.

Installing and Updating

To see if the CLI Tool is installed, enter the following command at a terminal prompt:

dotnet tool list -g

To install the CLI Tool, enter:

dotnet tool install -g Harmony.Core.CliTool

To update an existing installation, enter:

dotnet tool update -g Harmony.Core.CliTool

Launching the GUI for the CLI Tool

Open a terminal and navigate to a directory containing a Harmony Core solution file (.sln). Then enter:

harmonycore gui

After a brief “Loading Solution” message, the Harmony Core CLI Tool GUI opens with a menu and five tabs: Solution, OData, Structures, Traditional Bridge, and Interfaces.

Menus and Screens

The CLI Tool GUI has the following menus:

• File — Save the current customization file, import regen.bat settings, or validate configuration scripts.

• Search — Search for settings on the current screen.

• CodeGen — Regenerate code for the current solution or synchronize files with the specified options.

• Features — Add Traditional Bridge projects, Synergy Method Catalogs (SMCs), or unit tests.

The CLI Tool GUI has the following tabbed screens:

• Solution — Solution-level settings such as folder locations and namespaces.

• OData — Authentication (OAuth), API, and service configuration.

• Structures — Repository structures and related settings.

• Traditional Bridge — Traditional Bridge settings, SMC configuration, and unit test options.

• Interfaces — Interface definitions and related settings for Traditional Bridge.

What You Can Do with the CLI Tool

Using the CLI Tool, you can:

• Enable OData support and generate related code (models, controllers, service files). See Enabling OData Support for more information.

• Generate and manage sample data. See Generating Harmony Core Sample Data for more information.

• Add OData endpoints with query and relation expansion support. See Entity Collection Endpoints, Single Entity Endpoints, OData Query Support, Alternate Key Endpoints, and Expanding Relations.

• Generate Postman tests. See Generating and Using Postman Tests.

• Add CRUD endpoint support (Create, Upsert, Patch, Delete). See Adding a Primary Key Factory, Adding Create Endpoints, Adding Upsert Endpoints, Adding Patch Endpoints, and Adding Delete Endpoints.

• Implement authentication. See Tutorial 3: Authentication via Custom Code.

• Add a Traditional Bridge project. See Tutorial 4: Implementing Traditional Bridge.