Skip to content

Latest commit

 

History

History
172 lines (119 loc) · 3.34 KB

Update-PSKoan.md

File metadata and controls

172 lines (119 loc) · 3.34 KB
external help file Module Name online version schema
PSKoans-help.xml
PSKoans
2.0.0

Update-PSKoan

SYNOPSIS

Update the user Koan directory with new topics and koans.

SYNTAX

TopicOnly (Default)

Update-PSKoan [-Topic <String[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

ModuleOnly

Update-PSKoan [-Topic <String[]>] -Module <String[]> [-WhatIf] [-Confirm] [<CommonParameters>]

IncludeModule

Update-PSKoan [-Topic <String[]>] -IncludeModule <String[]> [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Update the user Koan directory with new topics. Topics will be moved to new directories if appropriate. Old files will be removed.

Existing koan topics are updated with new koans. Progress is preserved as much as possible.

EXAMPLES

Example 1

PS C:\> Update-PSKoan -Topic AboutCompareObject

The topic AboutCompareObject will be added if it is not already present. If it is already present, the current copy will be compared to the base module copy. If any koans are missing from the user's copy, they will be added. If any koans have been removed from the module copy, they will be removed from the user's copy.

Example 2

PS C:\> Update-PSKoan

All missing topics and koans will be copied from the module.

PARAMETERS

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-IncludeModule

Update the default PowerShell Koans as well as Koans for the specified module. Wildcards are supported.

Type: String[]
Parameter Sets: IncludeModule
Aliases:

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

-Module

Update Koans in the specified module only. Wildcards are supported.

Type: String[]
Parameter Sets: ModuleOnly
Aliases:

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

-Topic

Updates the specified topic from the module. Wildcards are supported.

Type: String[]
Parameter Sets: (All)
Aliases: Koan, File

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

-WhatIf

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

OUTPUTS

System.Void

NOTES

Author: Chris Dent (@indented-automation)

RELATED LINKS

Get-PSKoan

Reset-PSKoan

PSKoans