pacx settings export - neronotte/Greg.Xrm.Command GitHub Wiki

List settings defined for the current environment

Aliases

pacx settings list
pacx settings ls

Usage

The current command will list all the settings in a given solution, or in the current environment. It can output the settings value to console in a tabular format (-fmt Text), to console and/or file in JSON format (-fmt Json) or in an excel file (-fmt Excel).

Easter egg: if you put the {version} token in the output file name, it will be replaced by the current timestamp. E.g.

pacx settings export -fmt Excel -out settings_{version}.xlsx

Will generate an Excel file named settings_2024.05.05.12.34.56.xlsx.

In both Excel and Json format, the output is deterministic: settings are sorted by name, and the values_per_app are sorted by app name. This means that the output structure will remain fixed, to improve versioning and simplify comparison between different environments.

Arguments

Long Name	Short Name	Required?	Description	Default value	Valid values
origin	o	N	Indicates if the list of settings to retrieve is the whole list of settings, or just the settings in the specified solution.	Solution	Solution, All
filter	f	N	Indicates if the list of settings to retrieve should include all settings, or only visible settings.	Visible	Visible, All
format	fmt	N	The format of the output. Default is Text. Use Json to get the output in JSON format.	-	Text, Json, Excel
output	out	N	If the format specified is Json or Excel, this is the name of the file where the output will be saved. For Excel files is mandatory. For JSON, if not specified, the output will be written only to the console.	-	String
run	r	N	Allows to specify whether the output file should be automatically opened or not.	False	true, false
solution	s	N	The solution to get the settings from. If not specified, the default solution is considered.	-	String