Use this reference for JavaScript and TypeScript development with Bun. It explains CLI commands, dependency and lockfile management, testing, bundling code, runtime APIs for files and servers, the Bun shell, configuration, and environment variables.
Use when working with the bun CLI — Bun's all-in-one JavaScript runtime and toolkit. Covers the CLI command reference (install, add, remove, run, build, test, x, create, init, pm, upgrade, link, unlink), bunfig.toml configuration, environment variables, the package manager and lockfile, the test runner, the bundler, the Bun runtime API (Bun.serve, Bun.file, Bun.spawn, Bun.write, hashing, transpiler), the Bun shell ($ template literal), module resolution and loaders, and globals. Triggers on: "bun", "bunx", "bun install", "bun add", "bun remove", "bun run", "bun build", "bun test", "bun x", "bun create", "bun init", "bun pm", "bun upgrade", "bun link", "bun unlink", "bunfig.toml", "bun.lock", "Bun.serve", "Bun.file", "Bun.write", "Bun.spawn", "Bun.hash", "Bun.password", "bun:test", "Bun.build", "Bun.Transpiler", "bun shell", "$ template", "import.meta", "JavaScriptCore", "Bun.serve", "HTMLRewriter", "Bun.SQL", "Bun.RedisClient", "Bun.Glob", "Bun.plugin", "bun:ffi".
Run score Not tested
See how to installReview the instructions the agent will receive before you install.
Comprehensive reference for the Bun CLI (https://bun.sh/docs), covering the command reference, configuration, package manager, test runner, bundler, runtime API, shell, and module resolution. Bun is an all-in-one JavaScript runtime built on JavaScriptCore (not V8), with a native bundler, transpiler, test runner, and package manager written in Zig and C++.
Source file (.js/.ts/.jsx/.tsx)
→ transpiler (JS/TS/JSX → vanilla JS, dead code elimination)
→ module resolver (node_modules, exports field, tsconfig paths)
→ runtime (JavaScriptCore engine executes)
→ globals (Web API + Node.js + Bun-specific)
→ Bun API (serve, file, spawn, write, hash, etc.)
Load the reference that matches your task. When in doubt, load multiple references.
| Keywords | Reference |
|---|---|
| command, subcommand, flag, bun install, bun add, bun remove, bun run, bun x, bunx, bun create, bun init, bun build, bun test, bun pm, bun upgrade, bun completions, bun link, bun unlink, bun dev, bun ci, CLI reference, --watch, --hot, --silent, --eval, --print, --preload, --inspect, --define, --loader, --env-file, --port, --smol, --no-install, --install, --bun, --filter, --workspaces, --parallel, --sequential | references/cli.md |
| bunfig.toml, configuration, config file, [install], [test], [run], [serve], preload, jsx, smol, logLevel, define, loader, telemetry, env, console, registry, scopes, ca, cafile, cache, lockfile, linker, globalStore, publicHoistPattern, hoistPattern, frozenLockfile, dryRun, auto, prefer, saveTextLockfile, ignoreScripts, concurrentScripts, minimumReleaseAge, security scanner, globalDir, globalBinDir, linkWorkspacePackages, noOrphans, elide-lines, shell, run.bun, run.silent | references/config.md |
| package manager, bun install, bun add, bun remove, bun link, bun unlink, bun pm, bun pm pack, bun pm bin, bun pm ls, bun pm whoami, bun pm cache, bun pm migrate, bun pm untrusted, bun pm trust, bun pm hash, bun pm version, bun pm pkg, bun.lock, lockfile, binary lockfile, text lockfile, trustedDependencies, backend, clonefile, hardlink, symlink, copyfile, linker, hoisted, isolated, global install, workspace, filter, omit, production, exact, yarn, frozen-lockfile, dry-run, force, no-cache, network-concurrency, concurrent-scripts, registry, scopes, ca, cafile, backend | references/package-manager.md |
| test runner, bun test, bun:test, test, expect, describe, beforeAll, beforeEach, afterEach, afterAll, mock, jest.fn, snapshot, toMatchSnapshot, coverage, --coverage, --timeout, --rerun-each, --retry, --concurrent, --max-concurrency, --randomize, --seed, --bail, --test-name-pattern, --reporter, --reporter-outfile, --dots, --update-snapshots, --watch, --preload, --todo, test.concurrent, test.serial, test.failing, test.todo, JUnit, CI, CLAUDECODE, AGENT, pathIgnorePatterns, coverageThreshold | references/test-runner.md |
| bundler, bun build, Bun.build, entrypoints, outdir, outfile, target, browser, bun, node, format, esm, cjs, iife, splitting, minify, minify-syntax, minify-whitespace, minify-identifiers, keep-names, sourcemap, linked, inline, external, external, define, drop, loader, banner, footer, naming, entry-naming, chunk-naming, asset-naming, root, publicPath, public-path, packages, no-bundle, compile, bytecode, --compile, standalone executable, windows-icon, windows-title, metafile, metafile-md, env, conditions, jsx, react-fast-refresh, react-compiler, css-chunking, optimizeImports, feature, features, BuildArtifact, BuildOutput, BuildMessage, ResolveMessage | references/bundler.md |
| runtime, Bun global, Bun.serve, Bun.file, Bun.write, Bun.spawn, Bun.spawnSync, Bun.hash, Bun.password, Bun.hash, Bun.CryptoHasher, Bun.Transpiler, Bun.peek, Bun.deepEquals, Bun.inspect, Bun.sleep, Bun.sleepSync, Bun.nanoseconds, Bun.which, Bun.randomUUIDv7, Bun.escapeHTML, Bun.stringWidth, Bun.stripANSI, Bun.wrapAnsi, Bun.fileURLToPath, Bun.pathToFileURL, Bun.resolveSync, Bun.gzipSync, Bun.gunzipSync, Bun.deflateSync, Bun.inflateSync, Bun.zstdCompressSync, Bun.zstdDecompressSync, Bun.readableStreamToText, Bun.readableStreamToJSON, Bun.readableStreamToArray, Bun.env, Bun.main, Bun.version, Bun.revision, Bun.Terminal, HTMLRewriter, Bun.Glob, Bun.plugin, Bun.semver, Bun.TOML, Bun.markdown, Bun.color, Bun.Image, Bun.mmap, Bun.gc, Bun.generateHeapSnapshot, Bun.ArrayBufferSink, Worker, import.meta, globals, Web API, Node.js globals, module resolution, loader, extension order, tsconfig paths, exports field, conditions, watch mode, hot mode, --watch, --hot, auto-install | references/runtime.md |
| shell, Bun shell, $ template literal, $.quiet, $.text, $.json, $.lines, $.blob, $.nothrow, $.throws, $.env, $.cwd, $.braces, $.escape, redirection, pipe, command substitution, builtin commands, cd, ls, rm, echo, pwd, cat, touch, mkdir, which, mv, exit, true, false, yes, seq, dirname, basename, .sh file, shell injection, argument injection, security | references/shell.md |
| environment variable, BUN_PORT, PORT, BUN_INSTALL_GLOBAL_DIR, BUN_INSTALL_BIN, BUN_INSTALL_GLOBAL_STORE, BUN_FEATURE_FLAG_NO_ORPHANS, DO_NOT_TRACK, NODE_ENV, npm_token, GITHUB_TOKEN, GITHUB_API_DOMAIN, CLAUDECODE, REPL_ID, AGENT, XDG_CONFIG_HOME, env file, --env-file, .env | references/environment.md |
fs, path, http, stream, crypto, util, etc.) and Node.js module system internals, see the Node.js documentation — Bun implements Node.js compatibility but this skill covers only Bun-specific behavior and differences.tsconfig.json, compilerOptions, JSX settings), see the TypeScript handbook — Bun reads tsconfig.json but this skill documents only Bun-specific configuration in bunfig.toml.bun completer in completers/common/bun_completer/), see the carapace skill (in this repo).No reviews yet. Tell others what you thought.
No login needed. Share how it worked for you, ask a question, or note where it did not run.
No comments yet. Be the first to write one.
Use this reference to manage software with Homebrew on macOS or Linux, understand formulas and casks, maintain Brewfiles and services, troubleshoot installations, or work on formula and cask development tasks.
Use this reference to build and maintain terminal user interfaces in Go with Bubble Tea. It explains the Model/Update/View cycle, commands and messages, input, rendering, program lifecycle, tests, component composition, and patterns for larger applications.
Use this reference to manage Git work with the GitButler CLI (`but`), including virtual and stacked branches, assigning changes, editing commits, resolving conflicts, and creating pull requests. It also covers the workspace, operation history, interactive TUI, configuration, and AI agent setup.
Build and maintain carapace shell completions for command-line tools. The reference covers YAML specs, custom completion actions, shell setup, DSL-aware parsing, MCP use, and documentation for suggested values.
Use this reference to work with Cargo, Rust’s package manager and build tool. It explains project manifests, dependencies, features, workspaces, build profiles, configuration, registries, publishing, and commands for building, testing, and inspecting projects.
Use this reference when building command-line applications with `spf13/cobra`. It shows how to organize commands, define flags, validate arguments, add lifecycle hooks, customize help output, provide shell completions, and connect flags with Viper configuration.