Skip to content

Usage

There are three CLI commands available, called with unbox <COMMAND>:

corpus

Usage:

corpus [OPTIONS] [FILENAMES]...

Options:

  -o, --output PATH               Output directory  [default: .]
  -c, --conf PATH                 Path to a yaml configuration file
  -d, --cldf                      Create a CLDF dataset
  -f, --format [toolbox|shoebox]  The format of the database you are
                                  processing  [default: toolbox]
  -a, --audio PATH                A directory containing your audio files.
  -L, --languages PATH            A CSV file containing language data.
  -s, --segments PATH             A CSV file mapping IPA to Graphemes.
  -I, --include PATH              A yaml file with a list of allowed entries.
  -i, --inflection PATH...        1. A CSV table of inflection categories. 2.
                                  A CSV table of inflection values. 3. A .yaml
                                  file with a dict mapping morph IDs to
                                  inflectional values
  -p, --parsing PATH              A parsing database.
  -l, --lexicon PATH              Connect corpus to a lexicon
  --help                          Show this message and exit.

dictionary

Usage:

dictionary [OPTIONS] FILENAME

Options:

  -o, --output PATH               Output directory  [default: .]
  -c, --conf PATH                 Path to a yaml configuration file
  -d, --cldf                      Create a CLDF dataset
  -f, --format [toolbox|shoebox]  The format of the database you are
                                  processing  [default: toolbox]
  -a, --audio PATH                A directory containing your audio files.
  -L, --languages PATH            A CSV file containing language data.
  -s, --segments PATH             A CSV file mapping IPA to Graphemes.
  -I, --include PATH              A yaml file with a list of allowed entries.
  -e, --examples PATH             An examples (corpus) database file
  --help                          Show this message and exit.

wordlist

Usage:

wordlist [OPTIONS] FILENAME

Options:

  -o, --output PATH               Output directory  [default: .]
  -c, --conf PATH                 Path to a yaml configuration file
  -d, --cldf                      Create a CLDF dataset
  -f, --format [toolbox|shoebox]  The format of the database you are
                                  processing  [default: toolbox]
  -a, --audio PATH                A directory containing your audio files.
  -L, --languages PATH            A CSV file containing language data.
  -s, --segments PATH             A CSV file mapping IPA to Graphemes.
  -I, --include PATH              A yaml file with a list of allowed entries.
  --help                          Show this message and exit.