pegleg/docs/source/getting_started.rst

Getting Started

What is Pegleg?

Pegleg is document aggregator that provides early linting and validations for documents that can be consumed by UCP.

For more information on the documents that Pegleg works on see Document Fundamentals.

Basic Usage

Before using Pegleg, you must install the required packages in pegleg/src/bin/pegleg

pip3 install -r pegleg/src/bin/pegleg/requirements.txt -r pegleg/src/bin/pegleg/test-requirements.txt

You will then be able to use all of Pegleg's features through the CLI. See CLI for more information.