fnm README

The project's README from github.com/Schniz/fnm. As one markdown file: README.md.

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.

First ensure that curl and unzip are already installed on your 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, pass --skip-shell to the install command:

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

Parameters

--install-dir

Set a custom directory for fnm to be installed. The default is $XDG_DATA_HOME/fnm (if $XDG_DATA_HOME is not defined it falls back to $HOME/.local/share/fnm on linux and $HOME/Library/Application Support/fnm on MacOS).

Note: On macOS, this option is only meaningful when using --force-install since Homebrew is the default installation method.

--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)

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:

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.

[!TIP] Prefer passing an explicit shell (for example fnm env --shell bash) instead of relying on shell inference at runtime. It is a bit faster and avoids process tree detection.

[!NOTE] Check out the Configuration section to enable highly recommended features, like automatic version switching.

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 --shell bash)"

Zsh

Add the following to your .zshrc profile:

eval "$(fnm env --use-on-cd --shell zsh)"

Fish shell

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

fnm env --use-on-cd --shell fish | source

PowerShell

Add the following to the end of your profile file:

fnm env --use-on-cd --shell powershell | Out-String | Invoke-Expression

Windows Command Prompt aka Batch aka WinCMD

fnm is also supported but is not entirely covered. You can set up a startup script for cmd.exe or Windows Terminal and append the following lines:

@echo off
:: for /F will launch a new instance of cmd so we create a guard to prevent an infnite loop
if not defined FNM_AUTORUN_GUARD (
    set "FNM_AUTORUN_GUARD=AutorunGuard"
    FOR /f "tokens=*" %%z IN ('fnm env --use-on-cd') DO CALL %%z
)

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:

:: %CMDER_ROOT%\bin\fnm_init.cmd
@echo off
FOR /f "tokens=*" %%z IN ('fnm env --use-on-cd') DO CALL %%z
:: %CMDER_ROOT%\config\user_profile.cmd
call "%CMDER_ROOT%\bin\fnm_init.cmd"

You can replace %CMDER_ROOT% with any other convenient path too.

Configuration

See the available configuration options for an extended configuration documentation

Usage

See the available commands for an extended usage documentation

Contributing

PRs welcome :tada:

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

fnm (Schniz/fnm)

Searching Database…

27.1K ·GitHub
这是干什么的?fnm(Fast Node Manager)是一个用 Rust 编写的快速、简洁的 Node.js 版本管理器:只需一个二进制文件,就能安装各个 Node 版本,并在它们之间切换,全部在终端里完成。
这是个命令行工具,还是我要装进项目里的东西?它是一个命令行工具,不是库:单个文件的二进制程序,启动飞快,支持 macOS、Windows 和 Linux。
用之前需要先配置什么?需要配置你的 shell:在配置文件里执行 fnm env 的输出,把环境变量设置好。官方提供了 Bash、Zsh、Fish、PowerShell 和 Windows cmd 的配置指南。
有什么要注意的坑吗?在 macOS 上,官方安装脚本已被弃用,推荐改用 Homebrew(加 --force-install 可以强制用脚本安装);Windows cmd 虽然支持,但说明不够全面——PowerShell 的文档更完整。
fnm 怎么知道某个项目该用哪个 Node 版本?它会读取版本文件:在项目里放一个 .node-version(或 nvm 风格的 .nvmrc),fnm 就会采用其中的版本;自动切换版本是一个推荐开启的配置项。
fnm 怎么升级?在 macOS 上运行 brew upgrade fnm。其他平台上,升级和安装基本一样——加 --skip-root 参数,让安装程序不要在你的 shell 配置里重复写入加载代码。
怎么卸载它?删掉你主目录下的 .fnm 文件夹,然后从 shell 配置文件里移除与 fnm 相关的内容。
它自带 shell 补全吗?自带——bash、zsh、fish 和 powershell 的补全都内置在二进制文件里,按照你的 shell 的说明安装即可。
What are similar projects?nushell, git, eza, gping, truffle, just, coreutils, zoxide
Creator
Schniz
Size
4.3 MB
Stars
27.1K
Age
7y
Commits · 90 Days