Skip to main content

​
Synopsis

dms report --dir DIRECTORY [--format html|md] [--output FILE] [--title TITLE]

​
Description

dms report reads every .json file in a directory and compiles a browsable catalogue. The default output is a self-contained dark-themed HTML page (report.html) that requires no external dependencies. A Markdown variant (report.md) is available for embedding in wikis, READMEs, or static site generators. HTML report features:
  • Summary statistics (total records, type count, contributor count, language count)
  • Per-type badge strip
  • Card grid grouped by heritage type with title, description, creator, date, location, language, license, and subject tags
  • Responsive layout — collapses to a single column on narrow viewports
Markdown report features:
  • Records grouped by type as ## sections
  • Each record as a ### heading with a bullet-list of metadata fields
  • Quoted description paragraph

​
Options

​
--dir
path
required
Directory containing DMS .json records. Must exist and be a directory.
​
--format
string
default:"html"
Output format. Accepted values: html, md. Case-insensitive.
​
--output
path
default:"derived from input"
Output file path.
  • HTML: defaults to DIRECTORY/report.html
  • Markdown: defaults to DIRECTORY/report.md
​
--title
string
default:"Dzaleka Heritage Collection"
Title used in the report header and HTML <title> tag.

​
Examples

dms report --dir records/
# writes records/report.html

​
Notes

The HTML report is entirely self-contained — all styles are inlined. You can open it directly in a browser, email it, or host it as a static file without any build step.
Records that contain a top-level JSON array are supported. Each element of the array is treated as a separate record in the catalogue.
Files with JSON parse errors are silently skipped. Run dms validate --dir DIRECTORY first to identify and fix any malformed records before generating a report.