bun-repl
v2.1.1
Published
Experimental REPL for Bun
Downloads
13,318
Readme
bun-repl
Experimental REPL for Bun
Install
You can use it directly via Bun with:
bun repl
No installation required!
Versioning
npm and GitHub releases will always be guaranteed to not rely on current Bun canary versions, but support for any version other than the latest non-canary will not be guaranteed.
The source code repository latest commit may contain code not yet in any release which depends on currently Bun canary-only features and has no guarantees.
Features
- Seamless JavaScript & TypeScript execution
- Single run CLI flags
--eval
and--print
- Top level import syntax supported (
import fs from 'fs'
) - Top level await (experimental)
- Lazy-loaded builtin modules as preloaded global variables. (including Bun modules! Try
ffi
orsqlite
) - Import either CommonJS or ESM local files and packages into the REPL
- Node.js REPL special underscore variables provided (
_
and_error
) - Resistent to global object modification (output quality may decrease but never crash)
- Node.js
repl
module polyfill - Persistent execution history (
↑
↓
) - REPL Commands (
.command
)
Usage
bun repl [options]
Pass the -h
or --help
CLI option for a list of all options.
Type .help
within the REPL for a list of commands.
Press ↑
and ↓
to travel up or down the execution history.
The repl
module polyfill
bun repl
exposes a special variable repl
which provides access to a REPL interface like the Node.js REPL (also accessible through import/require of repl
or node:repl
).
Currently only a subset of the node:repl
API is implemented, see below:
repl
global object ✅start()
function ❌writer()
function ✅ (Partial)options
object ✅
repl
property ❌builtinModules
array ✅REPL_MODE_SLOPPY
symbol ✅REPL_MODE_STRICT
symbol ✅REPLServer
class ❌Recoverable
class ❌
You can use repl.writer.options
like you would in Node.js REPL to customize the live output of the running REPL.
Known issues & limitations
PRs are welcome to help fix any of the items below or anything else.
- Top level await is only partially supported. Needs improvement.
- Multi-line inputs are not supported.