Hyaline Hyaline

Getting Started with Hyaline

Welcome to Hyaline (pronounced “HIGH-uh-leen”), a documentation tool that helps software development teams keep their documentation current, accurate, and accessible. This guide will walk you through setting up Hyaline.

Prerequisites

  • One or more documentation sources (e.g. git repo, filesystem directory, website)
  • A GitHub account OR a supported operating system (64-bit Linux, macOS, or Windows)
  • A supported LLM Provider. Note: several LLM providers, including GitHub Models, offer a generous free tier.

Free to Try

You can use Hyaline without a license for evaluation and demonstration purposes. Simply follow the setup instructions below. When you are done with your evaluation, you will need to obtain a license.

Quick Start (Single Repository)

If you want to quickly try Hyaline on just one of your repositories, see How To Try Out Hyaline. This guide walks you through setting up Hyaline on a single repository using the free tier of the GitHub Models LLM.

Note: While this is the fastest way to try out Hyaline, it only checks documentation in a single repository and doesn’t create a centralized set of documentation. To experience Hyaline’s full capabilities, we recommend installing the GitHub App (see below).

The Hyaline GitHub App is the recommended way to use Hyaline. It uses a configuration repository in your organization or personal account to extract, check, and audit documentation. To install the Hyaline GitHub App please see How To: Install the GitHub App.

Once installed you can visit other How To guides to learn how to extract documentation, check pull requests, or run an MCP server. Alternatively you can learn more about how hyaline works or visit the configuration reference to learn how to configure Hyaline.

Note that the Hyaline GitHub App will trigger workflows in the configuration repository located in your organization or personal account, meaning that you stay in control of your configuration and data. If you wish you can also run your own copy of the Hyaline GitHub App (located in the configuration repository) to prevent any data whatsoever from leaving your organization and being sent to us.

Use Hyaline from Scratch (Advanced)

You can also use Hyaline from scratch to support any number of custom workflows or use cases. For an introduction on how to use Hyaline from scratch please visit How To: Use Hyaline from Scratch.