{"id":26054,"library":"oxbuild","title":"oxbuild","description":"oxbuild is an ultra-fast tsc-like compiler built on top of the oxc toolchain. It transpiles TypeScript, JavaScript, JSX, and TSX, emits .d.ts files for projects with isolatedDeclarations, and generates JS source maps. Current stable version is 0.1.5, released via npm and crates.io with no fixed release cadence until stable. Its key differentiator is raw speed compared to tsc and swc by leveraging the oxc parser written in Rust. As of v0.1.5, it is still in alpha, not recommended for production use, and limitations include incomplete TSConfig support and experimental declarations.","status":"active","version":"0.1.5","language":"javascript","source_language":"en","source_url":"https://github.com/DonIsaac/oxbuild","tags":["javascript","development-tools","web-programming","compilers","typescript","compiler","oxc","oxbuild"],"install":[{"cmd":"npm install oxbuild","lang":"bash","label":"npm"},{"cmd":"yarn add oxbuild","lang":"bash","label":"yarn"},{"cmd":"pnpm add oxbuild","lang":"bash","label":"pnpm"}],"dependencies":[],"imports":[{"note":"oxbuild is a CLI binary, not a library. Use npx or global install to run.","wrong":"require('oxbuild')","symbol":"oxbuild","correct":"npx oxbuild"},{"note":"oxbuild is intended for global use, not a project dependency. However, local install also works with npx.","wrong":"npm install oxbuild --save","symbol":"install","correct":"npm install -g oxbuild"},{"note":"The tsconfig path must be passed with --tsconfig flag.","wrong":"oxbuild tsconfig.json","symbol":"use with tsconfig","correct":"oxbuild --tsconfig tsconfig.json"}],"quickstart":{"code":"# Install globally\nnpm install -g oxbuild\n\n# In a TypeScript project, compile from ./src to ./dist\noxbuild\n\n# With custom tsconfig\noxbuild --tsconfig tsconfig.json\n\n# With debug logs\nRUST_LOG=debug oxbuild","lang":"javascript","description":"Shows global installation and basic CLI usage: running oxbuild in a project with default src/ layout."},"warnings":[{"fix":"Review tsconfig options. Open an issue on GitHub if a specific option is missing.","message":"oxbuild does not support all tsconfig options; only rootDir and outDir are respected. Other fields like strict or paths may be ignored silently.","severity":"gotcha","affected_versions":">=0.1.0"},{"fix":"Pin the exact version in CI and scripts. Monitor changelog.","message":"The CLI API is unstable and may change without notice before stable release (v1.0.0). Flags and default behavior can break across minor versions.","severity":"breaking","affected_versions":"<1.0.0"},{"fix":"Be prepared to update scripts. Check release notes for changes.","message":"The --tsconfig flag may be renamed or replaced in future versions. The current flag is --tsconfig but may change to --config.","severity":"deprecated","affected_versions":">=0.1.0"},{"fix":"Enable \"isolatedDeclarations\": true in tsconfig.json.","message":"Generating .d.ts files requires isolatedDeclarations enabled in tsconfig. Without it, no declaration files are emitted.","severity":"gotcha","affected_versions":">=0.1.0"},{"fix":"Report issues to the oxbuild repository with RUST_LOG=debug output.","message":"oxbuild is built on oxc which is also pre-1.0. Bugs in oxc often propagate to oxbuild. Expect potential crashes or incorrect output.","severity":"gotcha","affected_versions":">=0.1.0"},{"fix":"Upgrade Node.js to v14 or later.","message":"Node.js version must be >=14. Running on older versions will fail with cryptic errors.","severity":"gotcha","affected_versions":">=0.1.0"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Do not use require('oxbuild'). Install globally and run 'oxbuild' from command line. For npx use: npx oxbuild.","cause":"Trying to require('oxbuild') as a Node.js library instead of using it as an installed CLI binary.","error":"Error: Cannot find module 'oxbuild'"},{"fix":"Install globally: npm install -g oxbuild. Or use npx: npx oxbuild.","cause":"oxbuild not installed or not in PATH.","error":"Command 'oxbuild' not found"},{"fix":"Use --tsconfig to specify a tsconfig file. E.g., oxbuild --tsconfig tsconfig.json","cause":"Used --config instead of --tsconfig.","error":"unknown option '--config'"},{"fix":"Ensure tsconfig.json exists in the project root (where package.json is) or specify path with --tsconfig.","cause":"oxbuild could not locate a tsconfig.json in the project root directory.","error":"Unable to find tsconfig.json"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}