Skip to content

Installation

ryl ships as a single binary. Pick the install method that matches your toolchain.

cargo install ryl
pip install ryl
npm install --global @owenlamont/ryl
pixi global install ryl
# or: conda install -c conda-forge ryl
winget install owenlamont.ryl
brew install ryl
scoop bucket add orb https://github.com/o-l-a-v/scoop-bucket
scoop install ryl

The bucket is community-maintained by o-l-a-v.

Download a release artifact from the GitHub releases page and place the binary on your PATH.

Verify the install:

ryl --version

GitHub Actions

ryl-action installs the release binary on the runner, verifies its checksum and runs ryl check .:

- uses: actions/checkout@v7
- name: Check YAML lint
  uses: owenlamont/ryl-action@v0.30.0
  with:
    args: check .
- name: Check YAML formatting
  uses: owenlamont/ryl-action@v0.30.0
  with:
    args: format --check .

Each action tag installs the matching ryl release. ryl enables no rules without a config, so commit a .ryl.toml first. The action reads the same config as local commands. Formatter-only imports enable no lint rules: enable selected rules before adding the lint step, or run only the formatting step. The other inputs are version, config (passed as -c), config-data (inline config, passed whole as -d) and install-only, which puts ryl on PATH for later steps. args splits on whitespace without quote handling, so pass inline config through config-data. See the ryl-action README for more examples.

Set up tab-completion with Shell completions, or continue to the Quick start to run your first lint.