> 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/mac.md).

# Mac

This guide shows you how to install CUBE OS on macOS with the One-click Installer. The installer prepares the environment, creates the virtual machine, and starts CUBE OS for you.

{% hint style="info" %}
This guide follows the current one-click installer flow. Some labels may vary by version.
{% endhint %}

### 1. Preparation

{% stepper %}
{% step %}
**Check your Mac**

Make sure your Mac is ready for installation:

* **OS**: A supported macOS version
* **Network**: Stable internet and LAN access
* **Permissions**: Administrator access on macOS
  {% 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 Mac**.

<div align="left"><figure><img src="/files/8ikUzmoafwgYZZMaC5kZ" 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 %}
{% endstep %}
{% endstepper %}

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

{% stepper %}
{% step %}
**Open the installer**

Find the installer in **Downloads** or your chosen folder. Open the package and follow the on-screen steps.

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

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

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

<div align="left"><figure><img src="/files/clnbwXnXu5jskMR4yfUD" 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/wHEYfMCmck0F8NkyHtoO" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

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

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

<div align="left"><figure><img src="/files/g6HdDpqc5ZgJNHamLxLd" 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/Qkczutz0kjtgHZCk8kqB" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

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

The installer creates the CUBE OS virtual machine and starts the setup automatically. Wait until the installation completes.

<div align="left"><figure><img src="/files/BcKyPweCLVdABadoBaXF" 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, CUBE OS starts automatically. When boot completes, note the CUBE OS IP address shown on screen.

<div align="left"><figure><img src="/files/W5bLP7rpVF3TgF1OzSTC" alt="" width="365"><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/bgJF4usZLWXpOAjfthuv" 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/DtNQQlfas25LAQ6xwD5n" 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/mac.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.