mkq - Markdown Query Tool

A command-line tool for querying and extracting data from Markdown files. Syntax inspired by jq.

Installation

From crates.io

cargo install mkq

From source

git clone https://github.com/hon-gyu/oyster.git
cd oyster
cargo build --release --package mkq

The binary will be available at ./target/release/mkq.

Usage

mkq <file> [OPTIONS]

Show table-of-content summary:

mkq document.md --summary

TIP: use --summary to get a quick overview of the document, then iteratively refine your query.

Extract frontmatter:

mkq document.md --frontmatter

Select a section by title:

mkq document.md --field "Introduction"

Get the number of child sections:

mkq document.md --nchildren

Chain multiple operations:

mkq document.md --field "Introduction" --nchildren

Extract code blocks:

mkq document.md --code 0  # Get first code block

Output Formats

• --format json - JSON output
• --format markdown - Markdown output
• --format summary - Tree summary

Available Operations

• --field <title> - Select section by title
• --index <n> - Select child section by index
• --slice <start:end> - Select slice of child sections
• --title <n> - Get title of child section by index
• --summary - Output summary tree
• --nchildren - Count child sections
• --frontmatter - Extract frontmatter
• --body - Strip frontmatter
• --preface - Extract content before first section
• --has <title> - Check if section exists
• --delete <title> - Delete section by title
• --inc <n> - Increment heading levels
• --dec <n> - Decrement heading levels
• --code <n> - Extract Nth code block
• --codemeta <n> - Extract Nth code block metadata