Docs For CLI

Set Proxy

Note

Proxy is highly recommended if github.com responds slowly.

vmr sp "http(socks5)://127.0.0.1:xxxx"

Set Reverse Proxy

Note

Choose either reverse proxy or proxy.

vmr sr "https://proxy.vmr.dpdns.org/proxy"

Show help info.

vmr -h

Show available SDK list.

vmr show

Show available version list for an SDK.

vmr search <sdk-name>

Show local installed SDKs.

vmr installed-sdks

Show local installed SDKs and their versions.

vmr installed-info

Show local installed versions for an SDK.

vmr local <sdk-name>

Install and switch to the specific version of an SDK globally.

vmr use <sdk-name@version>

Temporarily switch to specific version of an SDK in current termianl session.

vmr use -s <sdk-name@version>

Lock the SDK version for current project.

vmr use -l <sdk-name@version>

Uninstall the specific version of an SDK. (But not the one currently in use.)

vmr uninstall <sdk-name@version>

Uninstall all local installed versions for an SDK. (Including the one currently in use.)

vmr uninstall <sdk-name@all>

Add auto-completions for shell.

vmr add-completions

Allow/Disallow nested sessions.

vmr nested-sessions

Note

You should never use nested sessions and lock file at the same time. Or vmr will start a new session every time you run the cd command.

Show the mode of crrent shell.

vmr is-session-mode

Note

Note that session mode is not recommended for common use. So you should close the terminal or use exit command to terminate session mode. If you have installed an SDK in a session-mode shell using global mode, then the source command will not work. You can then use the customed alias svmr to flush envs.

SDK List not found?

Note

If VMR shows No SDK Found, you probably need to set a proxy for VMR.

How to enable multi-thread download?

Set number of threads > 1.

vmr st 2

How to toggle customed mirrors?

# $HOME/.vmr/customed_mirrors.toml
vmr tm

The default customed mirrors is available here.