HEDBridge CLI

Command line reference

The HEDBridge console application converts legacy HighEdit HED documents from scripts, scheduled tasks, and controlled migration jobs. It runs locally on Windows and uses the same signed license token as the desktop app.

Command HEDBrigde.exe /s:<source-or-folder> /d:<destination-folder> /f:pdf,docx,tx [flags]

Download the console build

Sign in to the protected download portal and download the console package for your licensed major version. Trial users receive a signed trial token and can evaluate PDF conversion.

HEDBrigde.exe --license

No valid license token installed. Register for a trial token or unlock with a paid license token.

License commands

Use `--license` to inspect the current status. Use `--unlock` once to save a trial or paid token on the machine.

--license

Shows the current tier or missing-token status.

--unlock=<license-token>

Validates and stores a signed HEDBridge license token.

Convert documents

Provide a source file or folder, a destination folder, and one or more output formats. Folder conversion preserves source folders unless `--flat` is used.

HEDBrigde.exe /s:D:\Archive\HED /d:D:\Output /f:pdf,docx,tx --recursive --continue-on-error

Supported formats: `pdf`, `doc`, `docx`, `rtf`, `tx`, `txt`, `htm`.

Extract ApplicationFields

Use field extraction when you need metadata for migration audits, validation tooling, or downstream import workflows. With `/d:` the CLI writes `application-fields.json` to the destination folder.

HEDBrigde.exe /s:D:\Archive\HED --extract-fields --recursive /d:D:\Audit

Application fields written to D:\Audit\application-fields.json

Reference

Flags and options

/s:Source

Source document or folder. Long form: `--source=`.

/d:Destination

Destination folder for converted output. Long form: `--destination=`.

/f:Formats

Comma-separated formats: `pdf`, `doc`, `docx`, `rtf`, `tx`, `txt`, `htm`. Long form: `--formats=`.

/n:Name pattern

Output name pattern before the extension. Tokens: `{name}`, `{file}`, `{ext}`. Long form: `--name-pattern=`.

--licenseShow status

Prints the currently installed trial or paid license status.

--unlock=Install token

Saves a valid trial or paid license token.

--extract-fieldsField JSON

Extracts ApplicationFields as JSON instead of converting.

/rRemove images

Removes images before saving output files. Long form: `--remove-images`.

--recursiveSubfolders

Processes supported files in nested source folders.

--continue-on-errorBatch resilience

Continues folder conversion when a document fails.

--flatFlat output

Writes all outputs directly into the destination folder.

Examples

Common CLI calls

Convert a single file to PDF

HEDBrigde.exe /s:D:\Archive\Demo1.hed /d:D:\Output /f:pdf

Convert a folder to editable formats

HEDBrigde.exe /s:D:\Archive\HED /d:D:\Output /f:docx,rtf,tx --recursive --continue-on-error

Use a custom output name

HEDBrigde.exe /s:D:\Archive\Demo1.hed /d:D:\Output /f:pdf,docx /n:{name}-converted

Write a flat output folder

HEDBrigde.exe /s:D:\Archive\HED /d:D:\Output /f:pdf --recursive --flat