fnm

Fast and simple Node.js version manager, built in Rust

Node.js version management
Schniz/fnmfnm.vercel.app

README

Fast Node Manager (fnm) Amount of downloads GitHub Actions workflow status


:rocket: Fast and simple Node.js version manager, built in Rust


Blazing fast!

Features


:earth_americas: Cross-platform support (macOS, Windows, Linux)

:sparkles: Single file, easy installation, instant startup

:rocket: Built with speed in mind

:open_file_folder: 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:

  1. ```sh
  2. curl -fsSL https://fnm.vercel.app/install | bash
  3. ```

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:

  1. ```sh
  2. curl -fsSL https://fnm.vercel.app/install | bash -s -- --install-dir "./.fnm" --skip-shell
  3. ```

Manually


Using Homebrew (macOS/Linux)


  1. ```sh
  2. brew install fnm
  3. ```

Then, set up your shell for fnm

Using Scoop (Windows)


  1. ```sh
  2. scoop install fnm
  3. ```

Then, set up your shell for fnm

Using Chocolatey (Windows)


  1. ```sh
  2. choco install fnm
  3. ```

Then, set up your shell for fnm

Using Cargo (Linux/macOS/Windows)


  1. ```sh
  2. cargo install fnm
  3. ```

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
- Configure your shell profile:

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:

  1. ```sh
  2. fnm completions --shell <SHELL>
  3. ```

Where `` 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:
  1. ``` sh
  2. $ node --version
  3. v14.18.3
  4. $ node --version > .node-version
  5. ```

Check out the following guides for the shell you use:

Bash


Add the following to your .bashrc profile:

  1. ``` sh
  2. eval "$(fnm env --use-on-cd)"
  3. ```

Zsh


Add the following to your .zshrc profile:

  1. ```zsh
  2. eval "$(fnm env --use-on-cd)"
  3. ```

Fish shell


Create ~/.config/fish/conf.d/fnm.fish add this line to it:

  1. ```fish
  2. fnm env --use-on-cd | source
  3. ```

PowerShell


Add the following to the end of your profile file:

  1. ``` sh
  2. fnm env --use-on-cd | Out-String | Invoke-Expression
  3. ```

- On Windows, the profile is located at ~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1 or $PROFILE
- For macOS/Linux, the profile is located at ~/.config/powershell/Microsoft.PowerShell_profile.ps1

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:

  1. ```batch
  2. FOR /f "tokens=*" %i IN ('fnm env --use-on-cd') DO CALL %i
  3. ```
⚠️ If you get the error 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
  1. ```batch
  2. :: %CMDER_ROOT%\bin\fnm_init.cmd
  3. @echo off
  4. FOR /f "tokens=*" %%z IN ('fnm env --use-on-cd') DO CALL %%z
  5. ```
- Add it to the startup script
  1. ```batch
  2. :: %CMDER_ROOT%\config\user_profile.cmd
  3. call "%CMDER_ROOT%\bin\fnm_init.cmd"
  4. ```
You can replace %CMDER_ROOT% with any other convenient path too.

Usage


See the available commands for an extended usage documentation

Contributing


PRs welcome :tada:

Developing:


  1. ```sh
  2. # Install Rust
  3. git clone https://github.com/Schniz/fnm.git
  4. cd fnm/
  5. cargo build
  6. ```

Running Binary:


  1. ```sh
  2. cargo run -- --help # Will behave like `fnm --help`
  3. ```

Running Tests:


  1. ```sh
  2. cargo test
  3. ```