pac catalog

Commands for working with Catalog in Power Platform

Commands

Command	Description
pac catalog create-submission	Create catalog submission document. Note: This command will be removed in a future release.
pac catalog install	Install a catalog item to the target environment.
pac catalog list	List all published catalog items from the current Dataverse organization.
pac catalog status	Get status of the catalog install/submit request.
pac catalog submit	Submit catalog approval request.
pac catalog update	Update settings for the catalog.

pac catalog create-submission

Create catalog submission document. Note: This command will be removed in a future release.

Optional Parameters for catalog create-submission

--path -p

Path to catalog submission document

pac catalog install

Install a catalog item to the target environment.

Required Parameters for catalog install

--catalog-item-id -cid

Catalog item to be installed on the target environment.

Optional Parameters for catalog install

--environment -env

Specifies the target Dataverse. The value may be a Guid or absolute https URL. When not specified, the active organization selected for the current auth profile will be used.

--poll-status -ps

Poll to check status of your request

This parameter requires no value. It's a switch.

--settings -s

Runtime Package Settings for the installation framework to execute. The format of the string must be key=value|key=value.

Note: The format of the string must be key=value|key=value.

--target-url -tu

Deprecated: Use --environment instead.

--target-version -tv

Target version to install. If left empty, the published version is selected.

pac catalog list

List all published catalog items from the current Dataverse organization.

Optional Parameters for catalog list

--catalog-item-id -cid

Catalog item ID to search for. When catalog item ID is used, catalog item name is ignored.

--catalog-item-name -n

Catalog item name to search for.

--environment -env

Specifies the target Dataverse. The value may be a Guid or absolute https URL. When not specified, the active organization selected for the current auth profile will be used.

--include-active -ia

Include active items.

This parameter requires no value. It's a switch.

--json

Returns the output of the command as a JSON formatted string.

pac catalog status

Get status of the catalog install/submit request.

Required Parameters for catalog status

--tracking-id -id

Request tracking ID.

--type -t

Request type

Use one of these values:

• Install
• Submit

Optional Parameters for catalog status

--environment -env

Specifies the target Dataverse. The value may be a Guid or absolute https URL. When not specified, the active organization selected for the current auth profile will be used.

pac catalog submit

Submit catalog approval request.

Required Parameters for catalog submit

--path -p

Path to catalog submission document

Optional Parameters for catalog submit

--environment -env

Specifies the target Dataverse. The value may be a Guid or absolute https URL. When not specified, the active organization selected for the current auth profile will be used.

--package-zip -pz

Path to package zip file.

--poll-status -ps

Poll to check status of your request

This parameter requires no value. It's a switch.

--solution-zip -sz

Path to solution zip file.

pac catalog update

Update settings for the catalog.

Required Parameters for catalog update

--path -p

Path to catalog settings document

Optional Parameters for catalog update

--environment -env

Specifies the target Dataverse. The value may be a Guid or absolute https URL. When not specified, the active organization selected for the current auth profile will be used.

See also

Microsoft Power Platform CLI Command Groups
Microsoft Power Platform CLI overview