Installation

Edoxen is distributed as a Ruby gem.

Prerequisites

• Ruby 3.0 or newer
• Bundler 2.0 or newer

Install via Bundler

Add to your Gemfile:

gem 'edoxen'

Then run:

bundle install

Install via RubyGems

gem install edoxen

Verify

edoxen --version
edoxen help

You should see the available commands:

Commands:
  edoxen help [COMMAND]               # Describe available commands or one specific
  edoxen normalize YAML_FILE_PATTERN  # Normalize YAML files using Edoxen schema
  edoxen validate YAML_FILE_PATTERN   # Validate YAML files against Edoxen schema

Next steps

• Walk through the Introduction.
• Read the CLI docs to learn validate and normalize.
• Browse the data model.