Edit

Add-AppxPackage

  • Reference
Module:
AppX

Adds a signed app package (.appx) to a user account.

Syntax

Add-AppxPackage
   [-Path] <String>
   [-DependencyPath <String[]>]
   [-ForceApplicationShutdown]
   [-InstallAllResources]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Add-AppxPackage
   [-Path] <String>
   [-DependencyPath <String[]>]
   [-Register]
   [-DisableDevelopmentMode]
   [-ForceApplicationShutdown]
   [-InstallAllResources]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Add-AppxPackage
   [-Path] <String>
   [-DependencyPath <String[]>]
   [-ForceApplicationShutdown]
   [-InstallAllResources]
   [-Update]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Add-AppxPackage
   [-Register]
   -MainPackage <String>
   [-DependencyPackages <String[]>]
   [-InstallAllResources]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Add-AppxPackage cmdlet adds a signed app package (.appx) to a user account. Use the DependencyPath parameter to add all other packages that are required for the installation of the app package.

You can use the Register parameter to install from a folder of unpackaged files during development of Windows® Store apps.

To update an already installed package, the new package must have the same package family name.

Examples

Example 1

PS C:\>Add-AppxPackage -Path C:\Users\user1\Desktop\MyApp.appx -DependencyPath C:\Users\user1\Desktop\winjs.appx

This command adds an app package (.appx) that the package contains.

Example 2

PS C:\>$manifestpath = (get-appxpackage -Name "*WindowsCalculator*").InstallLocation + "\Appxmanifest.xml"
PS C:\> Add-AppxPackage -register $manifestpath -DisableDevelopmentMode

This command gets the full path of the package manifest file of an installed Windows Store app, and then registers that package. You can use -DisableDevelopmentMode to register an application that is staged by the StagePackageAsync API, has been disabled, or has become corrupted during testing.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DependencyPackages

Specifies the dependency package full name or dependency package bundle full name to be registered.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-DependencyPath

Specifies the file path of a dependency package that's required for the installation of the app package (.appx or .appxbundle). You can specify the paths to more than one dependency package.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisableDevelopmentMode

Registers an existing app package (.appx or .appxbundle) installation that has been disabled, didn't register, or has become corrupted. Use DisableDevelopmentMode to specify that the manifest is from an existing installation and not from a collection of files in development mode. You can also use this parameter to register an application that the Package Manager APIhttp://go.microsoft.com/fwlink/?LinkId=245447 has staged. Use the -Register parameter to specify the location of the app package manifest .xml file from the installation location.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ForceApplicationShutdown

Forces all active processes that are associated with the package or its dependencies to shut down.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InstallAllResources

Forces the deployment of all resource packages specified from a bundle argument. This overrides the resource applicability check of the deployment engine and forces staging of all resource packages, registration of all resource packages, or staging and registration of all resource packages. This flag can only be used when specifying a resource bundle or resource bundle manifest.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-MainPackage

Specifies the main package full name or bundle full name to be registered.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Path

Specifies the file path of the app package (.appx or .appxbundle).

Type:String
Aliases:PSPath
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Register

Registers an application in development mode. You can use development mode to install applications from a folder of unpackaged files. You can use the Register parameter to test your Windows® Store apps before you deploy them as app packages (.appx). To register an existing app package (.appx) installation, you must specify the DisableDevelopmentMode parameter along with -Register. In order to specify dependency packages, specify the DependencyPath parameter and the DisableDevelopmentMode parameter.

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Update

Specifies that the package being added is a dependency package update. A dependency package is removed from the user account when the parent app is removed. If you do not use -Update, the package being added will be flagged as a primary package and will not be removed from the user account if the parent app is removed. To update an already installed package, the new package must have the same package family name.

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String[]

FileInfo

Outputs

None