Diagrammer.Core is a PowerShell module which provides the core framework for generating as built diagrams for many common datacenter systems. The Diagrammer.Core module is required by each individual diagrammer module used to generate as built diagrams for a specific product and/or technology.
The following simple list of instructions will get you started with the Diagrammer.Core module.
This module is compatible with the following PowerShell versions;
| Windows PowerShell 5.1 | PowerShell 7 |
|---|---|
| ✅ | ✅ |
PowerShell 5.1, and the following PowerShell modules are required for generating a Diagrammer.Core diagram.
For an online installation, install the Diagrammer.Core module using the PowerShell Gallery;
# Install Diagrammer.Core module
Install-Module -Name 'Diagrammer.Core' -Repository 'PSGallery' -Scope 'CurrentUser'For an offline installation, perform the following steps from a machine with internet connectivity;
Save the required Diagrammer.Core module to a specified folder.
# Save Diagrammer.Core module
Save-Module -Name 'Diagrammer.Core' -Repository 'PSGallery' -Path '<Folder Path>'Copy the downloaded Diagrammer.Core module folder to a location that can be made accessible to the offline system.
e.g. USB Flash Drive, Internal File Share etc.
On the offline system, open a PowerShell console window and run the following command to determine the PowerShell module path.
Windows
$env:PSModulePath -Split ';'macOS & Linux
$env:PSModulePath -Split ':'Copy the downloaded Diagrammer.Core module folder to a folder specified in the $env:PSModulePath output.
If you are unable to use the PowerShell Gallery, you can still install the Diagrammer.Core module manually. Ensure you repeat the following steps for the system requirements also.
- Download the latest release zip from GitHub
- Extract the zip file
- Copy the folder
Diagrammer.Coreto a path that is set in$env:PSModulePath. - For Windows users only, open a PowerShell terminal window and unblock the downloaded files with
$path = (Get-Module -Name Diagrammer.Core -ListAvailable).ModuleBase; Unblock-File -Path $path\*.psd1; Unblock-File -Path $path\Src\Public\*.ps1
- Close and reopen the PowerShell terminal window.
Note: You are not limited to installing the module to those example paths, you can add a new entry to the environment variable PSModulePath if you want to use another path.