Get-DotFiles
SYNOPSIS
Enumerates dotfiles components
SYNTAX
Get-DotFiles [[-Path] <String>] [-Autodetect] [-AllowNestedSymlinks] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Enumerates the available dotfiles components, where each component is represented by a top-level folder in the folder specified by the $DotFilesPath variable or the -Path parameter.
For each component a Component object is returned which specifies the component's basic details, availability, installation state, and other configuration settings.
EXAMPLES
EXAMPLE 1
Get-DotFiles
Enumerates all available dotfiles components and returns a collection of Component objects representing the status of each.
EXAMPLE 2
Get-DotFiles -Autodetect
Enumerates all available dotfiles components, attempting automatic detection of those that lack a metadata file.
PARAMETERS
-Path
Use the specified directory as the dotfiles directory.
This overrides any default specified in $DotFilesPath.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Autodetect
Toggles automatic detection of available components without any metadata.
This overrides any default specified in $DotFilesAutodetect. If neither is specified the default is disabled.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-AllowNestedSymlinks
Toggles allowing directory symlinks to destinations outside of the source component path earlier in the path hierarchy.
This overrides any default specified in $DotFilesAllowNestedSymlinks. If neither is specified the default is disabled.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf
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.