The PowerShell Gallery is the easiest way to install the module. If not present, you must install PowerShell before proceeding.

The module included on the PowerShell Gallery is signed and requires an ExecutionPolicy of RemoteSigned or lower. If your ExecutionPolicy is set to Restricted you will not be able to install the module from the PowerShell Gallery. You can check your current ExecutionPolicy with Get-ExecutionPolicy and change it to RemoteSigned using Set-ExecutionPolicy.

Get-ExecutionPolicy

Use the Install-Module command to download and install the module under your user account.

Install-Module -Name PSFalcon -Scope CurrentUser

You may be prompted with a warning that the PowerShell Gallery is an untrusted repository. You can accept and continue to install the module. You can permanently change this using Set-PSRepository. You may also be prompted to update your NuGet package to interact with the PowerShell Gallery. This is the method that the gallery uses to install modules and is required to use it.

If you're running an older version of PSFalcon, you must include the -Force parameter to verify that you'd like to install the latest version alongside the old version. You can use Uninstall-Module -Name PSFalcon -AllVersions to remove all existing versions of the module.

If the PowerShell Gallery isn't accessible in your environment or the installation failed, you can try a manual Installation.

Once you have completed the installation, you must import the module every time you intend to use it.

If you're unable to use the PowerShell Gallery to install the module, you can download directly from GitHub. If the installation from the PowerShell Gallery worked, there's no need to follow any of the steps included in this section.

1. Download the latest release as a ZIP
2. Unpack the archive and move the contents of the folder into your User Modules directory

NOTE: These commands assume you are running in a standard user (non-admin) PowerShell session and do not have Folder Redirection enabled. Unpacking the module in the wrong place will lead to various errors that can prevent you from importing the module or running various commands.

NOTE: You may receive an error about the destination folders not existing when attempting to move the module files. If you do, create the folders first then move the module files into them.

Read more about Installing PowerShell Modules.

• Linux/MacOS

Expand-Archive ./psfalcon-<version>.zip .
Move-Item ./psfalcon-<version>/ $HOME/.local/share/powershell/Modules/PSFalcon/<version>/ -Force

• Windows (PowerShell Core/6+)

Expand-Archive .\psfalcon-<version>.zip .
Move-Item .\psfalcon-<version>\ $HOME\Documents\PowerShell\Modules\PSFalcon\<version>\ -Force

• Windows (PowerShell Desktop/5.1)

Expand-Archive .\psfalcon-<version>.zip .
Move-Item .\psfalcon-<version>\ $HOME\Documents\WindowsPowerShell\Modules\PSFalcon\<version>\ -Force

If done correctly, your PSFalcon\<version> module folder will look like this:

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
d----           1/26/2021 10:40 AM                Class
d----           1/26/2021 10:40 AM                Private
d----           1/26/2021 10:40 AM                Public
-----           1/25/2021 10:37 AM           1946 LICENSE
-----           1/25/2021 10:37 AM          10838 PSFalcon.psd1
-----           1/25/2021 10:37 AM            944 PSFalcon.psm1
-----           1/25/2021 10:37 AM           1322 README.md

The PSFalcon module must be loaded at the beginning of a PowerShell session or script in order to access the commands included with PSFalcon.

NOTE: The Import-Module command can be added to your PowerShell $PROFILE to automatically load the module when you start PowerShell.

Import-Module -Name PSFalcon

#Requires -Version 5.1 -Modules @{ModuleName='PSFalcon';ModuleVersion='<version>'}

• Set $VerbosePreference and $DebugPreference to 'Continue'
• Run Start-Transcript, Show-FalconModule, the affected PSFalcon commands or script, and Stop-Transcript
• Create an issue on GitHub

If you have “Folder Redirection” in place, the $HOME folder may not be properly recognized by PowerShell. In these cases, you can extract PSFalcon and import the module directly.

Expand-Archive .\psfalcon-<version>.zip .
Move-Item .\psfalcon-<version>\ .\PSFalcon
Import-Module .\PSFalcon