Module manifest (.psd1) in PowerShell - Step-by-Step Execution

Concept Flow - Module manifest (.psd1)

Create .psd1 file

↓

Define metadata keys

↓

Set values for keys

↓

Save manifest file

↓

Import module using manifest

↓

Module loads with metadata

This flow shows how a PowerShell module manifest file (.psd1) is created, filled with metadata, saved, and then used to load a module with that metadata.

Execution Sample

PowerShell

@{
  ModuleVersion = '1.0.0'
  GUID = '12345678-1234-1234-1234-123456789abc'
  Author = 'Jane Doe'
  Description = 'Sample module manifest'
}

This code defines a simple PowerShell module manifest with version, GUID, author, and description.

Execution Table

Step	Action	Key/Value Set	Result
1	Create new hashtable for manifest	N/A	Empty hashtable created
2	Set ModuleVersion	ModuleVersion = '1.0.0'	Version key added
3	Set GUID	GUID = '12345678-1234-1234-1234-123456789abc'	GUID key added
4	Set Author	Author = 'Jane Doe'	Author key added
5	Set Description	Description = 'Sample module manifest'	Description key added
6	Save hashtable to .psd1 file	N/A	Manifest file saved
7	Import module using manifest	N/A	Module loads with metadata

💡 All keys set and manifest saved; module imported successfully

Variable Tracker

Variable	Start	After Step 2	After Step 3	After Step 4	After Step 5	Final
$Manifest	empty	{ModuleVersion='1.0.0'}	{ModuleVersion='1.0.0', GUID='12345678-1234-1234-1234-123456789abc'}	{ModuleVersion='1.0.0', GUID='12345678-1234-1234-1234-123456789abc', Author='Jane Doe'}	{ModuleVersion='1.0.0', GUID='12345678-1234-1234-1234-123456789abc', Author='Jane Doe', Description='Sample module manifest'}	saved to .psd1 file

Key Moments - 3 Insights

Why do we use a hashtable to create a module manifest?

Because the manifest file (.psd1) is a PowerShell data file that stores key-value pairs in a hashtable format, as shown in the execution_table steps 1-5.

What happens if the GUID is missing or incorrect?

The module may not load correctly or could conflict with other modules. The GUID uniquely identifies the module, as shown in step 3 of the execution_table.

Can we add custom keys to the manifest?

No, the manifest supports specific predefined keys. Adding unknown keys will be ignored or cause errors. The execution_table shows only standard keys being set.

Visual Quiz - 3 Questions

Look at the execution_table, what is the value of the 'Author' key after step 4?

A 'Jane Doe'

B 'John Smith'

C Empty

D 'Sample module manifest'

💡 Hint

Check the 'Key/Value Set' column at step 4 in the execution_table.

At which step is the manifest file saved to disk?

A Step 5

B Step 7

C Step 6

D Step 3

💡 Hint

Look for the action mentioning saving the manifest file in the execution_table.

If we remove the GUID key, what is the likely effect when importing the module?

A Module imports normally without issues

B Module import fails or conflicts may occur

C Author information is lost

D Module version resets to 0.0.0

💡 Hint

Refer to the key_moments section about the importance of the GUID.

Concept Snapshot

Module manifest (.psd1) is a PowerShell data file storing module metadata as a hashtable.
Keys like ModuleVersion, GUID, Author, and Description define module info.
Create a hashtable with these keys, then save it as a .psd1 file.
Importing the module uses this manifest to load metadata and settings.
GUID uniquely identifies the module; missing it can cause load issues.

Full Transcript

A PowerShell module manifest is a .psd1 file that holds metadata about a module. It is created as a hashtable with keys such as ModuleVersion, GUID, Author, and Description. Each key is assigned a value describing the module. After setting these keys, the hashtable is saved to a .psd1 file. When the module is imported, PowerShell reads this manifest to load the module with its metadata. The GUID is important because it uniquely identifies the module and prevents conflicts. This process ensures the module is properly described and loaded.