Set-OctopusToolsFolder

NAME Set-OctopusToolsFolder



SYNOPSIS

This cmdlet sets the path of the "Octopus Tools Folder". This folder is where Install-OctopusTool will download

Octo.exe, and its also from where Get-OctopusToolVersion will resolve the path of the downloaded Octo.exe versions.



For Get-OctopusToolVersion to be able to find Octo.exe version inside of the "Octopus Tools Folder", the folder

structure must be like this:



["Octopus Tools Folder"]\\[Child Folder]\\Octo.exe



For example, given the following structure:



["Octopus Tools Folder"]\\1.0.0\\Octo.exe



["Octopus Tools Folder"]\\SomeFolderName\\Octo.exe



["Octopus Tools Folder"]\\SomeFolderName\\AnotherFolder\\Octo.exe



The first 2 Octo.exe versions will be properly discovered, but the 3rd one wont because its not on the root of a

direct child of the "Octopus Tools Folder"





SYNTAX

Set-OctopusToolsFolder [-Path] <string> [<CommonParameters>]





DESCRIPTION

This cmdlet sets the path of the "Octopus Tools Folder". This folder is where Install-OctopusTool will download

Octo.exe, and its also from where Get-OctopusToolVersion will resolve the path of the downloaded Octo.exe versions.



For Get-OctopusToolVersion to be able to find Octo.exe version inside of the "Octopus Tools Folder", the folder

structure must be like this:



["Octopus Tools Folder"]\\[Child Folder]\\Octo.exe



For example, given the following structure:



["Octopus Tools Folder"]\\1.0.0\\Octo.exe



["Octopus Tools Folder"]\\SomeFolderName\\Octo.exe



["Octopus Tools Folder"]\\SomeFolderName\\AnotherFolder\\Octo.exe



The first 2 Octo.exe versions will be properly discovered, but the 3rd one wont because its not on the root of a

direct child of the "Octopus Tools Folder"





PARAMETERS

-Path <string>

Sets the path of the "Octopus Tools folder".



Required? true

Position? 0

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

None





---------- EXAMPLE 1 ----------



PS C:\\> Set-OctopusToolsFolder -path C:\\tools



Sets the "Octopus Tools Folder" to "C:\\Tools"



RELATED LINKS

WebSite: http://Octoposh.net

Github Project: https://github.com/Dalmirog/OctoPosh/

Wiki: http://octoposh.readthedocs.io

QA and Feature requests: https://gitter.im/Dalmirog/OctoPosh#initial