Comprehensive technical specifications and API documentation for Expressir. Use this section when you need complete, detailed information about specific features.

About These References

The References section provides:

  • Complete command-line interface (CLI) specification

  • Full Ruby API documentation

  • Detailed data model class references

  • Liquid drops attribute listings

  • File format specifications

  • Configuration options

Reference Documents

CLI Commands Reference

Complete reference for all command-line tools.

Includes:

  • Full command syntax

  • All options and parameters

  • Usage examples

  • Exit codes and error messages

  • Environment variables

Ruby API Reference

Comprehensive API documentation for programmatic usage.

Covers:

  • Parser classes and methods

  • Repository API

  • Model classes overview

  • Utility functions

  • Error handling

Data Model Reference

Detailed documentation of Expressir’s Ruby data model classes.

Sections:

Liquid Drops Reference

Complete attribute listings for Liquid template integration.

Sections:

LER Format Specification

Detailed specification of the LutaML EXPRESS Repository format.

Covers:

  • Package structure

  • Metadata format

  • Index formats

  • Serialization options

  • Version compatibility

EXPRESS Changes Format

Specification for EXPRESS Changes YAML format.

Includes:

  • File structure

  • Schema change format

  • Version change format

  • Item change types

  • Validation rules

Schema Manifest Format

Format specification for schema manifest files.

Describes:

  • YAML structure

  • Entry attributes

  • Optional fields

  • Usage patterns

Benchmarking Reference

Complete benchmarking configuration reference.

Details:

  • Environment variables

  • Configuration options

  • Output formats

  • Performance metrics

Configuration Reference

All configuration options for Expressir.

Includes:

  • Global configuration

  • Environment variables

  • Programmatic configuration

  • Default values

Using These References

Quick Lookup

Use these references when you need to:

  • Find the exact syntax for a CLI command

  • Look up a specific API method signature

  • Check which attributes are available in a Liquid drop

  • Understand a file format specification

  • Configure environment variables

  • Use the built-in search to find specific terms

  • Click on section headings to get direct links

  • Use the table of contents on each page

  • Reference pages link to related documentation

API Documentation Conventions

Method signatures use this format:

method_name(required_param, optional: 'default') → return_type

Parameters are documented with:

  • Name and type

  • Whether required or optional

  • Default value (if optional)

  • Description of purpose

Return values specify:

  • Type returned

  • Possible values

  • Nil conditions

Example Usage

Suppose you want to use the from_file parser method:

  1. Navigate to Ruby API Reference

  2. Find the Parser section

  3. Look up from_file method

  4. Read the method signature and parameters

  5. Check the examples

  6. Try it in your code

For learning:

For tasks:

  • Use Guides for step-by-step instructions

  • Return here for detailed specifications

Contributing

Help improve these references:

  • Report missing or incorrect information

  • Suggest additional examples

  • Clarify confusing descriptions

  • Add missing API methods

See the Contributing Guide for details.

Versioning

These references document Expressir version latest.

For version-specific documentation:

  • Check the gem version: gem list expressir

  • Visit RubyGems for older versions

  • See the CHANGELOG for version differences