> For the complete documentation index, see [llms.txt](https://www.osdeploy.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.osdeploy.com/powershell-modules/osdcloud/deploy-osdcloud.md).

# Deploy-OSDCloud

Starts an OSDCloud operating system deployment.

| Property | Value                 |
| -------- | --------------------- |
| Module   | OSDCloud              |
| Platform | WinPE (amd64 / arm64) |
| Requires | OSDCloud module       |

## Description

Initializes and runs an OSDCloud deployment workflow. By default, launches the graphical UI (UX) so the operator can configure deployment settings before starting. Use `-CLI` to skip the UI and run the workflow immediately in the current console session.

OSDCloud collects anonymous analytic data about the deployment environment and system configuration to help improve the product. No personally identifiable information (PII) is collected. By using OSDCloud you consent to this collection as described in the [privacy policy](https://github.com/OSDeploy/OSDCloud/blob/main/PRIVACY.md).

## Syntax

```powershell
Deploy-OSDCloud [[-WorkflowName] <String>] [-CLI] [<CommonParameters>]
```

## Parameters

| Parameter       | Type     | Required | Description                                                                                                                              |
| --------------- | -------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `-WorkflowName` | `String` | No       | The name of the OSDCloud workflow to run. Default: `default`. Alias: `Name`. Available workflows are in the module's `workflow\` folder. |
| `-CLI`          | `Switch` | No       | Skips the graphical UX and runs the deployment workflow immediately in the current console session.                                      |

## Examples

```powershell
# Launch the graphical UX for the default workflow
Deploy-OSDCloud
```

```powershell
# Run the default workflow immediately without the UX
Deploy-OSDCloud -CLI
```

```powershell
# Launch the graphical UX for the 'latest' workflow
Deploy-OSDCloud -WorkflowName 'latest'
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://www.osdeploy.com/powershell-modules/osdcloud/deploy-osdcloud.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.