Get Started

Welcome to Bun Installation Quickstart TypeScript TypeScript 6 and 7

Watch Mode Debugging REPL bunfig.toml File Types Module Resolution JSX Auto-install Plugins File System Router

Cookies File I/O Streams Binary Data Archive SQL SQLite S3 Redis Workers Environment Variables Shell Spawn WebView Cron Node-API FFI C Compiler Transpiler CSRF Protection Secrets Console TOML YAML Markdown JSON5 JSONL HTMLRewriter Image Hashing Glob Semver Color Utils Globals Bun APIs Web APIs Node.js Compatibility

Parse command-line arguments Listen for CTRL+C Spawn a child process and communicate using IPC Get the process uptime in nanoseconds Listen to OS signals Read stderr from a child process Read stdout from a child process Spawn a child process Read from stdin

File SystemProcess

Read from stdin

In Bun, the console object is an AsyncIterable that yields lines from stdin .

Spawn a child process

Use Bun.spawn() to spawn a child process.

Install TypeScript declarations for Bun

To add TypeScript definitions for Bun's built-in APIs to your project, install @types/bun .