Welcome to ConfigMate Documentation

Welcome to the ConfigMate Documentation! This guide is designed to provide comprehensive information on using ConfigMate, a tool engineered for scrutinizing configuration files against user-defined specifications. Below is an overview of each section of the documentation, guiding you through the process of writing specifications, understanding checks, and more.

User Documentation Overview

Specifications and Checks

This is the starting point for users of ConfigMate. It introduces the ConfigMate Specification Language (CMSL), used for writing specifications that define the structure and rules for configuration files. This section explains how to craft specifications, including field definitions, metadata, checks, and the format of specification files. It's crucial for understanding how to specify and validate the fields in your configuration files.

Checks

Dive into the details of writing checks in ConfigMate. This section covers the ConfigMate Check Language (CMCL), focusing on its syntax, usage, and the various components like type-specific functions, logical operators, and control structures. It's essential for learning how to write effective checks for different field types, ensuring that your configurations adhere to the desired constraints and conditions.

Types and Functions

Explore the supported field types in ConfigMate and the functions available for each type. This section is a comprehensive guide to understanding the different types you can use in your specifications and checks, along with their associated validation functions.

Getting Started

Begin your journey with ConfigMate by first understanding the Specifications and Checks section. It lays the foundation for how to structure and define your configuration files. Once familiar with specifications, explore the Checks section to learn how to enforce rules and constraints. Lastly, the Types and Functions section will provide deeper insights into the types and operations you can perform in ConfigMate.

We hope this documentation serves as a valuable resource for effectively using ConfigMate. Should you have any questions or need further assistance, please feel free to reach out.

Contributing

We welcome contributions to ConfigMate! Please see our Contributing Guide for information on the developer workflow.

Parsers

For information on the parsers area and how to contribute, see Parsers Generation.