Command Line Interface Reference

vorlagellm

vorlagellm [OPTIONS] COMMAND [ARGS]...

Options

--install-completion: Install completion for the current shell.

--show-completion: Show completion for the current shell, to copy it or customize the installation.

agreements

vorlagellm agreements [OPTIONS] APPARATUS SIGLUM1 SIGLUM2

Options

--horizontal, --no-horizontal

Default:: False

Arguments

APPARATUS: Required argument <click.types.Path object at 0x7f96404f6cd0>

SIGLUM1: Required argument STRING

SIGLUM2: Required argument STRING

apparatus-db

Creates a database for the apparatus.

vorlagellm apparatus-db [OPTIONS] APPARATUS DB

Arguments

APPARATUS: Required argument <click.types.Path object at 0x7f9651c322d0>

DB: Required argument <click.types.Path object at 0x7f9651c33b10>

doc-db

Creates a database for the document.

vorlagellm doc-db [OPTIONS] DOC DB

Arguments

DOC: Required argument <click.types.Path object at 0x7f9640499cd0>

DB: Required argument <click.types.Path object at 0x7f9640498a10>

ensemble

vorlagellm ensemble [OPTIONS] SIGLUM OUTPUT APPARATUSES...

Arguments

SIGLUM: Required argument STRING

OUTPUT: Required argument <click.types.Path object at 0x7f96401b88d0>

APPARATUSES: Required argument(s) <click.types.Path object at 0x7f96401b8c50>

evaluate

vorlagellm evaluate [OPTIONS] APPARATUS GOLD_SIGLUM PREDICTION_SIGLUM

Options

--false-positives <false_positives>

--false-negatives <false_negatives>

Arguments

APPARATUS: Required argument <click.types.Path object at 0x7f96404f68d0>

GOLD_SIGLUM: Required argument STRING

PREDICTION_SIGLUM: Required argument STRING

run

Runs the main VorlageLLM pipeline on a document to predict which source readings from an apparatus could have produced its text.

vorlagellm run [OPTIONS] DOC APPARATUS OUTPUT

Options

--api-key <api_key>

Default:

--model <model>

Default:: gpt-4.1

--apparatus-db <apparatus_db>

--doc-db <doc_db>

--siglum <siglum>

Default:

--notes <notes>

--include <include>

--ignore <ignore>

--initiate-response, --no-initiate-response

Default:: False

Arguments

DOC: Required argument <click.types.Path object at 0x7f96492422d0>

APPARATUS: Required argument <click.types.Path object at 0x7f964c752210>

OUTPUT: Required argument <click.types.Path object at 0x7f96492a5750>

similar

vorlagellm similar [OPTIONS] DB VERSE

Options

--window <window>

Default:: 3

Arguments

DB: Required argument <click.types.Path object at 0x7f9640488b90>

VERSE: Required argument STRING