Quick start / Four steps

Weave your first verified corpus.

BRAID turns your rules and raw data into a checked release. The compiler runs with Node.js 22 or newer and pnpm.

1. Install

$ git clone https://github.com/cenetex/braid.git
$ cd braid
$ pnpm install
$ pnpm build

2. Set the rules

Use one readable file to name the sources, rights, quality checks, target size, and output.

apiVersion: braid/v1
kind: DatasetBuild

metadata:
  name: my-corpus
  version: v1

spec:
  sources:
    - id: licensed-notes
      kind: directory
      path: documents
      license: CC-BY-4.0

  quality:
    minimumCharacters: 200

  evaluation:
    minimumDocuments: 8000

3. Check and build

BRAID checks the rules first. Then it builds the release.

$ node dist/cli.js validate examples/basic/braid.yaml
$ node dist/cli.js build examples/basic/braid.yaml

4. Prove nothing changed

Check the release after it moves. Use the expected release ID from someone you trust.

$ node dist/cli.js verify <release-directory> --expected <release-id>