Keldor

Keldor is a PowerShell automation toolkit for systems administration, help desk operations, and enterprise engineering workflows.

Why Keldor

• 330+ automation-focused functions
• Active Directory and infrastructure operations support
• Platform-aware loading for Windows, macOS, and Linux
• Utility functions for remediation, reporting, and conversions
• Reusable snippets and helper tooling for day-to-day admin work

Quick Start

Prerequisites

1. Windows PowerShell 5.1 on a Microsoft-supported Windows version, or a Microsoft-supported PowerShell 7 release beginning with PowerShell 7.4
2. Optional modules/features based on function usage:
   • ActiveDirectory module
   • NetIQ DRA PowerShell REST Extensions
   • LAPS (AdmPwd.PS)
   • Microsoft.Exchange.Management.PowerShell.Admin (for Exchange-specific commands)

Install

Install for all users:

Install-Module Keldor

Install for current user only:

Install-Module Keldor -Scope CurrentUser

Configuration

Secret retrieval

Use Get-KeldorSecret or its Get-KDSecret alias to retrieve plaintext secrets through Keldor's provider abstraction. The default Auto provider tries OnePassword CLI, Microsoft.PowerShell.SecretManagement, and KELDOR_SECRET_<NAME> environment variables in that order.

Use Set-KeldorSecret or its Set-KDSecret alias to write secrets through the same provider model. Writes use one selected provider only; the Environment provider writes process-scoped variables that disappear when the process exits.

Use Remove-KeldorSecret or its Remove-KDSecret alias to remove a secret from one selected provider. Environment removals affect only the current process and do not remove values configured outside the current PowerShell process.

Use Get-KeldorSecretProvider or its Get-KDSecretProvider alias to inspect the secret providers known to Keldor, their auto-selection priority, and non-sensitive availability details.

Use Test-KeldorSecretProvider or its Test-KDSecretProvider alias to run safe, read-only operational checks against one or more providers without retrieving, creating, modifying, or removing secrets.

Initial configuration

Run the config command and update values for your environment:

Set-WSToolsConfig

The command name is retained for backward compatibility. It opens the Keldor config file so you can tune paths and environment-specific settings.

Remote patch settings

For remote .msu installation workflows, edit InstallRemote.ps1 in your installed module path and set $PatchFolderPath to your remote patch directory.

Platform-Aware Loading

Keldor loads functions based on the OS importing the module:

• Common functions load on all platforms
• Windows functions load only on Windows
• macOS functions load only on macOS
• Linux functions load only on Linux

If platform detection returns Unknown, Keldor loads the Common command layer only. Unsupported PowerShell editions and versions fail module import before configuration or command loading.

PowerShell Compatibility

Keldor supports Windows PowerShell 5.1 on Windows versions that remain supported by Microsoft. Keldor also supports Microsoft-supported PowerShell 7 release lines beginning with PowerShell 7.4. Retired PowerShell releases are not supported. PowerShell 7.6 LTS is the preferred development, automation, and CI runtime.

The current tested Core lines are PowerShell 7.4, 7.5, and 7.6. This list is lifecycle-bound, not permanent. See the compatibility policy and lifecycle review policy.

Module folder structure

Public/
  Common/
  Windows/
  macOS/
  Linux/
Private/
  Common/
  Windows/
  macOS/
  Linux/

Functions in Public are exported. Functions in Private are internal helpers and are not exported.

Cross-Platform System Information

Use Get-KeldorSystemInfo for a normalized local inventory object, or use its focused feeder commands independently:

Get-KeldorSystemInfo
Get-KeldorOperatingSystem
Get-KeldorLinuxDistribution
Get-KeldorKernel
Get-KeldorUptime
Get-KeldorHardwareInfo

The commands return structured objects with native dates, durations, numbers, and stable Keldor type names. They also support configured PowerShell-remoting targets and reusable PSSession objects. See the system-information architecture for contracts and remote limitations.

Remote Command Orchestration

Use Invoke-KeldorCommand as Keldor's canonical local and remote execution entry point:

Invoke-KeldorCommand -Local -ScriptBlock { Get-KeldorSystemInfo }

'server01', 'server02' |
    Invoke-KeldorCommand -ScriptBlock { Get-KeldorSystemInfo }

It supports local execution, caller-owned PSSession reuse, WSMan through ComputerName, and PowerShell remoting over SSH through HostName on supported PowerShell 7 runtimes. Structured per-target results are the default; RawOutput is opt-in. Keldor does not enable remoting, configure SSH or firewalls, modify TrustedHosts, persist credentials, or install Keldor remotely. See the remote command orchestration architecture.

Adding Functions

• Add cross-platform exported functions to Public/Common
• Add Windows-only exported functions to Public/Windows
• Add macOS-only exported functions to Public/macOS
• Add Linux-only exported functions to Public/Linux
• Add internal helpers to matching Private/* folders
• Follow the Keldor PowerShell Engineering Standard

Build Tooling

Reusable build implementation is maintained in Keldor.Build.PowerShell. This repository keeps only build.config.psd1 and a thin build.ps1 entry point. Install the pinned build dependency, then build from the repository root:

Install-Module Keldor.Build.PowerShell -RequiredVersion 0.2.0 -Scope CurrentUser
./build.ps1 -Task Build

The build dependency is not a runtime dependency and is excluded from the published Keldor package. See Local Development for the explicit unpublished-module override.

Visual Studio Code Snippets

To load Keldor PowerShell snippets, run:

Set-PowerShellJSON

Or manually copy powershell.json from the module folder into your user snippets location.

Workspace snippets are also available in .vscode/Keldor.code-snippets when this repository is open in VS Code.

Documentation

• Engineering Standards
• Keldor General Engineering Standard
• Keldor PowerShell Engineering Standard
• Versioning Policy
• Release Process
• Canonical Publishing Runbook
• PowerShell Compatibility
• PowerShell Lifecycle Review
• Cross-Platform System Information
• Remote Command Orchestration
• Docs site: https://docs.keldor.dev
• Repository: https://github.com/keldor-dev/Keldor

Issues and Requests

Open an issue for bugs, requests, or ideas:

https://github.com/keldor-dev/Keldor/issues