Quick Start

Installation

Windows

powershell -c "irm https://scripts.vmr.dpdns.org/windows | iex"

MacOS

curl --proto '=https' --tlsv1.2 -sSf https://scripts.vmr.dpdns.org | sh

Linux

curl --proto '=https' --tlsv1.2 -sSf https://scripts.vmr.dpdns.org | sh

Note

Binaries built from go source code shows Virus False Positive somehow on Windows. VMR is signed by osslsigncode to avoid this annoying situation. However, we cannot ensure that it will never happen. In case of False Positive, you can manually add the VMR directory to your Trusted directory, or try to install the certificate.

The installation processes slowly？

Enable a proxy for your terminal.

Windows

$env:all_proxy="http://127.0.0.1:xxxx" #
$env:all_proxy="socks5://127.0.0.1:xxxx"

MacOS

export ALL_PROXY="http://127.0.0.1:xxxx" # export
ALL_PROXY="socks5://127.0.0.1:xxxx"

Linux

export ALL_PROXY="http://127.0.0.1:xxxx" # export
ALL_PROXY="socks5://127.0.0.1:xxxx"

Can I customize the Installation Dir for SDKs?

Yes, of course. A hint will prompt to ask for customizing your SDK Installation Dir during the installation of VMR for the first time on your system.

And you can also edit the config file for VMR manually.

$HOME/.vmr/config.toml

Where is VMR installed?

$HOME/.vmr/

# Windows
# %HOMEPATH%/.vmr/

Post Installation

If an error like “ps1 cannot be loaded because running scripts is disabled on this system” occurrs in Powershell, try the following command.

Set-ExecutionPolicy -ExecutionPolicy Bypass -Scope CurrentUser

Update

vmr-update

Uninstall

vmr-uninstall

Learn More

• concepts
• documents
• faqs