Skip to content

README.md

Latest commit

 

History

History
94 lines (63 loc) · 1.56 KB

README.md

File metadata and controls

94 lines (63 loc) · 1.56 KB

Ossum Inc Homebrew Tap

This is the official Homebrew tap for Ossum Inc software.

Installation

brew tap ossuminc/tap

Available Formulae

riddlc

The RIDDL compiler - a tool for the Reactive Interface to Domain Definition Language.

brew install ossuminc/tap/riddlc

Or after tapping:

brew install riddlc

Usage

# Check version, license, build date, etc. 
riddlc info

# Get help
riddlc help

# Parse a RIDDL file
riddlc parse myfile.riddl

# Validate a RIDDL file
riddlc validate myfile.riddl

Requirements

  • macOS Apple Silicon or Linux x86_64: Native binary, no JDK required
  • Other platforms: Java 21 (automatically installed via openjdk@21 dependency)

riddl-gen-cli

Document generators for RIDDL models. Generates AsciiDoc, Hugo, OpenAPI, and Smithy specifications from RIDDL models.

brew install ossuminc/tap/riddl-gen-cli

Or after tapping:

brew install riddl-gen-cli

Usage

# Get help
riddl-gen-cli --help

# Generate documentation from a RIDDL model
riddl-gen-cli generate --help

# Check job status
riddl-gen-cli status --job-id <id>

Requirements

  • macOS Apple Silicon or Linux x86_64: Native binary, no JDK required
  • Other platforms: Java 25 (automatically installed via openjdk@25 dependency)

More Information

License

Apache-2.0