index.md

Bunlet Documentation

Welcome to the Bunlet documentation! Bunlet is a desktop application framework that combines Bun's speed with native WebView rendering.

Quick Links

• Quick Start - Create your first app in 5 minutes
• Architecture Task List - Structural backlog for roadmap completion
• Capability Matrix - Backend feature availability and gating
• CLI Reference - Command line tools
• API Documentation - Complete API reference
• Size Optimization - Minimize bundle size

Documentation Sections

Getting Started

• Installation
• Quick Start
• Project Structure
• Configuration

Guides

• Window Management
• IPC Communication
• Native APIs
• Preload Scripts
• Hot Reload
• Debugging

CLI Reference

• Overview
• bunlet create
• bunlet dev
• bunlet build
• bunlet package
• Advanced Usage

Packaging

• Overview
• Platform Guides
• Code Signing
• Auto-Updates
• Size Optimization

WebView Engines

• System WebView
• CEF Mode
• Comparison

API Reference

• app
• BrowserWindow
• IPC
• dialog
• Menu
• Tray
• Notification
• clipboard
• shell
• globalShortcut
• autoUpdater

Advanced Topics

• Architecture Overview
• Architecture Task List
• Native Modules
• Multi-Window Apps
• Security
• Performance

Migration

• From Electron
• From Tauri

Getting Help

• GitHub Issues - Report bugs and request features
• Discussions - Ask questions and share ideas

Contributing

See the Contributing Guide to get started with development.