Skip to content
VylocoreBeta
Get started
Menu
Documentation

Install & update

Download, then check the SHA-256 checksum.

Windows#

$archive = Get-Item -LiteralPath .\vylocore-0.2.0-rc.3-windows-x64.zip
Get-FileHash -LiteralPath $archive.FullName -Algorithm SHA256
Expand-Archive -LiteralPath $archive.FullName -DestinationPath .\vylocore-cli
.\vylocore-cli\install.ps1
$env:Path = "$env:LOCALAPPDATA\Vylocore\bin;$env:Path"
vylocore --version

Use your downloaded filename. Review install.ps1; administrator access is unnecessary. Releases are unsigned. Add the install folder to your user PATH.

Linux#

sha256sum vylocore-0.2.0-rc.3-linux-x64.zip
unzip vylocore-0.2.0-rc.3-linux-x64.zip -d vylocore-cli
sh vylocore-cli/install.sh
export PATH="$HOME/.local/bin:$PATH"
vylocore --version

macOS and Node#

macOS execution, Keychain, signing and notarization checks are pending.

The npm tarball needs Node 22.12+: Use a maintained Node release with current security patches. Standalone rc.3 ZIPs include Node 22.23.3.

npm install --global ./vylocore-cli-0.2.0-rc.3.tgz
vylocore --version

Customer Gateway#

vylocore gateway init --project YOUR_SLUG --gateway-url https://app.example.com/_g --output gateway.zip
vylocore gateway status --project YOUR_SLUG
vylocore gateway doctor --project YOUR_SLUG

Upload/extract the private ZIP on your Linux server. Run sudo sh install.sh, add the generated proxy.conf to your HTTPS Nginx site and reload it, then run sudo ./gateway connect. This checks HTTPS, registers and confirms the connection. Follow README.txt for requirements, updates, rotation and backups. Private keys stay on your server. CLI gateway register can also complete verification after installation; it uses the same project registration flow as the website.

Updating#

vylocore version --check

This checks without installing. Follow the release instructions; installers refuse overwrites. Get checksums over trusted HTTPS. If the server requires a newer CLI, this command exits with code 2. Install the selected release after removing the previous executable.

Uninstalling#

Run vylocore logout --revoke first if you want to disable its server credential too. Remove the executable you installed:

Remove-Item -LiteralPath "$env:LOCALAPPDATA\Vylocore\bin\vylocore.exe"

rm -- "$HOME/.local/bin/vylocore"

For an npm installation, use npm uninstall --global @vylocore/cli. Remove the install folder from PATH. Project files and downloaded builds are separate.

Contact support

Documentation