---
title: 'Get started'
url: 'https://bimreviera.com/get-started'
markdown: 'https://bimreviera.com/get-started.md'
date: '2026-11-05'
description: "Installing Linux: flatpak install --user BIM-Riviera-0.1.0-pre.11-x86_64.flatpak Windows: run the installer, or unzip the portable build and start riviera.exe. macOS (Apple silicon): open the .dmg and drag BIM Riviera to Applications. The app isn't notarized by Apple yet, so the first time macOS wi…"
---

# Get started

## Get started

Install a pre-release package, open a sample, and start modelling.

## Install a package

Riviera is pre-release software at a very early stage. Most of its specification, research and implementation was carried out autonomously by AI coding agents. Expect features that are incomplete or incorrect at this stage, check results before relying on them, and keep copies of models you care about.

 | Platform | Package | Status |
|---|---|---|
| Linux | [Download Flatpak](https://bimreviera.com/downloads/0.1.0-pre.11/BIM-Riviera-0.1.0-pre.11-x86_64.flatpak) BIM-Riviera-0.1.0-pre.11-x86\_64.flatpak · 62.3 MB SHA-256 `bcb79fb0e1c2018b89a69ffb0201cea8d05ca922c36d59d8272fc3c138d4a93c` | Built and tested on Fedora 43 |
| Windows | [Download installer](https://bimreviera.com/downloads/0.1.0-pre.11/BIM-Riviera-0.1.0-pre.11-windows-x64-setup.exe) BIM-Riviera-0.1.0-pre.11-windows-x64-setup.exe · 62.2 MB SHA-256 `d7303f6b39c6503faac4ca65acb59dddec26c1b0e7bc6b438dd85cce57280d21` | Tested on Windows 11 |
| Windows (portable) | [Download ZIP](https://bimreviera.com/downloads/0.1.0-pre.11/BIM-Riviera-0.1.0-pre.11-windows-x64-portable.zip) BIM-Riviera-0.1.0-pre.11-windows-x64-portable.zip · 94.3 MB SHA-256 `b95d0b2b9cabea4efb126660ea942305a1e8555d9a08b0d090f95c5dbf188975` | Tested on Windows 11 |
| macOS | [Download disk image](https://bimreviera.com/downloads/0.1.0-pre.11/BIM-Riviera-0.1.0-pre.11-macos-arm64.dmg) BIM-Riviera-0.1.0-pre.11-macos-arm64.dmg · 90.4 MB SHA-256 `71d6eea6b3898f81ac1e92694b2da6caef0f20e6394747a84f4120701c057249` | Tested on Apple silicon (arm64) |

## Installing

**Linux:**

```sh
flatpak install --user BIM-Riviera-0.1.0-pre.11-x86_64.flatpak
```

**Windows:** run the installer, or unzip the portable build and start `riviera.exe`.

**macOS (Apple silicon):** open the `.dmg` and drag **BIM Riviera** to Applications. The app isn't notarized by Apple yet, so the first time macOS will refuse to open it. Open **System Settings › Privacy & Security** and click **Open Anyway**, or run:

```sh
xattr -dr com.apple.quarantine "/Applications/BIM Riviera.app"
```

> **How the Windows packages are built.** The Windows installer and portable ZIP are cross-compiled on Fedora Linux, so they are never built or packaged on a Windows machine. A Windows virus has no practical way to get into them during the build.

**Check the installer's hash before you run it.** Each package's SHA-256 hash is listed in the table above and in [SHA256SUMS](https://bimreviera.com/downloads/0.1.0-pre.11/SHA256SUMS). Compute the hash of the file you downloaded and compare it with the published one. If they differ, the file is damaged or has been altered, so delete it and don't run it.

On Windows, in PowerShell:

```powershell
Get-FileHash .\BIM-Riviera-0.1.0-pre.11-windows-x64-setup.exe -Algorithm SHA256
```

On macOS or Linux, in the folder you downloaded to:

```sh
shasum -a 256 BIM-Riviera-0.1.0-pre.11-macos-arm64.dmg  # macOS
sha256sum BIM-Riviera-0.1.0-pre.11-x86_64.flatpak        # Linux
```

Every package includes the sample models and the sample Component Library.

## Your first model

1. Open **Help › Riviera Help** (F1). The Samples section opens each sample model as a fresh copy, grouped by part of the application: Architecture, Structure, Systems, Sustainability, View and Modify. The sustainability samples open with their own weather files.
2. Try the **Manor** for architecture, or the **Steel-framed office** for structure. Each sample has a walkthrough showing how to build it by hand.
3. Or start from **File › New**, set your units and building code in **Manage › Settings › Model Properties**, and draw some walls.

## Build from source

Fedora is the development platform today.

```sh
sudo dnf install rustup cmake ninja-build gcc-c++ opencascade-devel boost-devel eigen3-devel \
    libxml2-devel json-devel perl-FindBin perl-IPC-Cmd perl-Time-Piece webkit2gtk4.1-devel
rustup-init

git clone https://github.com/Rational-Boxes/BIM_Riviera.git
cd BIM_Riviera
tools/build-ifcopenshell.sh      # IfcOpenShell into third_party/ (about 15 minutes)

cargo build
cargo run -- gui model.ifc
```

## Script it

Run a Lua script against the open model from **Scripts › Run Script…**, or from the shell:

```lua
local l1 = riviera.level.list()[1].id
local w = riviera.wall.create{
  curve = { line = { start = { 0, 0 }, ["end"] = { 10, 0 } } },
  base_level = l1, top_constraint = { unconnected = 3.0 },
}
riviera.door.place{ host_wall_id = w, point_along = 7.5 }
riviera.window.place{ host_wall_id = w, point_along = 2.5 }
```

The scripts behind every sample model are in `test-data/samples/`.

## Connect an AI agent

The quickest way is the agent terminal. Open **View › User Interface › Terminal**(Ctrl+Shift+T) and start a Claude Code, Antigravity CLI, Qwen Code or Codex CLI tab. The agent starts already connected to the open model, and destructive changes wait for your approval in Riviera. Riviera doesn't install the agents, so install and sign in to the ones you use first.

To connect an agent from outside Riviera, use its MCP server. For example, with Claude Code:

```sh
claude mcp add riviera -- /path/to/riviera --mcp-stdio --permission model_edit /path/to/model.ifc
```

The permission levels are `read_only` (the default), `model_edit` and `full_scripting`.

## Get involved

The source, the specification and the issue tracker are on [GitHub](https://github.com/Rational-Boxes/BIM_Riviera). Riviera is licensed under the GNU GPL v3.0 or later. Its open data formats, protocols and client libraries are MIT-licensed.

## Get in touch

Questions, bug reports and ideas are welcome. Send a message here, or open an issue on GitHub.

- [Rational-Boxes/NoDesk\_Reviera](https://github.com/Rational-Boxes/NoDesk_Reviera)
- [Report an issue](https://github.com/Rational-Boxes/NoDesk_Reviera/issues)
- [Download the pre-release](https://bimreviera.com/get-started)

- © BIM Reviera contributors. Free software under the GNU GPL v3.0 or later.
- Sponsored by RATIONALBOXES LLC, [www.rationalboxes.com](https://www.rationalboxes.com)
- Design: [HTML5 UP](https://html5up.net)

---

## Navigation

- Previous: [Screenshots](https://bimreviera.com/screenshots.md)
- Next: [Contact](https://bimreviera.com/contact.md)
