fnm
)
Fast Node Manager (π Fast and simple Node.js version manager, built in Rust
Features
π Cross-platform support (macOS, Windows, Linux)
β¨ Single file, easy installation, instant startup
π Built with speed in mind
π Works with .node-version
and .nvmrc
files
Installation
Using a script (macOS/Linux)
For bash
, zsh
and fish
shells, there's an automatic installation script.
First ensure that curl
and unzip
are already installed on you operating system. Then execute:
curl -fsSL https://fnm.vercel.app/install | bash
Upgrade
On macOS, it is as simple as brew upgrade fnm
.
On other operating systems, upgrading fnm
is almost the same as installing it. To prevent duplication in your shell config file add --skip-shell
to install command.
Parameters
--install-dir
Set a custom directory for fnm to be installed. The default is $HOME/.fnm
.
--skip-shell
Skip appending shell specific loader to shell config file, based on the current user shell, defined in $SHELL
. e.g. for Bash, $HOME/.bashrc
. $HOME/.zshrc
for Zsh. For Fish - $HOME/.config/fish/conf.d/fnm.fish
--force-install
macOS installations using the installation script are deprecated in favor of the Homebrew formula, but this forces the script to install using it anyway.
Example:
curl -fsSL https://fnm.vercel.app/install | bash -s -- --install-dir "./.fnm" --skip-shell
Manually
Using Homebrew (macOS/Linux)
brew install fnm
Then, set up your shell for fnm
Using Winget (Windows)
winget install Schniz.fnm
Using Scoop (Windows)
scoop install fnm
Then, set up your shell for fnm
Using Chocolatey (Windows)
choco install fnm
Then, set up your shell for fnm
Using Cargo (Linux/macOS/Windows)
cargo install fnm
Then, set up your shell for fnm
Using a release binary (Linux/macOS/Windows)
- Download the latest release binary for your system
- Make it available globally on
PATH
environment variable - Set up your shell for fnm
Removing
To remove fnm (π’), just delete the .fnm
folder in your home directory. You should also edit your shell configuration to remove any references to fnm (ie. read Shell Setup, and do the opposite).
Completions
fnm ships its completions with the binary:
fnm completions --shell <SHELL>
Where <SHELL>
can be one of the supported shells:
bash
zsh
fish
powershell
Please follow your shell instructions to install them.
Shell Setup
Environment variables need to be setup before you can start using fnm.
This is done by evaluating the output of fnm env
.
To automatically run fnm use
when a directory contains a .node-version
or .nvmrc
file, add the --use-on-cd
option to your shell setup.
Adding a .node-version
to your project is as simple as:
$ node --version
v14.18.3
$ node --version > .node-version
Check out the following guides for the shell you use:
Bash
Add the following to your .bashrc
profile:
eval "$(fnm env --use-on-cd)"
Zsh
Add the following to your .zshrc
profile:
eval "$(fnm env --use-on-cd)"
Fish shell
Create ~/.config/fish/conf.d/fnm.fish
add this line to it:
fnm env --use-on-cd | source
PowerShell
Add the following to the end of your profile file:
fnm env --use-on-cd | Out-String | Invoke-Expression
- For macOS/Linux, the profile is located at
~/.config/powershell/Microsoft.PowerShell_profile.ps1
- On Windows, PowerShell comes pre-installed, but there are two versions of it. Read more about it here. The profile is located at different places depending on which version you're using:
- Built in PowerShell (aka "Windows PowerShell"):
~\Documents\WindowsPowerShell\Microsoft.PowerShell_profile.ps1
- The newer, PowerShell >= 7, that's not built in:
~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1
- Built in PowerShell (aka "Windows PowerShell"):
Windows Command Prompt aka Batch aka WinCMD
fnm is also supported but is not entirely covered. You can set up a startup script and append the following line:
FOR /f "tokens=*" %i IN ('fnm env --use-on-cd') DO CALL %i
i was unexpected at this time
, please make a .cmd file as suggested by the first step in the Usage with Cmder secton add it's path to the AutoRun
registry key.
Usage with Cmder
Usage is very similar to the normal WinCMD install, apart for a few tweaks to allow being called from the cmder startup script. The example assumes that the CMDER_ROOT
environment variable is set to the root directory of your Cmder installation.
Then you can do something like this:
- Make a .cmd file to invoke it
:: %CMDER_ROOT%\bin\fnm_init.cmd
@echo off
FOR /f "tokens=*" %%z IN ('fnm env --use-on-cd') DO CALL %%z
- Add it to the startup script
:: %CMDER_ROOT%\config\user_profile.cmd
call "%CMDER_ROOT%\bin\fnm_init.cmd"
You can replace %CMDER_ROOT%
with any other convenient path too.
Usage
See the available commands for an extended usage documentation
Contributing
PRs welcome π
Developing:
# Install Rust
git clone https://github.com/Schniz/fnm.git
cd fnm/
cargo build
Running Binary:
cargo run -- --help # Will behave like `fnm --help`
Running Tests:
cargo test