Skip to content

Latest commit

 

History

History
259 lines (160 loc) · 6.09 KB

reference.md

File metadata and controls

259 lines (160 loc) · 6.09 KB
Raw

Command Reference

Get-NodeInstallLocation

Will return the path that node.js versions will be installed into

Get-NodeInstallLocation

Parameters

None

Examples

Get-NodeInstallLocation

Get-NodeVersions

Used to show all the node.js versions installed to nvm, using the -Remote option allows you to list versions of node.js available for install. Providing a -Filter parameter can filter the versions using the pattern, either local or remote versions. The versions are sorted from highest to lowest and can be compared with PowerShell operators.

Get-NodeVersions -Remote <SwitchParameter> -Filter <String>

Parameters

  • -Remote <SwitchParameter>
    Indicate whether or not to list local or remote versions
  • -Filter <String>
    A semver version range to filter versions

Examples

Get-NodeVersions -Remote -Filter ">=7.0.0 <9.0.0"
Show all versions available to download between v7 and v9
Get-NodeVersions -Filter '>=7.0.0 <9.0.0'
Return the installed versions as strings
(Get-NodeVersions | Select-Object -First 1) -lt (Get-NodeVersions -Remote | Select-Object -First 1)

Install-NodeVersion

Download and install the specified version of node.js into the nvm directory. Once installed it can be used with Set-NodeVersion

Install-NodeVersion -Version <String[]> -Force <SwitchParameter> -Architecture <String> -Proxy <String>

Parameters

  • -Version <String[]>
    A semver range for the version of node.js to install
  • -Force <SwitchParameter>
    Reinstall an already installed version of node.js
  • -Architecture <String>
    The architecture of node.js to install, defaults to [System.Runtime.InteropServices.RuntimeInformation]::OSArchitecture
  • -Proxy <String>
    Define HTTP proxy used when downloading an installer

Examples

Install-NodeVersion v5.0.0
Install version 5.0.0 of node.js into the module directory
Install-NodeVersion v5.0.0, v6.0.0
Installs versions 5.0.0 and 6.0.0 of node.js into the module directory
Install-NodeVersion ^5
Install the latest 5.x.x version of node.js into the module directory
Install-NodeVersion v5.0.0 -Architecture x86
Installs the x86 version even if you're on an x64 machine
Install-NodeVersion v5.0.0 -Architecture x86 -proxy http://localhost:3128
Installs the x86 version even if you're on an x64 machine using default CNTLM proxy

Remove-NodeVersion

Removes an installed version of node.js along with any installed npm modules

Remove-NodeVersion -Version <String[]>

Parameters

  • -Version <String[]>
    The full version string of the node.js package to remove

Examples

Remove-NodeVersion v5.0.0
Removes the v5.0.0 version of node.js from the nvm store
Get-NodeVersions | Remove-NodeVersion
Remove ALL versions of node.js from the nvm store

Set-NodeInstallLocation

This is used to override the default node.js install path for nvm, which is relative to the module install location. You would want to use this to get around the Windows path limit problem that plagues node.js installed. Note that to avoid collisions the unpacked files will be in a folder .nvm\<version> in the specified location.

Set-NodeInstallLocation -Path <String> -WhatIf <SwitchParameter> -Confirm <SwitchParameter>

Parameters

  • -Path <String>
    The root folder for nvm. Path must be absolute.
  • -WhatIf <SwitchParameter>
    Shows what would happen if the cmdlet runs. The cmdlet is not run.
  • -Confirm <SwitchParameter>
    Prompts you for confirmation before running the cmdlet.

Examples

Set-NodeInstallLocation -Path C:\Temp

Set-NodeVersion

Set's the node.js version that was either provided with the -Version parameter, from using the .nvmrc file or the node engines field in package.json in the current working directory.

Set-NodeVersion -Version <String> -SemVer <Version> -Persist <String>

Parameters

  • -Version <String>
    A semver version range for the node.js version you wish to use.
  • -SemVer <Version>
    A SemVer object returned from Get-NodeVersions.
  • -Persist <String>
    If present, this will also set the node.js version to the permanent system path, of the specified scope, which will persist this setting for future powershell sessions and causes this version of node.js to be referenced outside of powershell.

Examples

Set-NodeVersion
Set based on the .nvmrc or package.json engines node field
Set-NodeVersion 5.0.1
Set using explicit version
Set-NodeVersion ~5.2
Sets to the latest installed patch version of v5.2
Set-NodeVersion ^5
Sets to the latest installed v5 version
Set-NodeVersion '>=5.0.0 <7.0.0'
Sets to the latest installed version between v5 and v7
Get-NodeVersions '>=5.0.0 <7.0.0' | Set-NodeVersion
Sets to the latest installed version between v5 and v7 that's actually installed
Set-NodeVersion v5.0.1 -Persist User
Set and persist in permanent system path for the current user
Set-NodeVersion v5.0.1 -Persist Machine
Set and persist in permanent system path for the machine (Note: requires an admin shell)