New-ConfigurationManifest

Namespace PSPublishModule

Inputs

None

Outputs

System.Object

Creates a configuration manifest for a PowerShell module.

Remarks

Emits a manifest configuration segment that is later applied to the module .psd1 during a build. Use this to define identity and metadata (version, GUID, author, tags, links) in a build script / JSON pipeline.

Examples

Authored help example

Create a minimal manifest segment

PS>


New-ConfigurationManifest -ModuleVersion '1.0.0' -Guid 'eb76426a-1992-40a5-82cd-6480f883ef4d' -Author 'YourName'

Defines the core identity fields required for a module manifest.

Create a manifest with tags and links

PS>


New-ConfigurationManifest -ModuleVersion '1.0.X' -Guid 'eb76426a-1992-40a5-82cd-6480f883ef4d' -Author 'YourName' -Tags 'PowerShell','Build' -ProjectUri 'https://github.com/YourOrg/YourRepo' -LicenseUri 'https://opensource.org/licenses/MIT'

Populates common PSGallery metadata that shows up on the gallery and in generated docs.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

New-ConfigurationManifest [-AliasesToExport <String[]>] -Author <String> [-CmdletsToExport <String[]>] [-CompanyName <String>] [-CompatiblePSEditions <String[]>] [-Copyright <String>] [-Description <String>] [-DotNetFrameworkVersion <String>] [-FormatsToProcess <String[]>] [-FunctionsToExport <String[]>] -Guid <String> [-IconUri <String>] [-LicenseUri <String>] -ModuleVersion <String> [-PowerShellVersion <String>] [-Prerelease <String>] [-ProjectUri <String>] [-RequireLicenseAcceptance] [-Tags <String[]>] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

AliasesToExport String[] optionalposition: namedpipeline: False: Overrides aliases to export in the module manifest.
Author String requiredposition: namedpipeline: False: Identifies the module author.
CmdletsToExport String[] optionalposition: namedpipeline: False: Overrides cmdlets to export in the module manifest.
CompanyName String optionalposition: namedpipeline: False: Identifies the company or vendor who created the module.
CompatiblePSEditions String[] optionalposition: namedpipeline: False: Specifies the module's compatible PowerShell editions.
Copyright String optionalposition: namedpipeline: False: Specifies a copyright statement for the module.
Description String optionalposition: namedpipeline: False: Describes the module at a high level.
DotNetFrameworkVersion String optionalposition: namedpipeline: False: Specifies the minimum version of the Microsoft .NET Framework that the module requires.
FormatsToProcess String[] optionalposition: namedpipeline: False: Specifies formatting files (.ps1xml) that run when the module is imported.
FunctionsToExport String[] optionalposition: namedpipeline: False: Overrides functions to export in the module manifest.
Guid String requiredposition: namedpipeline: False: Specifies a unique identifier for the module.
IconUri String optionalposition: namedpipeline: False: Specifies the URI for the module's icon.
LicenseUri String optionalposition: namedpipeline: False: Specifies the URI for the module's license.
ModuleVersion String requiredposition: namedpipeline: False: Specifies the version of the module.
PowerShellVersion String optionalposition: namedpipeline: False: Specifies the minimum version of PowerShell this module requires.
Prerelease String optionalposition: namedpipeline: Falsealiases: PrereleaseTag: Specifies the prerelease tag for the module.
ProjectUri String optionalposition: namedpipeline: False: Specifies the URI for the module's project page.
RequireLicenseAcceptance SwitchParameter optionalposition: namedpipeline: False: When set, indicates the module requires explicit user license acceptance (PowerShellGet).
Tags String[] optionalposition: namedpipeline: False: Specifies tags for the module.

Outputs

System.Object