An open API service indexing awesome lists of open source software.

https://github.com/simshaun/nodeswap

A Node.js version management tool for Windows.
https://github.com/simshaun/nodeswap

csharp dotnet dotnet5 node nodejs nvm windows

Last synced: 6 months ago
JSON representation

A Node.js version management tool for Windows.

Awesome Lists containing this project

README

          

# NodeSwap

NodeSwap is a Windows-only version manager for [Node.js][1], similar to NVM.

[1]: https://nodejs.org/

![NodeSwap command overview](example0.png)
![NodeSwap swapping Node.js versions](example1.png)

## Installing and Updating

> ### ⚠ Prerequisites:
> - **Minimum of .NET 8.0**
> - There's a good chance you already have this on modern Windows.
> - If not, download & install at least [.NET 8.0][2].
>
> - **Existing Node.js installations:**
> - Be sure to uninstall any existing Node.js installations.
> - Remove `%AppData%\npm` to prevent global module conflicts.

### Install NodeSwap
Download and run the latest installer from the [Releases][3] page.

### Upgrade NodeSwap
Download and run the latest installer from the [Releases][3] page.

[2]: https://dotnet.microsoft.com/download
[3]: https://github.com/simshaun/NodeSwap/releases

## Usage

Type `nodeswap` in your terminal for help.

### Commands:

- `nodeswap` — Provides an overview of commands
- `nodeswap list` — List the Node.js installations.
- `nodeswap avail []` — List the versions available for download. A minimum
version can be specified to reduce the amount of output.
- `nodeswap install ` — The version can be `latest`, a specific version
like `22.6.0`, or a fuzzy version like `22.6` or `22`.
- `nodeswap uninstall ` — The version must be specific like `22.6.0`.
- `nodeswap use ` — Switch to a specific version. Must be specific like `22.6.0`.

> ### ⚠ Admin privileges:
> NodeSwap uses a symlink to point your CLI to the active Node.js version.
> On Windows, creating symlinks requires admin privileges.
> When swapping Node.js versions, the `use` command will prompt for administrator
> access if your terminal isn't already elevated.


## How-to

### Change where NodeSwap stores Node.js installations:
NodeSwap utilizes an environment var named `NODESWAP_STORAGE`. Simply update it
with a new path.

> Be sure the path actually exists. NodeSwap does not create it for you.

## Issues & Feature Requests

- Please report in the [Issue Tracker](https://github.com/simshaun/NodeSwap/issues).

## License

MIT