Skip to content

Five-Minute Start

Run these commands from the repository root.

1. Check repository health

qlens doctor

A healthy repository reports PASS for MkDocs configuration, NUR overrides, NUR assets, schemas, canonical repository records, graph and reasoning integrity, registry freshness, and lifecycle configuration.

2. Validate canonical records

qlens repo validate

This checks the entire repository. To validate one Markdown object:

qlens validate repository/objects/questions/QST-000001.md

3. Inspect existing objects

qlens list
qlens list --type evidence
qlens list --space RSP-000001
qlens show QST-000001
qlens show QST-000001 --json

4. Create an object

qlens new question "What remains unresolved?" --space RSP-000001

QLens allocates the next OID and creates a canonical Markdown record.

5. Search and query

qlens search "correctable"
qlens query "space=RSP-000001 and status=active"
qlens query "type=evidence" --json

6. Synchronize derived outputs

qlens build

qlens build performs repository validation, builds indexes, rebuilds the deterministic registry, and renders NUR workspace views.

7. Preview NUR

mkdocs serve

Open the local address printed by MkDocs, normally http://127.0.0.1:8000/.

8. Build the static site

mkdocs build --strict