Ritual

An all-in-one toolkit for Magic: The Gathering for your CLI and self-hosting needs.

Usage

For macOS/Linux, install as your user with:

curl -fsSL https://raw.githubusercontent.com/sloshy/ritual/main/scripts/install.sh | bash

For Windows (PowerShell), install as your user with:

irm https://raw.githubusercontent.com/sloshy/ritual/main/scripts/install.ps1 | iex

Ritual is pre-release, so there is no stable release yet — install the newest prerelease build instead:

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))) -Prerelease

Both scripts also accept --version/-Version for a specific release tag, and read the RITUAL_PRERELEASE=1 and RITUAL_VERSION=<tag> environment variables.

You can also download binaries from the releases page, or build from source with bun run build.

./ritual --help

📖 Full documentation at ritual.rpeters.dev

Contributing

See CONTRIBUTING.md for rules and guidelines.

Development

This project uses Bun as its runtime. Install dependencies with:

bun install

Run commands locally without building:

bun run index.ts --help

Build a compiled binary:

bun run build

Testing

Unit Tests:

bun run test

Integration Tests:

bun run test:it