Browse Source

docs: update command docs

remotes/origin/feat/support-install-latest
Fred 3 years ago
parent
commit
e391a2c831
  1. 35
      docs/commands.md

35
docs/commands.md

@ -1,7 +1,6 @@
# `fnm` # `fnm`
``` ```
fnm 1.32.0 fnm 1.31.1
A fast and simple Node.js manager A fast and simple Node.js manager
USAGE: USAGE:
@ -78,9 +77,7 @@ SUBCOMMANDS:
use use
Change Node.js version Change Node.js version
``` ```
# `fnm alias` # `fnm alias`
``` ```
fnm-alias fnm-alias
Alias a version to a common name Alias a version to a common name
@ -135,9 +132,7 @@ OPTIONS:
[default: local] [default: local]
[possible values: local, recursive] [possible values: local, recursive]
``` ```
# `fnm completions` # `fnm completions`
``` ```
fnm-completions fnm-completions
Print shell completions to stdout Print shell completions to stdout
@ -188,9 +183,7 @@ OPTIONS:
[default: local] [default: local]
[possible values: local, recursive] [possible values: local, recursive]
``` ```
# `fnm current` # `fnm current`
``` ```
fnm-current fnm-current
Print the current Node.js version Print the current Node.js version
@ -238,9 +231,7 @@ OPTIONS:
[default: local] [default: local]
[possible values: local, recursive] [possible values: local, recursive]
``` ```
# `fnm default` # `fnm default`
``` ```
fnm-default fnm-default
Set a version as the default version Set a version as the default version
@ -294,9 +285,7 @@ OPTIONS:
[default: local] [default: local]
[possible values: local, recursive] [possible values: local, recursive]
``` ```
# `fnm env` # `fnm env`
``` ```
fnm-env fnm-env
Print and set up required environment variables for fnm Print and set up required environment variables for fnm
@ -325,9 +314,6 @@ OPTIONS:
-h, --help -h, --help
Print help information Print help information
--json
Print JSON instead of shell commands
--log-level <LOG_LEVEL> --log-level <LOG_LEVEL>
The log level of fnm commands The log level of fnm commands
@ -362,9 +348,7 @@ OPTIONS:
[default: local] [default: local]
[possible values: local, recursive] [possible values: local, recursive]
``` ```
# `fnm exec` # `fnm exec`
``` ```
fnm-exec fnm-exec
Run a command within fnm context Run a command within fnm context
@ -424,15 +408,11 @@ OPTIONS:
[default: local] [default: local]
[possible values: local, recursive] [possible values: local, recursive]
``` ```
# `fnm help` # `fnm help`
``` ```
``` ```
# `fnm install` # `fnm install`
``` ```
fnm-install fnm-install
Install a new Node.js version Install a new Node.js version
@ -458,6 +438,9 @@ OPTIONS:
-h, --help -h, --help
Print help information Print help information
--latest
Install latest version
--log-level <LOG_LEVEL> --log-level <LOG_LEVEL>
The log level of fnm commands The log level of fnm commands
@ -487,9 +470,7 @@ OPTIONS:
[default: local] [default: local]
[possible values: local, recursive] [possible values: local, recursive]
``` ```
# `fnm list` # `fnm list`
``` ```
fnm-list fnm-list
List all locally installed Node.js versions List all locally installed Node.js versions
@ -537,9 +518,7 @@ OPTIONS:
[default: local] [default: local]
[possible values: local, recursive] [possible values: local, recursive]
``` ```
# `fnm list-remote` # `fnm list-remote`
``` ```
fnm-list-remote fnm-list-remote
List all remote Node.js versions List all remote Node.js versions
@ -587,9 +566,7 @@ OPTIONS:
[default: local] [default: local]
[possible values: local, recursive] [possible values: local, recursive]
``` ```
# `fnm unalias` # `fnm unalias`
``` ```
fnm-unalias fnm-unalias
Remove an alias definition Remove an alias definition
@ -641,9 +618,7 @@ OPTIONS:
[default: local] [default: local]
[possible values: local, recursive] [possible values: local, recursive]
``` ```
# `fnm uninstall` # `fnm uninstall`
``` ```
fnm-uninstall fnm-uninstall
Uninstall a Node.js version Uninstall a Node.js version
@ -698,9 +673,7 @@ OPTIONS:
[default: local] [default: local]
[possible values: local, recursive] [possible values: local, recursive]
``` ```
# `fnm use` # `fnm use`
``` ```
fnm-use fnm-use
Change Node.js version Change Node.js version

Loading…
Cancel
Save