@luciole-sh/core

The luciole framework: React Server Components rendered in your terminal, with the same components available on the web.

This package publishes TypeScript sources and relies on Bun APIs (Bun.Terminal, Bun.serve, Bun.build, bun:sqlite…): it runs on Bun only.

Requirements

• Bun 1.4.1 or later
• react and react-dom 19.3 or later, installed by your application (they are peer dependencies, so that the framework and your components share one copy)

Usage

luciole init my-app    # scaffold a starter application in ./my-app
luciole dev --app my-app   # run it with live reload
luciole build --app my-app # produce a build (see `luciole build --compile` for a binary)

luciole init runs @luciole-sh/create at this package's version, which writes the starter (the Notes example, with its tooling configured); bunx @luciole-sh/create my-app does the same without installing the framework first.

luciole and luciolex are the two executables this package installs.

See the root README for the project overview, and luciole.sh for the website.

TypeScript setup

Extend the framework's configuration in your application's tsconfig.json:

{
  "extends": "@luciole-sh/core/tsconfig"
}

The package ships compiled .d.ts declarations for all public TypeScript entries; Bun runs the TypeScript sources. With skipLibCheck: true, your application's compiler checks your code without checking core's implementation.

Use moduleResolution: "Bundler", as the shared configuration does. The declarations retain extensionless internal imports, so Node16 and NodeNext resolution are unsupported: with skipLibCheck, unresolved internal types can silently become any.

License

MIT