Skip to content

Latest commit

 

History

History
304 lines (164 loc) · 8.72 KB

package.md

File metadata and controls

304 lines (164 loc) · 8.72 KB
Raw
title description keywords ms.subservice author ms.author ms.date ms.reviewer ms.topic contributors
Microsoft Power Platform CLI package command group| Microsoft Docs
Describes commands and parameters for the Microsoft Power Platform CLI package command group.
pac cli
developer
devkeydet
marcsc
5/13/2024
jdaly
reference
JimDaly

pac package

Commands for working with Dataverse package projects

[!INCLUDE package-intro]

Commands

Command Description
pac package add-external-package Adds a package that is external to the Dataverse solution system to a Package Deployer Package project.
pac package add-reference Adds reference to Dataverse solution project
pac package add-solution Adds a prebuilt Dataverse solution file to a Package Deployer Package project.
pac package deploy Deploys package to Dataverse
pac package init Initializes a directory with a new Dataverse package project
pac package show Shows details of Dataverse package

pac package add-external-package

Adds a package that is external to the Dataverse solution system to a Package Deployer Package project.

[!INCLUDE package-add-external-package-intro]

Required Parameters for package add-external-package

--package-type -t

The type of the package being added. For example: 'xpp' for FnO packages.

--path -p

Path to the external package

Optional Parameters for package add-external-package

--import-order

A whole number that indicates the order to insert this item into the final ImportConfig.xml file at build time. Negative numbers are inserted before existing elements. Positive numbers are added after existing elements.

--skip-validation -sv

Adds the item to the project file even if the file doesn't exist or appears to be invalid. Note: Using this doesn't affect any validation performed by MSBuild.

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

[!INCLUDE package-add-external-package-remarks]

pac package add-reference

Adds reference to Dataverse solution project

[!INCLUDE package-add-reference-intro]

Required Parameters for package add-reference

--path -p

The path to the referenced Dataverse solution project

Optional Parameters for package add-reference

--dependency-overrides

A semicolon delimited list of overrides. This value overrides any dependency information encoded in the solution's metadata. Each override should be in the format: <uniquename>:<minVersion>:<maxVersion>. Where minVersion and maxVersion are optional but should be in .NET version format syntax.

Note: Use a semicolon delimited list of dependency overrides of the format <uniquename>:<minVersion>:<maxVersion>.

--import-mode

Explicitly specifies the required mode when importing this solution.

Use one of these values:

  • sync
  • async

--import-order

A whole number that indicates the order to insert this item into the final ImportConfig.xml file at build time. Negative numbers are inserted before existing elements. Positive numbers are added after existing elements.

--missing-dependency-behavior

Specifies the behavior on import when a dependency of this solution is missing from the target environment.

Use one of these values:

  • skip
  • fault

--overwrite-unmanaged-customizations

Explicitly indicates whether to overwrite unmanaged customizations when this solution is imported.

Use one of these values:

  • true
  • false

--publish-workflows-activate-plugins

Explicitly indicates whether to publish the workflows and activate plug-ins when this solution is imported.

Use one of these values:

  • true
  • false

[!INCLUDE package-add-reference-remarks]

pac package add-solution

Adds a prebuilt Dataverse solution file to a Package Deployer Package project.

[!INCLUDE package-add-solution-intro]

Required Parameters for package add-solution

--path -p

Path to the Dataverse solution file. The file must be a compressed ZIP file.

Optional Parameters for package add-solution

--dependency-overrides

A semicolon delimited list of overrides. This value overrides any dependency information encoded in the solution's metadata. Each override should be in the format: <uniquename>:<minVersion>:<maxVersion>. Where minVersion and maxVersion are optional but should be in .NET version format syntax.

Note: Use a semicolon delimited list of dependency overrides of the format <uniquename>:<minVersion>:<maxVersion>.

--import-mode

Explicitly specifies the required mode when importing this solution.

Use one of these values:

  • sync
  • async

--import-order

A whole number that indicates the order to insert this item into the final ImportConfig.xml file at build time. Negative numbers are inserted before existing elements. Positive numbers are added after existing elements.

--missing-dependency-behavior

Specifies the behavior on import when a dependency of this solution is missing from the target environment.

Use one of these values:

  • skip
  • fault

--overwrite-unmanaged-customizations

Explicitly indicates whether to overwrite unmanaged customizations when this solution is imported.

Use one of these values:

  • true
  • false

--publish-workflows-activate-plugins

Explicitly indicates whether to publish the workflows and activate plug-ins when this solution is imported.

Use one of these values:

  • true
  • false

--skip-validation -sv

Adds the item to the project file even if the file doesn't exist or appears to be invalid. Note: Using this doesn't affect any validation performed by MSBuild.

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

[!INCLUDE package-add-solution-remarks]

pac package deploy

Deploys package to Dataverse

[!INCLUDE package-deploy-intro]

Optional Parameters for package deploy

--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.

--logConsole -c

Output log to console

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

--logFile -lf

Log file path

--package -p

Path to a package dll or zip file with a package.

--settings -s

Runtime Package Settings that are passed to the package that is being deployed. The format of the string must be key=value|key=value.

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

--solution -sz

Path to the Dataverse solution file. The file must be a compressed ZIP or CAB file.

--verbose -vdbg

Emit verbose logs to the log outputs.

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

[!INCLUDE package-deploy-remarks]

pac package init

Initializes a directory with a new Dataverse package project

[!INCLUDE package-init-intro]

Optional Parameters for package init

--outputDirectory -o

Output directory

--package-name

Sets the default name of the package. Applies to the generation of ImportExtension.GetNameOfImport.

[!INCLUDE package-init-remarks]

pac package show

Shows details of Dataverse package

[!INCLUDE package-show-intro]

Required Parameters for package show

--package -p

Path to a package dll or zip file with a package.

Optional Parameters for package show

--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.

--logFile -lf

Log file path

--verbose -vdbg

Emit verbose logs to the log outputs.

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

[!INCLUDE package-show-remarks]

[!INCLUDE package-remarks]

See also

Microsoft Power Platform CLI Command Groups
Microsoft Power Platform CLI overview