You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
0xflotus b2add20429
fixed small error (#247)
4 years ago
.ci Allow using homebrew to install with the installation script (#244) 4 years ago
.github/workflows Shorten the installation script (#245) 4 years ago
docs v1.21.0 5 years ago
esy.lock Update rely (#202) 5 years ago
executable Fix condition (#225) 5 years ago
feature_tests Add `current` command to retrieve the current Node version (#220) 5 years ago
fmt.esy.lock Add a CI check for code formatting (#151) 5 years ago
library v1.21.0 5 years ago
site Shorten the installation script (#245) 4 years ago
test Add `fnm exec` to run commands with the fnm environment (#194) 5 years ago
.dockerignore Nsw 6 years ago
.gitignore Format dotfiles versions before comparison (#207) 5 years ago
CHANGELOG.md v1.21.0 5 years ago
Dockerfile Bump ocaml to 4.08 (#192) 5 years ago
LICENSE Add a GPL v3 LICENSE file (#22) 6 years ago
README.md fixed small error (#247) 4 years ago
azure-pipelines.yml Revert into using `ocaml-tls` instead of `ocaml-ssl` (#172) 5 years ago
dune initial 6 years ago
dune-project Rename to fnm (#2) 6 years ago
fmt.json Add a CI check for code formatting (#151) 5 years ago
fnm.opam Rename to fnm (#2) 6 years ago
package.json v1.21.0 5 years ago

README.md

Fast Node Manager (fnm) Amount of downloads Build Status

🚀 Fast and simple Node.js version manager, built in native ReasonML

Blazing fast!

Features

Single file, easy installation, instant startup

🚀 Built with speed in mind

🤔 Works with .nvmrc and .node-version files

Installation

Using a script

For bash, zsh and fish shells, there's an automatic installation script:

curl -fsSL https://fnm.vercel.app/install | bash

Upgrade

On OSX, it is a simple as brew upgrade Schniz/tap/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/config.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 (OSX)

This is a custom tap I'm maintaining, and will be used until fnm will move to the official one.

brew install Schniz/tap/fnm

Then apply the changes the installer prints, to set up your shell profile.

Using a release binary

  • Download the latest release binary for your system

  • Make it available globally on $PATH

  • Add the following line to your .bashrc/.zshrc file:

    eval "$(fnm env --multi)"
    

    If you are using fish shell, add this line to your config.fish file:

    fnm env --multi | source
    

Completions

Usage

You can always use fnm --help to read the docs:

fnm install [VERSION]

Installs [VERSION]. If no version provided, it will install the version specified in the .nvmrc file located in the current working directory.

fnm use [VERSION]

Activates [VERSION] as the current Node version. If no version provided, it will activate the version specified in the .nvmrc or .node-version file located in the current working directory.

fnm current

Display currently activated Node version.

fnm ls

Lists the installed Node versions.

fnm ls-remote

Lists the Node versions available to download remotely.

fnm uninstall [VERSION]

Uninstalls the node version specified in [VERSION].

fnm alias [VERSION] [NAME]

Aliases a Node version to a given name.

fnm default [VERSION]

Aliases a Node version as default. Uses fnm alias underneath.

fnm env [--multi] [--shell=fish|bash|zsh] [--node-dist-mirror=URI] [--use-on-cd] [--fnm-dir=DIR] [--log-level=quiet|error|all]

Prints the required shell commands in order to configure your shell, Bash compliant by default.

  • Providing --multi will output the multishell support, allowing a different current Node version per shell
  • Providing --shell=fish will output the Fish-compliant version. Omitting it and fnm will try to infer the current shell based on the process tree
  • Providing --node-dist-mirror="https://npm.taobao.org/dist" will use the Chinese mirror of Node.js
  • Providing --use-on-cd will also output a script that will automatically change the node version if a .nvmrc/.node-version file is found
  • Providing --fnm-dir="/tmp/fnm" will install and use versions in /tmp/fnm directory

Future Plans

  • Feature: fnm use --install
  • Linux: Replace tar with a statically linked library too (for ungzip + untar)
  • Windows Support? @ulrikstrid has worked hard to make it compile on Windows, but it will probably need to have different code paths and logic. We can probably make another program and share feature tests with it, instead of relying on Windows for this very-unixy binary.

Contributing

PRs welcome 🎉

Developing:

npm install -g esy
git clone https://github.com/Schniz/fnm.git
cd fnm/
esy install
esy bootstrap
esy build

Running Binary:

After building the project, you can run the main binary that is produced.

esy x fnm.exe

Running Tests:

# Runs some smoke-unity test
esy test

# Runs the feature tests
feature_tests/run.sh