diff --git a/README.md b/README.md index ab9c6549..87277aed 100644 --- a/README.md +++ b/README.md @@ -1,68 +1,56 @@ -# Rivet CLI +# ⛓️ Rivet Toolchain ## Installation
-macOS & Linux & WSL - -**Install latest version** +Windows (x86) ```sh -curl -fsSL https://raw.githubusercontent.com/rivet-gg/cli/main/install/unix.sh | 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 ``` -**Install specific version** +Add the directory containing rivet.exe to your PATH environment variable. +
-We recommend specifying the CLI version in CI environments. This also allows you to install prerelease versions of the CLI. +
+macOS (Apple Silicon) ```sh -export RIVET_CLI_VERSION="v1.0.0" -curl -fsSL https://raw.githubusercontent.com/rivet-gg/cli/${RIVET_CLI_VERSION}/install/unix.sh | 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/ ``` - -_The `export` keyword is important. The variable `RIVET_CLI_VERSION` needs to be accessible inside the install script._
-Windows (cmd) - -**Install latest version** - -```ps1 -powershell -Command "iwr https://raw.githubusercontent.com/rivet-gg/cli/main/install/windows.ps1 -useb | iex" -``` - -**Install specific version** - -We recommend specifying the CLI version in CI environments. This also allows you to install prerelease versions of the CLI. +macOS (Intel) ```sh -powershell -Command "$env:RIVET_CLI_VERSION='v1.0.0'; iwr https://raw.githubusercontent.com/rivet-gg/cli/$env:RIVET_CLI_VERSION/install/windows.ps1 -useb | iex" +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/ ```
-Windows (PowerShell) - -**Install latest version** - -``` -iwr https://raw.githubusercontent.com/rivet-gg/cli/main/install/windows.ps1 -useb | iex -``` - -**Install specific version** +Linux (x86) -We recommend specifying the CLI version in CI environments. This also allows you to install prerelease versions of the CLI. - -```ps1 -$env:RIVET_CLI_VERSION='v1.0.0' -iwr https://raw.githubusercontent.com/rivet-gg/cli/$env:RIVET_CLI_VERSION/install/windows.ps1 -useb | iex +```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) +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 @@ -70,10 +58,13 @@ cargo install --git=https://github.com/rivet-gg/toolchain rivet-cli
-Build from source (cargo build) +Build from source (`cargo build`) + +1. [Install Rust](https://rustup.sh) +2. Install Rivet ```sh -git clone https://github.com/rivet-gg/toolchain +git clone https://github.com/rivet-gg/toolchain.git cd packages/cli cargo build ``` @@ -109,3 +100,47 @@ Options: -h, --help Print help -V, --version Print version ``` + +## Quick Start + +After installation, you can quickly get started with Rivet by following these steps: + +1. Initialize a new Rivet project: + ```sh + rivet init + ``` + +2. Start the development server: + ```sh + rivet dev + ``` + +3. Deploy your game: + ```sh + rivet login + rivet deploy + ``` +## Troubleshooting + +If you encounter any issues while using Rivet, try the following: + +1. Ensure you're using the latest version of Rivet +2. Use the `rivet clean` command to remove any artifacts that might be causing problems +3. Join our [Discord](https://rivet.gg/discord) for support + +Please [open an issue](https://github.com/rivet-gg/toolchain/issues) for any issues you run in to. + +## Contributing + +We welcome contributions to the Rivet Toolchain! If you'd like to contribute, please: + +1. Fork the repository +2. Create a new branch for your feature +3. Make your changes +4. Submit a pull request + +For more detailed information, see our [contribution guidelines](CONTRIBUTING.md). + +## License + +Rivet Toolchain is released under the [Apache 2.0 License](LICENSE). diff --git a/scripts/deno.lock b/scripts/deno.lock index f276343e..0e75d364 100644 --- a/scripts/deno.lock +++ b/scripts/deno.lock @@ -241,7 +241,21 @@ } } }, - "remote": {}, + "remote": { + "https://deno.land/std@0.115.1/async/pool.ts": "353ce4f91865da203a097aa6f33de8966340c91b6f4a055611c8c5d534afd12f", + "https://deno.land/x/aws_sign_v4@1.0.2/mod.ts": "be798766c3058ebe0ba9a45c3d18a0e87855b3663bacd3e86278173a49b6618f", + "https://deno.land/x/aws_sign_v4@1.0.2/src/date.ts": "96d156206dceadbede0e8cd709dd2b0f8c8aef858359dbe187b78c50bdc73353", + "https://deno.land/x/aws_sign_v4@1.0.2/src/signing.ts": "0118be5f11100e32075e680fb7ceb78e3cf6caf923739178dad8508ad4ea5db3", + "https://deno.land/x/aws_sign_v4@1.0.2/src/util.ts": "c3b58b95bce15d02607f7434e488cfaef235dc7773b7e9d90d9d6e962d189c23", + "https://deno.land/x/html_entities@v1.0/lib/xml-entities.js": "cbbc40f7b6fd1f925508ff7d43a52d2383a57a64d0aaa3a7a1eca9d4155e4bde", + "https://deno.land/x/s3@0.5.0/deps.ts": "712e6417008266bbab80f4d95a633474e353787b198f00e303b5d0e57bab334e", + "https://deno.land/x/s3@0.5.0/mod.ts": "4e0ec5073559a035429afaeb4b1f8ee8470b6f4f831df25ea0bde181b22aabec", + "https://deno.land/x/s3@0.5.0/src/bucket.ts": "e3a76cd2ac219f53f46e1196663f5c9507d9bcb17e2354e19c2c19de3aeac418", + "https://deno.land/x/s3@0.5.0/src/client.ts": "1ea62d85d17ad2d3bb643af008712299c8ccc4ba030a26b0d6c3cc804e1cb48b", + "https://deno.land/x/s3@0.5.0/src/error.ts": "a7857ca64eedbaf5c4daad5e83fdef5c4acd61534bffdab784b4e17e008e6aae", + "https://deno.land/x/s3@0.5.0/src/request.ts": "c469c447d65e0508a94c8fa6d68ab4c54b23efbdacef58dd8651975721ecf8a6", + "https://raw.githubusercontent.com/nekobato/deno-xml-parser/0bc4c2bd2f5fad36d274279978ca57eec57c680c/index.ts": "05d093028c005706e37b46bfe2bb7e2488f42fdc74d2196ac818902336927c01" + }, "workspace": { "dependencies": [ "jsr:@std/fs@^1.0.4",