Install-MaesterTests

Synopsis

Not needed from Maester 3.0. Prepares a folder for your own Maester tests and configuration.

Syntax

Install-MaesterTests [[-Path] <String>] [-SkipPesterCheck] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

Description

From Maester 3.0 the tests that ship with Maester run from the module itself, so updating the module updates them, and Maester needs no tests folder or repository: Invoke-Maester runs the built-in tests from any folder. You can remove Install-MaesterTests from your scripts and pipelines.

It is kept so that existing scripts keep working. It writes custom/README.md and a starter maester-config.json when they are missing. It never writes a test file and never overwrites an existing file, so it is safe to call on every pipeline run.

To add your own tests, run New-MtTest, which creates the custom folder. To change settings, create a maester-config.json with only the settings you change. Run Invoke-Maester -Path <folder> to run the built-in tests together with the custom tests and config in that folder.

Examples

Example 1

Install-MaesterTests -Path ./maester

Creates ./maester with custom/README.md and maester-config.json.

Parameters

-Path

The folder to prepare. Defaults to the current directory.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: .
Accept pipeline input: False
Accept wildcard characters: False

-SkipPesterCheck

No longer has any effect. Maester 3.0 does not install Pester; install it yourself only if you run Pester-format custom tests.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-ProgressAction

Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by Write-Progress.

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

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

Outputs

Notes

https://maester.dev/docs/commands/Install-MaesterTests