⛓️ Rivet Toolchain
Installation
Windows (x86)
```sh
curl -L https://releases.rivet.gg/toolchain/v2.0.0-rc.5/windows_x86_64/rivet.exe.zip -o rivet.exe.zip
unzip rivet.exe.zip
```
Add the directory containing rivet.exe to your PATH environment variable.
macOS (Apple Silicon)
```sh
curl -L https://releases.rivet.gg/toolchain/v2.0.0-rc.5/macos_arm64/rivet.zip -o rivet.zip
unzip rivet.zip
chmod +x rivet
sudo mv rivet /usr/local/bin/
```
macOS (Intel)
```sh
curl -L https://releases.rivet.gg/toolchain/v2.0.0-rc.5/macos_x86_64/rivet.zip -o rivet.zip
unzip rivet.zip
chmod +x rivet
sudo mv rivet /usr/local/bin/
```
Linux (x86)
```sh
curl -L https://releases.rivet.gg/toolchain/v2.0.0-rc.5/linux_x86_64/rivet.zip -o rivet.zip
unzip rivet.zip
chmod +x rivet
sudo mv rivet /usr/local/bin/
```
Build from source (`cargo install`)
1. [Install Rust](https://rustup.sh)
2. Install Rivet
```sh
cargo install --git=https://github.com/rivet-gg/toolchain rivet-cli
```
Build from source (`cargo build`)
1. [Install Rust](https://rustup.sh)
2. Install Rivet
```sh
git clone https://github.com/rivet-gg/toolchain.git
cd packages/cli
cargo build
```
The executable will be available at _target/debug/rivet_.
Documentation
All commands in the Rivet CLI are documented with the --help
flag.
$ rivet --help
Usage: rivet <COMMAND>
Commands:
init Login to a game
login Login to a game
logout Logout from a game
dev Run the development server
deploy Build & upload the game server & backend
config Manage Rivet configuration
clean Remove artifacts that Rivet generates
create Add functionality to backend
db Manage Postgres database
sdk Manage the Rivet SDK
backend Manage the backend
module
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help
-V, --version Print version
Quick Start
After installation, you can quickly get started with Rivet by following these steps:
-
Initialize a new Rivet project:
rivet init
-
Start the development server:
rivet dev
-
Deploy your game:
rivet login
rivet deploy
Troubleshooting
If you encounter any issues while using Rivet, try the following:
- Ensure you're using the latest version of Rivet
- Use the
rivet clean
command to remove any artifacts that might be causing problems
- Join our Discord for support
Please open an issue for any issues you run in to.
Contributing
We welcome contributions to the Rivet Toolchain! If you'd like to contribute, please:
- Fork the repository
- Create a new branch for your feature
- Make your changes
- Submit a pull request
For more detailed information, see our contribution guidelines.
License
Rivet Toolchain is released under the Apache 2.0 License.