Home

Welcome to the TOMLy wiki!

TOMLy Wiki

Welcome to the official documentation for TOMLy - a high-performance, fully compliant TOML v1.0.0 parser for Java.

About TOMLy

TOMLy is a modern Java library for parsing and writing TOML configuration files. It offers unique features like comment preservation, flexible configuration options, and a type-safe API while maintaining excellent performance.

Current Version: 1.0.0 Last Updated: October 2025 Java Requirement: 17+

Key Features

• Full TOML v1.0.0 compliance
• High performance (fastest among Java TOML libraries)
• Comment and blank line preservation
• Type-safe getters with default values
• Round-trip serialization
• Detailed error reporting with line/column information
• Flexible configuration for parsing and writing

Documentation

Getting Started

• Installation - How to add TOMLy to your project
• Getting Started - Your first steps with TOMLy
• Configuration Options - PreserveOptions and WriterOptions

Core Functionality

• Type-Safe API - Working with different data types
• Working With Comments - Preserving and accessing comments
• Modifying And Saving - Changing values and writing TOML

Quick Example

String toml = """
    name = "MyApp"
    version = "1.0.0"
    
    [database]
    host = "localhost"
    port = 5432
    """;

        TomlDocument doc = Tomly.parse(toml, false, PreserveOptions.defaultOptions());
        String name = doc.getStr("name");              // "MyApp"
        int port = doc.getInt("database.port", 8080);  // 5432

Links

• Report Issues
• TOML Specification

Contributing

Found an error in documentation? Want to improve examples? Contributions are welcome! Please open an issue or pull request on GitHub.