Skip to content

Schniz/fnm

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Mar 4, 2019
6d74eb1 Β· Mar 4, 2019

History

62 Commits
Mar 4, 2019
Mar 4, 2019
Feb 25, 2019
Mar 4, 2019
Mar 4, 2019
Mar 4, 2019
Feb 18, 2019
Jan 22, 2019
Jan 23, 2019
Mar 4, 2019
Feb 25, 2019
Feb 13, 2019
Mar 4, 2019
Feb 10, 2019
Jan 13, 2019
Jan 23, 2019
Jan 23, 2019
Mar 4, 2019

Repository files navigation

Fast Node Manager (fnm) Amount of downloads Build Status

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

Blazing fast!

Features

✨ Single file, easy installation

πŸš€ 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 https://raw.githubusercontent.com/Schniz/fnm/master/.ci/install.sh | bash

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

Example:

curl https://raw.githubusercontent.com/Schniz/fnm/master/.ci/install.sh | bash -s --install-dir "./.fnm" --skip-shell

Manually

  • 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

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 ls

Lists the installed Node versions.

fnm ls-remote

Lists the Node versions available to download remotely.

fnm env [--multi] [--shell=fish|bash|zsh] [--node-dist-mirror=URI] [--use-on-cd] [--base-dir=DIR]

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 --base-dir="/tmp/fnm" will install and use versions in /tmp/fnm directory

Future Plans

  • Feature: fnm use --install
  • Feature: fnm install lts?
  • OSX: Add to homebrew?
  • Windows Support?
  • Linux: Replace tar with a statically linked library too (for ungzip + untar)

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