Getting Started

Prerequisites

Compilation

dub build -c executable

CLI usage

prohelp
prohelp ?
prohelp ?:i

Preview mode (schema interpreter)

prohelp examples/tar.sdl ?
prohelp examples/tar.sdl ? operations
prohelp -f myapp/help.sdl ?:de,i
prohelp examples/help.md ?
prohelp examples/help.adoc ?

See Authoring schemas for Markdown/AsciiDoc/CentrMark whole-document schemas and content-ref formats.

Create, fill, and check

prohelp init --name myapp
prohelp fill
prohelp check
prohelp check --strict

init writes a shaped help.sdl before any questions. fill is the questionnaire (init --fill runs both). check reports empty fields; --strict fails the process so CI can block a ship.

Other GitHub repos can invoke the reusable workflow (they still have to add the job — Prohelp cannot reach into someone else’s pipeline):

jobs:
  prohelp:
    uses: openshellorg/prohelp/.github/workflows/check-schema.yml@main
    with:
      schema-path: help.sdl
      strict: true