Install-DotFiles
SYNOPSIS
Installs dotfiles components
SYNTAX
Retrieve (Default)
Install-DotFiles [-Path <String>] [-Autodetect] [-AllowNestedSymlinks] [-WhatIf] [-Confirm]
[<CommonParameters>]
Pipeline
Install-DotFiles -Components <Component[]> [-AllowNestedSymlinks] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Installs all available dotfiles components, or the nominated subset provided via a collection of Component objects as previously returned by the Get-DotFiles cmdlet.
For each installed component a Component object is returned which specifies the component's basic details, availability, installation state, and other configuration settings.
EXAMPLES
EXAMPLE 1
Install-DotFiles
Installs all available dotfiles components and returns a collection of Component objects representing the status of each.
EXAMPLE 2
Get-DotFiles | ? Name -in git, vim | Install-DotFiles
Installs only the git and vim dotfiles components, as provided by a filtered set of the components returned by Get-DotFiles.
PARAMETERS
-Path
Use the specified directory as the dotfiles directory.
This overrides any default specified in $DotFilesPath.
Type: System.String
Parameter Sets: Retrieve
Aliases:
Required: False
Position: Named
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: Retrieve
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Components
A collection of Component objects to be installed as previously returned by Get-DotFiles.
Note that only the Component objects with an appropriate Availability state will be installed.
Type: Component[]
Parameter Sets: Pipeline
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
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.