bst-pre-receive-hook - Man Page

bst pre-receive-hook – Validate filenames from a list of files against the BIDS schema

Synopsis

bst pre-receive-hook [Options]

Description

The expected input takes the following form:

bids-hook-v2 {"Name": "My dataset", "BIDSVersion": "1.9.0",
DatasetType : "raw"} ignore-pattern1 ... ignore-patternN 0001
.datalad/config .gitattributes CHANGES README dataset_description.json
participants.tsv sub-01/anat/sub-01_T1w.nii.gz ...

The header identifies the protocol version. For protocol bids-hook-v2, the second line MUST be the dataset_description.json file, with any newlines removed. The following lines, up to the line containing “0001”, are ignore patterns from the .bidsignore file. The lines following “0001” are the filenames to be validated.

This is intended to be used in a git pre-receive hook.

Options

-s,  --schema PATH

Path to the BIDS schema

-i,  --input PATH

Input file (default: stdin)

-o,  --output PATH

Output file (default: stdout)

-h,  --help

Show a help message and exit

See Also

bst-export(1), bst-export-metaschema(1)

bst(1)

Referenced By

bst(1), bst-export(1), bst-export-metaschema(1).

February 2026