|
| 1 | +# TAGLINE |
| 2 | + |
| 3 | +All-in-one toolkit that augments Node.js |
| 4 | + |
| 5 | +# TLDR |
| 6 | + |
| 7 | +**Run** a TypeScript or JavaScript file with automatic transpilation |
| 8 | + |
| 9 | +```nub [file.ts]``` |
| 10 | + |
| 11 | +**Run** a file and restart it on changes |
| 12 | + |
| 13 | +```nub watch [file.ts]``` |
| 14 | + |
| 15 | +**Execute** an npm script from package.json |
| 16 | + |
| 17 | +```nub run [script]``` |
| 18 | + |
| 19 | +**Execute** a package binary (faster npx alternative) |
| 20 | + |
| 21 | +```nubx [command]``` |
| 22 | + |
| 23 | +**Install** all project dependencies |
| 24 | + |
| 25 | +```nub install``` |
| 26 | + |
| 27 | +**Add** a package to the project |
| 28 | + |
| 29 | +```nub add [package]``` |
| 30 | + |
| 31 | +**Install** and switch to a specific Node.js version |
| 32 | + |
| 33 | +```nub node install [version]``` |
| 34 | + |
| 35 | +**Update** Nub itself to the latest version |
| 36 | + |
| 37 | +```nub upgrade``` |
| 38 | + |
| 39 | +# SYNOPSIS |
| 40 | + |
| 41 | +**nub** [_options_] _file_ |
| 42 | + |
| 43 | +**nub** _subcommand_ [_arguments_] |
| 44 | + |
| 45 | +**nubx** [_options_] _command_ |
| 46 | + |
| 47 | +# DESCRIPTION |
| 48 | + |
| 49 | +**Nub** is a fast all-in-one toolkit that augments Node.js instead of replacing it. Written in **Rust** with the embedded oxc parser for transpilation, it bundles a file runner, a script runner, a package manager, a package executor, and a Node.js version manager behind a single command. |
| 50 | + |
| 51 | +Unlike alternative runtimes, Nub does not ship its own JavaScript engine. It runs files on the existing Node.js installation while adding native TypeScript execution, automatic **.env** loading, and a watch mode. The file runner aims to be a drop-in replacement for the **node** binary, accepting the same flags and environment variables through passthrough. |
| 52 | + |
| 53 | +The companion **nubx** command runs package binaries from the registry or from local **node_modules/.bin**, serving as a faster substitute for **npx**. The package manager subcommands (install, ci, add, remove, update) provide an alternative to **npm**, **pnpm**, and **yarn**, while **nub node** and **nub pm** manage Node.js versions and Corepack-style package manager shims. |
| 54 | + |
| 55 | +# PARAMETERS |
| 56 | + |
| 57 | +**nub** _file_ |
| 58 | +> Run a TypeScript or JavaScript file with automatic transpilation and .env loading. |
| 59 | +
|
| 60 | +**nub run** _script_ |
| 61 | +> Execute a script defined in the package.json file. |
| 62 | +
|
| 63 | +**nub watch** _file_ |
| 64 | +> Run a file and automatically restart it when source files change. |
| 65 | +
|
| 66 | +**nubx** _command_ |
| 67 | +> Execute a package binary from the registry or from local node_modules/.bin. |
| 68 | +
|
| 69 | +**nub install** |
| 70 | +> Install all project dependencies. |
| 71 | +
|
| 72 | +**nub ci** |
| 73 | +> Perform a clean install of dependencies. |
| 74 | +
|
| 75 | +**nub add** _packages_ |
| 76 | +> Add one or more packages to the project. |
| 77 | +
|
| 78 | +**nub remove** _package_ |
| 79 | +> Remove a package from the project. |
| 80 | +
|
| 81 | +**nub update** |
| 82 | +> Update project dependencies. |
| 83 | +
|
| 84 | +**nub node install** _version_ |
| 85 | +> Download and provision a specific Node.js version. |
| 86 | +
|
| 87 | +**nub node ls** |
| 88 | +> List the cached Node.js versions. |
| 89 | +
|
| 90 | +**nub node which** |
| 91 | +> Print the path to the resolved Node.js binary. |
| 92 | +
|
| 93 | +**nub pm shim** |
| 94 | +> Register global package manager shims (Corepack-style). |
| 95 | +
|
| 96 | +**nub upgrade** |
| 97 | +> Update Nub itself to the latest release. |
| 98 | +
|
| 99 | +# CAVEATS |
| 100 | + |
| 101 | +Nub augments rather than replaces Node.js, so a working Node.js installation is still required for execution. As a young project the command surface and flags may change between releases; check the documentation for the version you have installed. |
| 102 | + |
| 103 | +# HISTORY |
| 104 | + |
| 105 | +Nub was published in 2025 as a Rust-based companion to Node.js, positioned alongside all-in-one runtimes such as **bun** and **deno** but focused on speeding up existing Node.js workflows rather than introducing a separate runtime. |
| 106 | + |
| 107 | +# SEE ALSO |
| 108 | + |
| 109 | +[node](/man/node)(1), [npm](/man/npm)(1), [npx](/man/npx)(1), [pnpm](/man/pnpm)(1), [yarn](/man/yarn)(1), [bun](/man/bun)(1), [deno](/man/deno)(1) |
| 110 | + |
| 111 | +# RESOURCES |
| 112 | + |
| 113 | +```[Source code](https://github.com/nubjs/nub)``` |
| 114 | + |
| 115 | +```[Homepage](https://nubjs.com)``` |
| 116 | + |
| 117 | +```[Documentation](https://nubjs.com/docs)``` |
| 118 | + |
| 119 | +<!-- verified: 2026-06-25 --> |
0 commit comments