What is Navigator Platform CLI?

Whānau Tahi Navigator Platform CLI is a powerful command-line tool that empowers developers and administrators to perform essential operations in Navigator Power Platform environments. The CLI streamlines common tasks related to application lifecycle management, environment setup, data management, solution deployment, and customisation.

The Navigator Platform CLI is intended to be used only by developers or advanced administrators who are trained in the use and customisation of Power Platform and Dataverse model-driven apps.

Available Commands

The CLI provides six primary commands, each designed for specific operational needs:

datamanipulation - Manage Existing Data

Provides powerful data management operations to update existing records after feature implementations or migrations. This includes rebuilding activity relationships, updating email data, managing family groups, handling referrals, and extracting data via TDS endpoints.

Use this when: You need to update existing data to align with newly deployed features, fix data inconsistencies, or extract large datasets for analysis.

View datamanipulation documentation →

organizationsetup - Deploy Reference Data

Copies reference data and configuration from a master data environment to target environments. This includes outcomes frameworks, service configurations, contracts, assessment tools, and supporting reference tables. Supports full environment setup or targeted dataset synchronisation.

Use this when: You need to establish consistent reference data across development, test, and production environments, or synchronise configuration changes between environments.

View organizationsetup documentation →

translate - Localise Solutions

Translates Navigator solution customisation files (customizations.xml) into multiple languages. This command processes solution metadata and generates translated versions for multi-language deployments.

Use this when: You need to prepare solution packages for deployment in regions requiring localised language support.

Legacy Commands

assessmentprep - Create New Assessment Tools

Automates the creation of new assessment tool entities in Navigator environments. This command creates the entity structure, fields, forms, and relationships required for a custom assessment tool to integrate seamlessly with Navigator's assessment framework.

Important

This set of commands has been deprecated. Please use Dynamic Assessments instead.

If you have not had an upgrade to receive the Dynamic Assessment capability, please get in touch with us at support@whanautahi.com. You can read more details about the feature here: Dynamic Assessments Release Notes

View assessmentprep documentation →

crmenvsetup - Configure Power Platform Environments

Sets up newly created Power Platform environments with required security roles and permissions. This command ensures that key users have the necessary system administrator access to begin configuring the environment.

Important

This set of commands has been deprecated.

solution - Deploy Solutions

Manages solution imports, staging, and upgrades asynchronously. This command initiates solution deployment operations and provides job tracking capabilities to monitor deployment progress.

Important

This set of commands has been deprecated. Please use Microsoft's PAC CLI instead, which you can download from Microsoft Power Platform CLI.

Install Whānau Tahi Navigator Platform CLI

You can use te following ways to install Whānau Tahi Navigator Platform CLI:

  1. Request the Navigator Platform CLI files from Whānau Tahi support.

or

  1. If you have access to the Whānau Tahi Devops project, download the artifact from the latest WhanauTahi.Xpm.Tooling Devops pipeline.

When you have obtained the files, copy them to a location on your local hard drive (e.g. C:\WhanauTahi.Xpm.Tooling).

You may also need to add a folder exception to your anti-virus software to allow the application to run.

Note
  • Currently, Whānau Tahi Navigator Platform CLI is supported only on Windows 10 and Windows 11.
  • You must have Microsoft .Net 8 installed to use Navigator Platform CLI.