mdsmith metrics

Get, list, and rank shared Markdown metrics (file length, token estimate, readability, …).

Metrics are the shared measurements rules compute: file length, section length, token estimate, readability scores. This CLI surfaces them as a standalone tool for triage.

mdsmith metrics <command> [flags] [files...]

# Subcommands

# metrics get

Emit every registered metric for a single Markdown file as a data object. The shape is a flat map with path plus one key per metric. To narrow to one field, pipe through jq or yq.

mdsmith metrics get [flags] <file>

mdsmith metrics get docs/guides/install.md
mdsmith metrics get -f json README.md
mdsmith metrics get -f yaml README.md | yq .readability
mdsmith metrics get -f json README.md | jq .avg-words-per-sentence

# metrics list

mdsmith metrics list [flags]

# metrics rank

mdsmith metrics rank [flags] [files...]

metrics rank counts only authored bytes. Content between <?include?> and <?catalog?> markers is excluded. Embedded content is measured against its source file, not the host that pulls it in.

With no file arguments, defaults to the current directory.

# Available metrics

Three metrics are off by default in rank: readability (MET008), sentences (MET009), and avg-words-per-sentence (MET010). They appear in get and list unconditionally.

# Examples

mdsmith metrics list
mdsmith metrics get -f json README.md
mdsmith metrics get -f yaml docs/guides/install.md
mdsmith metrics rank --by bytes --top 10 .
mdsmith metrics rank --by token-estimate --top 5 docs/
mdsmith metrics rank --metrics bytes,sentences --by sentences plan/
mdsmith metrics rank --metrics readability --by readability --top 20 docs/

# Exit codes