Documentation

Everything about Butter.

The full reference lives as Markdown in the docs/ folder. Start with the tutorial, then dive into the concepts and the reference. Each card links straight to the source document.

Tutorial
๐Ÿ“– Overview

The tutorial map and what you'll build, step by step.

๐Ÿš€ Getting started

Install the CLI, scaffold a project, and open your first native window.

๐Ÿ” IPC

Call host handlers from the webview, push events back, and stream results.

๐Ÿ” Menus

Define native menus and wire menu actions to IPC handlers.

โš™๏ธ Native extensions

Write C / Moxy / Rust / Zig and call it directly from TypeScript.

๐Ÿ”Œ Plugins

Enable built-in plugins for dialogs, storage, power, sidecars, and more.

๐Ÿ“ฆ Building

Compile a single binary, bundle, package, sign, and distribute.

Concepts
๐Ÿงญ Embedded chrome

How the native webview, shim, and custom protocol fit together.

Reference
๐Ÿ“š Reference overview

The map of the reference docs and where to find each topic.

๐Ÿ”— API

The host and webview APIs: on, send, invoke, stream, store, db, and events.

โŒจ๏ธ CLI

init, dev, compile, bundle, package, sign, and doctor โ€” every command.

โš™๏ธ Configuration

The butter.yaml schema: window, build, bundle, security, splash, plugins.

๐Ÿงฎ Native

The FFI bindings, export markers, build matrix, and fingerprint caching.

๐ŸŸฆ Types

Typed IPC contracts: createTypedHandlers and createTypedInvoke.

๐Ÿ—๏ธ Architecture

Process topology, the ring-buffer protocol, and the runtime layers.

Source
๐Ÿ“„ Readme

The full project README: install, quick start, API, plugins, platforms.

๐Ÿ™ Source

Browse the framework and CLI source on GitHub.

๐Ÿ› Issues

Report a bug or request a feature on the issue tracker.