Install¶
This repository contains a folder named Armor. The folder needs to be installed into one of your PowerShell Module Paths using one of the installation methods outlined in the next section. To see the full list of available PowerShell Module paths, use $Env:PSModulePath.Split( ';' )
in a PowerShell terminal window.
Common PowerShell module paths include:
- Current User:
%USERPROFILE%\Documents\WindowsPowerShell\Modules\
- All Users:
%ProgramFiles%\WindowsPowerShell\Modules\
- OneDrive:
$Env:OneDrive\Documents\WindowsPowerShell\Modules\
Option 1: PowerShell Gallery Installation (Recommended)¶
- Ensure you have the Windows Management Framework 5.0 or greater installed.
- Open a Powershell console with the Run as Administrator option.
- Run
Set-ExecutionPolicy
using the parameter RemoteSigned or Bypass. - Run
Install-Module -Name Armor -Scope CurrentUser
to download the module from the PowerShell Gallery. Note that the first time you install from the remote repository it may ask you to first trust the repository.
Option 2: PowerShell Gallery Download¶
- Ensure you have the Windows Management Framework 5.0 or greater installed.
- Open a Powershell console with the Run as Administrator option.
- Run
Set-ExecutionPolicy
using the parameter RemoteSigned or Bypass. - Run
Save-Module -Name Armor -Path <path>
to download the module from the PowerShell Gallery. Note that the first time you install from the remote repository it may ask you to first trust the repository. - Copy the contents of the Armor module folder onto your workstation into the desired PowerShell Module path.
Option 3: Manual Installation¶
- Download the master branch to your workstation.
- Copy the contents of the Armor folder onto your workstation into the desired PowerShell Module path.
- Open a Powershell console with the Run as Administrator option.
- Run
Set-ExecutionPolicy
using the parameter RemoteSigned or Bypass.
Verification¶
PowerShell will create a folder for each new version of any module you install. It’s a good idea to check and see what version(s) you have installed and running in the session. To begin, let’s see what versions of the Armor Module are installed:
Get-Module -ListAvailable -Name Armor
The -ListAvailable
switch will pull up all installed versions from any path found in $Env:PSModulePath
. Check to make sure the version you wanted is installed. You can safely remove old versions, if desired.
To see which version is currently loaded, use:
Get-Module -Name Armor
If nothing is returned, you need to first load the module by using:
Import-Module -Name Armor
If you wish to load a specific version, use:
Import-Module -Name Armor -RequiredVersion #.#.#.#
Where “#.#.#.#” represents the version number.