Install Ritual
Ritual is one program, ritual, with no other dependencies. The install script downloads the newest release for your platform.
Install Script
Section titled “Install Script”curl -fsSL https://raw.githubusercontent.com/sloshy/ritual/main/scripts/install.sh | bashirm https://raw.githubusercontent.com/sloshy/ritual/main/scripts/install.ps1 | iexThe installer copies the ritual binary into ~/.local/bin on macOS and Linux (%LOCALAPPDATA%\Programs\ritual\bin on Windows) and adds that directory to your PATH if needed. Open a new shell and run ritual --help to check it worked.
Updating
Section titled “Updating”Once installed, Ritual updates itself: run ritual self-update to install the newest release on your channel, or ritual self-update --check to see whether one exists. A prerelease build keeps following prereleases until you run ritual self-update --stable. Re-running the installer works too. Release builds also print a one-line notice on stderr when a newer release is out.
Prerelease Builds
Section titled “Prerelease Builds”To try the newest build, prereleases included:
curl -fsSL https://raw.githubusercontent.com/sloshy/ritual/main/scripts/install.sh | bash -s -- --prerelease& ([scriptblock]::Create((irm https://raw.githubusercontent.com/sloshy/ritual/main/scripts/install.ps1))) -PrereleaseBoth installers accept these options:
| Option | Environment variable | Description |
|---|---|---|
--prerelease/-Prerelease |
RITUAL_PRERELEASE=1 |
Install the newest release, including prereleases. |
--version <tag>/-Version <tag> |
RITUAL_VERSION=<tag> |
Install a specific release tag. Use prerelease for the newest prerelease. |
| — | RITUAL_INSTALL_DIR=<dir> |
Where to install the binary. |
Other Methods
Section titled “Other Methods”You can also download a binary for your platform from the releases page and run it directly:
./ritual --helpThe binaries are not code-signed. A binary downloaded through a browser is therefore blocked on first run: on macOS, Gatekeeper says it cannot be opened (clear the quarantine flag with xattr -d com.apple.quarantine ./ritual); on Windows, SmartScreen warns about an unrecognized app (choose More info, then Run anyway). The install scripts download with curl and Invoke-WebRequest, which do not mark the file, so neither prompt appears.
Each binary is published with a .sha256 checksum and a build provenance attestation. To confirm a download came from Ritual’s release workflow, run gh attestation verify ./ritual --repo sloshy/ritual with the GitHub CLI.
Building from Source
Section titled “Building from Source”Ritual runs on Bun. Install the dependencies, then build the binary:
bun installbun run buildMake your first deck, or take the quick tour of what Ritual can do.
Ritual is unofficial Fan Content permitted under the Fan Content Policy. Not approved or endorsed by Wizards of the Coast. Portions of the materials used are property of Wizards of the Coast. ©Wizards of the Coast LLC.
Card data, images and symbols come from Scryfall, which is not affiliated with this project. Ritual is free software under the AGPL-3.0. License and attribution.