Skip to content
master
Switch branches/tags
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
May 17, 2021

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

πŸš€ Fast and simple Node.js version manager, built in Rust

Blazing fast!

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:

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 Scoop (Windows)

scoop 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
  • 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:

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

fnm needs to run some shell commands before you can start using it. This is done by evaluating the output of fnm env. Check out the following guides for the shell you use:

Bash

add the following to your .bashrc profile:

eval "$(fnm env)"

Zsh

add the following to your .zshrc profile:

eval "$(fnm env)"

Fish shell

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

fnm env | source

PowerShell

Before adding any configuration to your shell, you'd need to enable symlink support for a standard accounts (non-administrator).

You can do it by enabling Developer Mode, or updating the Local Security Policy.

Local Security Policy

Open Local Security Policy (secpol.msc) and go to Local Policies -> User Rights Assignment, select Create symbolic links, add your user to the list and reboot.

Use whoami if you are not sure what's your user name.

Add the following to the end of your profile file:

fnm env --use-on-cd | Out-String | Invoke-Expression
  • 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:

FOR /f "tokens=*" %i IN ('fnm env --use-on-cd') DO CALL %i

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