Skip to content

Quickstart [[quickstart: Tutorial]]Tutorial

  • goalgo from zero to a working QMDC graph in five minutes
  • audiencenewcomer
  • time5m
  • outcomea parsed, validated, and queryable workspace
  • aboutObject, Field, Heading, Reference, Data Type
🤖 Content Generator

Prompt [[quickstart_gen_prompt: text]]text

Write a quickstart that gets someone from zero to working QMDC in 5 minutes. This is a DO page, not a READ page.

Structure:

  1. Install — cargo install qmdc or uv pip install qmdc or npm install qmdc (show all three, let them pick)
  2. Create a file — literally "create hello.qmd.md with this content:" and show a 5-line example
  3. Parse it — qmdc parse -i hello.qmd.md — show the command and what it outputs
  4. Validate — qmdc parse -i hello.qmd.md > /dev/null && echo "valid"
  5. Create a workspace — add a second file, add a reference between them, run qmdc workspace validate .
  6. Query — qmdc query . "SELECT __id, __kind FROM objects" — show the output

Every step: command to run, expected output. Copy-paste friendly. No theory. No "what is QMDC". No "core concepts". Just do the thing. End with: "Next: read Why QMDC to understand the philosophy, or jump to the Guides for specific tasks."

At the very top of the content (before "Install"), embed the demo recording: ![QMDC quickstart — create a .qmd.md file, parse it, validate, and query the graph](../assets/qmdc/644f7382adf7/quickstart.gif)

QMDC quickstart — create a .qmd.md file, parse it, validate, and query the graph

1. Install

Pick your package manager:

# Rust
cargo install qmdc

# Python
uv pip install qmdc

# Node.js Coming Soon, works when installed from the repo
# npm install -g qmdc

Confirm it's working:

qmdc --version

2. Create a file

Create hello.qmd.md:

## Server [[server: Config]]

- host: localhost
- port: 8080
- debug: true

A Heading with [[id: Kind]] creates an Object. Bullet items with - key: value become Fields. Values are auto-typed — 8080 is a number, true is a boolean (Data Type).

3. Parse it

qmdc parse -i hello.qmd.md --pretty

Output:

[
  {
    "__id": "server",
    "__label": "Server",
    "__kind": "Config",
    "host": "localhost",
    "port": 8080,
    "debug": true
  }
]

4. Validate

qmdc parse -i hello.qmd.md > /dev/null && echo "valid"

Output:

valid

If there are syntax errors, you'll see them on stderr and a non-zero exit code.

5. Create a workspace

Add a second file, services.qmd.md:

## API [[api: Service]]

- port: 3000
- config: [[#server]]

The Reference [[#server]] creates a typed edge from api to server with edge type config.

Mark the directory as a workspace with readme.qmd.md:

# My Project [[my_project: __Workspace]]

Validate the workspace — this checks that all cross-file references resolve:

qmdc workspace validate .

Output (empty array = no errors):

[]

6. Query

qmdc query . "SELECT __id, __kind FROM objects"

Output:

__id        | __kind
------------|------------
my_project  | __Workspace
server      | Config
api         | Service

Query the edges (relationships between objects):

qmdc query . "SELECT source_id, target_id, edge_type FROM edges"

Output:

source_id | target_id | edge_type
----------|-----------|----------
api       | server    | config

Next: read Write Your First QMD.md File for a detailed walkthrough with explanations, or jump to the Guides for specific tasks.