Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/numtostr/snm
🤏 Smol and simple node version manager written in rust 🦀
https://github.com/numtostr/snm
cargo cli javascript node nodejs npm nvm package rust semver shell version-manager
Last synced: 5 days ago
JSON representation
🤏 Smol and simple node version manager written in rust 🦀
- Host: GitHub
- URL: https://github.com/numtostr/snm
- Owner: numToStr
- License: gpl-3.0
- Created: 2020-12-23T13:36:56.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-16T03:02:44.000Z (about 2 years ago)
- Last Synced: 2025-01-10T05:14:44.862Z (12 days ago)
- Topics: cargo, cli, javascript, node, nodejs, npm, nvm, package, rust, semver, shell, version-manager
- Language: Rust
- Homepage:
- Size: 308 KB
- Stars: 109
- Watchers: 2
- Forks: 3
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
🤏 Smol Node Manager
Terminal: kitty | Prompt: starship
## ✨ Features
- It's fast as it is written in Rust.
- Cross Platfrom (Linux/macOS/Windows)
- Supports `.nvmrc`, `.node-version` and `package.json`
- Supports multiple shells
- Tons of commands and options
## 🚀 Installation
#### From package managers
- Using `cargo` (Linux/macOS/Windows)
```sh
cargo install snm
```
- Using `yay` or `pamac` (Arch Linux)
> Why snm is available for Arch? Because I love Arch Linux
```sh
# Using `yay`
yay -S snm
# Using `pamac`
pamac build snm
```
#### From binaries
Check out the [Release page](https://github.com/numToStr/snm/releases) for prebuild binaries for `snm`, available for different operating systems.
#### From script (Linux/macOS/Windows)
```sh
curl -fsSL https://git.io/JLFnA | bash
```
Available Params
- `--install-dir` : Set a custom directory for binary installation. Defaults to `$HOME/.snm`
- `--skip-shell` : Skip appending shell specific loader to the `$SHELL` config file.
---
> NOTE: `snm` uses symlinks underneath to manage aliases. So, If you are using **Windows** make sure you have enabled **Developer Mode** or your user has permission to create symlinks. You can read more [here](https://blogs.windows.com/windowsdeveloper/2016/12/02/symlinks-windows-10/)
---
## 🔧 Setup
- **Bash**
Add the following line to your `~/.bashrc`
```bash
eval "$(snm env bash)"
```
- **Zsh**
Add the following line to your `~/.zshrc`
```zsh
eval "$(snm env zsh)"
```
- **Fish**
Add the following line to your `~/.config/fish/config.fish`
```fish
snm env fish | source
```
- **PowerShell**
Add the following line to your `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1`
```bash
snm env pwsh | Out-String | Invoke-Expression
```
You can find more about the powershell profile [here](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_profiles)
## 🤞 Usage
#### Global Options/Flags
| Options | Env Variable | Description |
| -------------------- | ---------------------- | --------------------------------------------------- |
| `--snm-dir` | `SNM_DIR` | Directory where the all files and aliases are saved |
| `--node-dist-mirror` | `SNM_NODE_DIST_MIRROR` | Nodejs download mirror |
Example:
```sh
snm [--snm-dir="~/.something/else"] [--node-dist-mirror="https://myrelease.com"]
```
| Flags | Description |
| ----------- | ------------------------- |
| `--no-use` | Only download the release |
| `--version` | Prints the version |
| `--help` | Prints the help doc |
#### Commands
- `snm install ` : Install Nodejs with the provided version or lts codename
```sh
# Following command will downloads and installs the most recent 14.x.x release
snm install 14
# Following command will download the most recent lts/fermium release
snm install lts/fermium
# or snm install lts-fermium
# or snm i lts-fermium
```
- `snm uninstall [version|alias]` : Removes the installed Nodejs
> If given an alias like `ten` or `lts-fermium` then it will remove the version which the alias is pointing at and all the aliases which are pointing to the same version. Also, uninstalling a version will throw an error, if multiple installation is found in the same semver range or if the provided version/alias is active, add `--force` flag to override this behavior.
```sh
# Following command will remove 14.x.x installation
snm uninstall 14
# Following command will remove the lts/fermium release
snm uninstall lts/fermium
# or snm uninstall lts-fermium
# or snm rm lts-fermium
# Add --force flag to forcefully remove the active version
snm uninstall --force 16
```
- `snm use [version]` : Change Nodejs version, Supports `.nvmrc` and `.node-version`
```sh
# Following command will use a downloaded version matching 10.x.x
snm use 10
# Searches for `.nvmrc` or `.node-version`, if is not provided
snm use
```
- `snm lts` : Installs the recent **lts** release
- `snm latest` : Installs the recent **current** release
- `snm ls` : List all the local downloaded versions with their aliases
- `snm ls-remote [version]` : List remote Node.js versions
```sh
# Following command list 20 results with version matching 14.x.x
snm ls-remote 14
# This will show all the results
snm ls-remote 14 --all
# Following command will show 25 results
snm ls-remote 14 --count 25
```
- `snm alias ` : Alias a version to a common name
```sh
# Following command will alias the version 10 to ten
# 10 can refer to any semver release ie 10.15.0
snm alias 10 ten
```
- `snm unalias [name]` : Removes aliases
```sh
# Following command will removes alias `ten`
snm unalias ten
# Removes all the aliases
snm unalias --all
```
- `snm exec ` : Executes a command within snm context with the modified PATH
```sh
# Following command will output the Nodejs version
snm exec 10 -- node -v
# Following command will run yarn with Nodejs v10.x.x
snm exec 10 -- yarn start
```
- `snm purge` : Remove all the installed versions and aliases. Except the active version.
```
# Doesn't remove the active version
snm purge
# Will remove everything including the active version
snm purge --all
```
- `snm which ` : Prints path for the downloaded Nodejs version
- `snm help ` or `snm --help` : Help doc for the subcommand
> NOTE: This is a small part of help doc. Please make sure to read the inbuilt help
#### Completions
`snm` binary has inbuilt completions supports. Please follow the instruction to generate completions according to your shell.
- For Zsh
```sh
snm completions zsh
```
- For Bash
```sh
snm completions bash
```
- For Fish
```sh
snm completions fish
```
- For PowerShell
```sh
snm completions pwsh
```
After generating the completions, please follow your shell instructions on how to load and use them.
## 🤝 Contributing
PRs are always welcome. You can help me by adding more tests :).
First, You need to install rust toolchain via [rustup](https://rustup.rs/).
> Minimum Supported Rust Version (MSRV): 1.54.0
- **Setup**
```sh
git clone https://github.com/numtostr/snm
cd ./snm
```
- **Build**
```sh
# For debug build
cargo build
# For release build
cargo build --release
```
- **Running**
```sh
# Same as running `snm --help`
cargo run -- --help
# Same as running `snm lsr 14`
cargo run -- lsr 14
```
## 💐 Credits
This project would not be possible without these awesome projects.
- [n](https://github.com/tj/n) for cli design
- [fnm](https://github.com/Schniz/fnm) for giving me a base project and some code :)