> For the complete documentation index, see [llms.txt](https://cube.ewelink.cc/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cube.ewelink.cc/getting-started/quickstart/one-click-installation/windows.md).

# Windows

This guide shows you how to install CUBE OS on Windows with the One-click Installer. The installer sets up VirtualBox, creates the virtual machine, and starts CUBE OS for you.

### 1. Preparation

{% stepper %}
{% step %}
**Check your Windows PC**

Make sure your PC meets these requirements:

* **OS**: Windows 10 or Windows 11, 64-bit
* **CPU**: 2 cores or more
* **Memory**: 4 GB RAM or more
* **Network**: Stable internet and LAN access
* **Permissions**: Administrator access on Windows
*

{% endstep %}

{% step %}
**Download the installer**

Go to the [CUBE OS release page](https://github.com/eWeLinkCUBE/CUBE-OS/releases/latest) and download **One-click Installer for Windows**.

<div align="left"><figure><img src="/files/3gIbeajwmLN7zvwgn6cc" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
**Zigbee Adapter (Optional)**

If you need to add Zigbee devices, prepare a Zigbee Dongle. Tested Zigbee Dongles include:

> SONOFF ZBDongle-MAX\
> SONOFF ZBDongle-PMG24\
> SONOFF ZBDongle-LMG21\
> SONOFF ZBDongle-E\
> SONOFF ZBDongle-P\
> [Others listed](https://darkxst.github.io/silabs-firmware-builder/) by developer @darkxst&#x20;

{% hint style="info" %}
For more information on Zigbee configurations and compatibility, please refer to this [guide](/compatibility-check/zigbee.md).
{% endhint %}

Before connecting the Zigbee adapter to Windows, install the matching USB serial driver for the dongle chipset:

* **CP210x** — [Silicon Labs CP210x USB to UART Bridge VCP Drivers](https://www.silabs.com/developers/usb-to-uart-bridge-vcp-drivers)
* **CH34x** — [WCH CH341/CH34x USB Serial Driver](https://www.wch-ic.com/downloads/CH341SER_EXE.html)

{% hint style="info" %}
If Windows does not detect the dongle in the installer or in VirtualBox, unplug the adapter, install the driver, and then reconnect it.
{% endhint %}
{% endstep %}
{% endstepper %}

### 2. Install CUBE OS with the One-click Installer

{% stepper %}
{% step %}
**Run the installer as administrator**

Find the installer file in **Downloads** or your chosen folder. Right-click it and select **Run as administrator**.

<div align="left"><figure><img src="/files/leG0LTTpJdEnqcqQsjQM" alt="" width="563"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
**Let the installer check VirtualBox**

The installer checks whether VirtualBox is available on your PC. If VirtualBox is not installed, follow the on-screen steps to install it first.

<div align="left"><figure><img src="/files/o0Iqfs94J4oLLS3VxoPM" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
**Set virtual machine resources**

Choose the virtual machine name, memory, and CPU cores. Recommended settings:

* **Memory**: 2048 MB or more
* **CPU**: 2 cores or more

<div align="left"><figure><img src="/files/XBt3IGqcT9W9Ktc9Huks" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
**Select a bridged network adapter**

Choose an active network adapter on your PC. Use a bridged adapter so CUBE OS can join your local network.

<div align="left"><figure><img src="/files/7bQBPglBrXntTwYhJhUz" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
**Optional: Configure USB passthrough**

If you use a Zigbee dongle, select the USB device from the list. If you do not need Zigbee now, skip this step.

<div align="left"><figure><img src="/files/93XFkRQSoPgvgFF3Nqr4" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
**Start the installation**

The installer extracts the required files and creates the CUBE OS virtual machine automatically. Wait until the process finishes, then click **Finish**.

<div align="left"><figure><img src="/files/bg79q3PBkbE7LtebngPr" alt="" width="375"><figcaption></figcaption></figure></div>

<div align="left"><figure><img src="/files/mm548WtwPXGdXbqXxIST" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}
{% endstepper %}

### 3. Boot and access CUBE OS

{% stepper %}
{% step %}
**Wait for CUBE OS to start**

After installation, the virtual machine starts automatically in VirtualBox. When boot completes, the console shows the CUBE OS IP address.

<div align="left"><figure><img src="/files/SFUYnruU5wcnLROOLUcC" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
**Open the CUBE OS web console**

Open a browser on the same network and visit one of these addresses:

* `http://<CUBE_OS_IP>/`
* <http://cube.local>

<div align="left"><figure><img src="/files/dwdKB75MFlaZfEDDue5m" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
**Use the short local address later**

After setup, you can find the short ID on the settings page. You can then use `cube-{short-id}.local` to identify this CUBE OS instance on your LAN.

<div align="left"><figure><img src="/files/reGhws2FrubVMzwxmvdI" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}
{% endstepper %}


---

# 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:

```
GET https://cube.ewelink.cc/getting-started/quickstart/one-click-installation/windows.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
