> ## Documentation Index
> Fetch the complete documentation index at: https://docs.qbrin.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Install

> Install companyOS Twin on macOS, Windows or Linux, or build it from source

Installers come from the GitHub Releases page once a release is published. No release has been published yet, so there is nothing to download today. See [Releasing](https://docs.qbrin.com/releasing.md) for how a release is made. You can build the app from source in the meantime.

## macOS

* **Architecture.** Builds are for Apple silicon (arm64) only. Intel Macs are not supported by the current builds.
* **Download.** Once a release is published, download the `.dmg` from the Releases page, open it and drag the app into Applications.
* **Signing.** Release builds are signed with a Developer ID certificate and notarised by Apple, so macOS opens them without a warning. No signed release is published yet. Until one is, a build from source runs on your own Mac, but macOS may still warn about it.
* **Permission.** On first capture macOS asks for Automation permission for System Events. The app uses it only to read the name of the app in front. Without it, app capture does not run.

## Windows

* **Architecture.** The installer is an NSIS `.exe` for 64-bit Windows.
* **Signing.** Installers are not code-signed yet, so SmartScreen may warn. Choose **More info**, then **Run anyway**, only if you trust the download.
* **Browser capture.** Not available on Windows yet, because the native messaging host is not registered there.

## Linux

* **Packages.** The build produces a `.deb` and an `.rpm`.
* **Session.** It needs an X11 session with `DISPLAY` set, with `xdotool` and `xprop` installed (on Debian and Ubuntu, `xprop` comes from the `x11-utils` package). Wayland is not supported, so app capture does not run there.
* **Keyring.** The app needs a keyring that Electron can use, such as GNOME Keyring or KWallet. Without one it does not start, because it cannot protect its data key.

## Build from source

You need Node.js 22 or later.

```bash theme={null}
npm ci
npm run dist:dir
```

`npm run dist:dir` builds an unpacked app for the current operating system in `apps/desktop/release`. `npm run dist` builds the installers. See [Development](https://docs.qbrin.com/development.md) for the other commands.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.