Getting Started

Installation

TakeRest runs on macOS, Windows, and Linux. Download the latest release from GitHub.

Pre-1.0 — early access

Binaries are available on GitHub Releases. Join the waitlist to be notified when stable builds ship.

Requirements

macOS

12 Monterey or later

Windows

10 or later (64-bit)

Linux

Ubuntu 20.04+ / Debian 11+

No system dependencies required. The Rust backend and WebView are bundled. No need for Node.js, Python, or a system Git install.

Download

Head to the GitHub Releases page and download the binary for your platform.

File formats by platform

macOS (Apple Silicon)

.dmg arm64

macOS (Intel)

.dmg x64

Windows

.msi / .exe x64

Linux

.AppImage / .deb x64

View releases on GitHub

Opening a project

TakeRest works on a folder. Point it at any Git repository — it will look for a .takerest/ folder and create one if it doesn't exist.

Launch TakeRest

Open the app after installation. You'll land on the project picker.

Select your repo

Click "Open folder" and navigate to any Git repository on your machine.

Start working

The .takerest/ folder is created automatically. Your .env files are detected on first load.

Building from source

Clone the repo and run the dev server. You'll need Rust and Bun installed.

terminal

# clone
git clone https://github.com/takerestdev/takerest
cd takerest

# install dependencies
bun install

# run in dev mode (opens the desktop app)
bun run tauri dev

The Tauri CLI will compile the Rust backend and launch the app with hot-reload on the frontend. First compile takes a few minutes while Rust downloads crates.

GitHub → .env Manager