electrobun

<p align="center">
  <a href="https://electrobun.dev/electrobun/"><img src="https://github.com/blackboardsh/electrobun/assets/75102186/8799b522-0507-45e9-86e3-c3cfded1aa7c" alt="Logo" height=170></a>
</p>

<h1 align="center">Electrobun</h1>

Build fast, compact, cross-platform desktop apps with TypeScript, Zig, Rust, Go,
or Odin.

## Get started

Install Hutch on **macOS or Linux**:

```sh
curl -fsSL https://artifacts.electrobun.dev/hutch/install.sh | sh
```

Or on **Windows PowerShell**:

```powershell
& ([scriptblock]::Create((irm https://artifacts.electrobun.dev/hutch/install.ps1)))
```

Then open the template picker. Restart your terminal first if `hutch` isn't found.

```sh
hutch electrobun init
```

Already use Bun or npm? You can start with either command instead:

```sh
bunx electrobun init
# or
npx electrobun init
```

Choose a template, then follow the
[Quick Start](https://docs.electrobun.dev/electrobun/guides/quick-start/#run-the-app)
to run your app.

## What is Electrobun?

Electrobun aims to be a complete **solution-in-a-box** for building, updating, and shipping fast, compact, cross-platform desktop applications written in TypeScript.
Hutch is the native build and workspace CLI. Bun is Electrobun's default JavaScript runtime. Cottontail is an experimental JSC-based alternative. Electrobun's platform layer combines Zig, Objective-C, and C++.

Explore [Electrobun](https://electrobun.dev/electrobun/) and read the
[documentation](https://docs.electrobun.dev/electrobun/) for API references,
guides, and examples.

Published templates include the Electrobun version they were tested with. Hutch
manages the SDKs and toolchains needed to build them. See the
[Hutch guide](https://docs.electrobun.dev/electrobun/guides/hutch/) for
project configuration and version management.

Hutch's built-in npm-compatible resolver installs JavaScript dependencies by
default and writes `hutch.lock`; `hutch pm exec` runs project-local package
binaries. A project's `hutch.config.ts` may instead select npm, Bun, pnpm, Yarn,
or a custom executable, and Hutch delegates package operations to that explicit
choice. Package management is independent of whether the app's main process
runs on Cottontail or Bun.

Don't miss our:
- self-extracting bundles that use Zstandard compression for compact distributables
- a Zig-optimized BSDIFF implementation that can produce kilobyte-scale updates
- `bundleCEF` flag to bundle and pin Chromium for those that want that tradeoff of consistency over file size
- `bundleWGPU` that lets you use Bun Typescript -> WGPU to control a native GPU surface without a webview
- Our Three.js and Babylon.js adapters that work directly in the Bun main process
- Our `<electrobun-webview>` and `<electrobun-wgpu>` HTML elements that let you composite isolated webviews and native GPU surfaces into your UIs
- so much more.

**Project Goals**

- Write typescript for the main process and webviews without having to think about it.
- Isolation between main