vrc-get/README.md

vrc-get

Open Source command line client of VRChat Package Manager, the main feature of VRChat Creator Companion (VCC), that supports Windows, Linux, and macOS.

This project is developed by community, not by VRChat.

Goals

Initial goals

• Provide Open Source command line client of VRChat Package Manager.
• Provide more functionality fpr VPM than official vpm command.

Additional goals since 2024

• Provide better cross-platform Creator Companion

Commands

For more details, please see --help

• vrc-get install [pkg] [version] (with alias vrc-get i [pkg] [version] and vrc-get resolve) install package to your project
• vrc-get remove [pkg] (with alias vrc-get rm [pkg]) remove package from your project
• vrc-get outdated list outdated packages in your project
• vrc-get upgrade [pkg] [version] upgrade package(s) in your project
• vrc-get search <query...> search package in installed repositories in your PC
• vrc-get repo list list installed repositories in your PC
• vrc-get repo add <url> [NAME] add repository into your PC
• vrc-get repo remove <name or url> remove repository from your PC
• vrc-get repo cleanup cleanup repo cache
• vrc-get repo packages <NAME|url> list packages in specified repository

Installation

Using homebrew

If you're using homebrew, you can install vrc-get from my tap via brew install anatawa12/core/vrc-get.

Due to lack of star, fork, or watches, I couldn't publish to homebrew core. (Homebrew/homebrew-core#122922) Please star this repository!

Using scoop

If you're using scoop, you can install from a scoop bucket.

scoop bucket add xrtools "https://github.com/babo4d/scoop-xrtools"
scoop install vrc-get

Using cargo binstall

If you have cargo binstall, installing using cargo binstall is the easy & fast way to install vrc-get. Cargo binstall will downloads & installs prebuilt vrc-get from GitHub.

cargo binstall vrc-get

Using cargo

If you have cargo, installing using cargo is an easy way to install vrc-get.

Since vrc-get 1.6.0, the experimental-vcc feature which is enabled by default requires dotnet to build vrc-get. Please make sure you have installed dotnet to your system or disable the feature by --no-default-features flag. In addition, the NativeAOT, a part of dotnet which vrc-get use, requires clang and newer version of ld to build so please install them to your system.

cargo install vrc-get

Prebuilt binaries

There's prebuilt binaries on the release page.

Download executable file for your platform and place to everywhere you want. There's no additional requirements for thise binaries. All binaries are compiled statically as possible.

For linux, it's a actually static linked executable.

For windows, only bcrypt.dll, ntdll.dll, kernel32.dll, advapi32.dll, ws2_32.dll, secur32.dll, and crypt32.dll, which is builtin dlls, are dynamically linked.

For macOS, only Security.framework, CoreFoundation.framework, libiconv.2.dylibs, and libSystem.B.dylibs, which are macOS-builtin dylibs, are dynamically linked.

For GitHub Actions

To use this tool to resolve(install) vpm dependencies, you can use anatawa12/sh-actions/resolve-vpm-packages@master.

To use other commands, you can install vpm-get via anatawa12/sh-actions/setup-vrc-get@master.

For more details, please see README for each action.