Skip to content

OSDeploy/RecastOSDCloud

Repository files navigation

OSDCloud

PSGallery Version PSGallery Downloads PowerShell

OSDCloud is a PowerShell module for deploying Windows with cloud-hosted operating system and driver content.

Overview

  • Focused on Windows deployment workflows driven by PowerShell.
  • Supports WinPE startup helpers and deployment UX options.
  • Provides cmdlets for device info, Wi-Fi setup, and module updates in PE.

Requirements

  • PowerShell 5.1 or PowerShell 7+ on Windows
  • Windows or WinPE environment (for PE-specific cmdlets)

Install

# In WinPE
Install-Module -Name OSDCloud -SkipPublisherCheck -Force

# In Windows (elevated session)
Install-Module -Name OSDCloud -Scope AllUsers

Quick start

Import-Module OSDCloud

# Show device hardware information
Show-OSDCloudDeviceInfo

# Launch the interactive deployment experience
Deploy-OSDCloud

Commands

All environments

Cmdlet Description
Deploy-OSDCloud Starts an OS deployment workflow (GUI or CLI mode).
Get-OSDCloudCache Returns the module cache path used for downloaded content.
Get-OSDCloudModulePath Returns the module installation directory.
Get-OSDCloudModuleVersion Returns the loaded module version.
Show-OSDCloudDeviceInfo Displays device hardware and environment information.
Start-OSDCloudExplorer Opens a WinForms file browser (useful in WinPE/WinRE).

WinPE only (SystemDrive == X:)

Cmdlet Alias Description
Invoke-WinPEStartup Runs the full WinPE startup workflow.
Invoke-WinPEStartupManager Invoke-OSDCloudPEStartup Dispatches individual startup actions.
Show-WinPEStartupDevices Show-PEStartupHardware Shows all PnP devices.
Show-WinPEStartupDeviceErrors Show-PEStartupErrors Shows PnP devices with errors.
Show-WinPEStartupIpconfig Show-PEStartupIpconfig Displays ipconfig /all.
Show-WinPEStartupWifi Invoke-OSDCloudWifi Connects to Wi-Fi and waits for DHCP.
Update-WinPEStartupModule Use-PEStartupUpdateModule Updates a module from PSGallery.

Documentation

How-to guides

Task-oriented guides for IT admins. Start at the docs index, or jump straight to a topic:

Guide When to read
docs/01-overview.md Decide whether OSDCloud is the right tool.
docs/02-build-boot-image.md Produce a custom WinPE WIM/ISO.
docs/03-boot-device.md Boot a target device into WinPE (USB / ISO / PXE).
docs/04-deploy-windows.md End-to-end Windows 11 deployment.
docs/05-customize-deployment.md Workflow channels, OS / edition / language, skip steps.
docs/06-unattended-usb-profile.md Zero-touch deployment with a USB JSON profile.
docs/07-arm64-devices.md Deploy to Snapdragon / Surface Pro 11 / Copilot+ PCs.
docs/08-autopilot-oobe.md Hand off to OOBE and Autopilot.
docs/09-troubleshooting.md Diagnose a failed deployment.

Function reference

Reference page Function
OSDCloud/docs/Deploy-OSDCloud.md Deploy-OSDCloud
OSDCloud/docs/Get-OSDCloudCache.md Get-OSDCloudCache
OSDCloud/docs/Get-OSDCloudModulePath.md Get-OSDCloudModulePath
OSDCloud/docs/Get-OSDCloudModuleVersion.md Get-OSDCloudModuleVersion
OSDCloud/docs/Show-OSDCloudDeviceInfo.md Show-OSDCloudDeviceInfo
OSDCloud/docs/Start-OSDCloudExplorer.md Start-OSDCloudExplorer

WinPE startup cmdlets are currently documented through in-module help. In WinPE, run Get-Help <CmdletName> -Detailed for usage details.

External links

Release notes

See CHANGELOG.md for module release history.

Privacy policy

OSDCloud sends anonymous deployment analytics during workflow execution. See PRIVACY.md for details on what data is collected and how to opt out.

Contributing

See CONTRIBUTING.md.

License

See LICENSE.

About

OSDCloud PowerShell Module

Resources

Contributing

Stars

Watchers

Forks

Contributors

Languages