blackboardsh/electrobun

Claude Development Guidelines for Electrobun

View on GitHub ↗Yours? Claim it ↗

§ 01 — Stats

Stars11.7k

Forks306

Prior1361

Quality—

Score—

Tasks—

§ 02 — Use

Drop into your project.

A CLAUDE.md is just a markdown file at the root of your repo. Copy the content below into your own project's CLAUDE.md to give your agent the same context.

One-line install · current directory

$npx versuz@latest install blackboardsh-electrobun --kind=claude-md

Or curl directly

$curl -o CLAUDE.md https://raw.githubusercontent.com/blackboardsh/electrobun/HEAD/CLAUDE.md

Project typenextjs

Tokens

Embed badge

Show

Style

[![Versuz · blackboardsh/electrobun](https://versuz.dev/badge/claude-md/blackboardsh-electrobun)](https://versuz.dev/claude-md/blackboardsh-electrobun)

Show CLAUDE.md content (~267 tokens)

# Claude Development Guidelines for Electrobun

## Building and Running Electrobun

### IMPORTANT: Build Commands

**NEVER** run electrobun directly from the bin folder or node_modules. The correct way to build and run Electrobun is:

1. **From the package folder** (`/home/yoav/code/electrobun/package/`):
   - `bun dev` - Builds and runs the kitchen app in dev mode
   - `bun dev:canary` - Builds the kitchen app in canary mode

2. **Build Process Flow**:
   - Always run build commands from the `package` folder
   - The build process will automatically:
     - Build the native wrappers
     - Compile the TypeScript code
     - Build the CLI
     - Switch to the kitchen folder and build/run the app

## Project Structure

- `/package` - Main Electrobun package source
- `/kitchen` - Test application (Kitchen Sink)
- `/package/src/cli` - CLI implementation
- `/package/src/extractor` - Self-extractor implementation (Zig)
- `/package/src/native` - Native wrappers for each platform