open-cql Documentation

Design Documents

• Project Design — Architecture overview, crate structure, component design, implementation phases
• IR Pipeline — Detailed specification of each intermediate representation (AST, HIR, MIR, LIR, Query Plan)
• Datalog+Flow Engine — Evaluation engine design, flow tracking, provenance, algorithms
• Extractors — C/C++ and Java extractor design, database schema, tree-sitter integration
• QL Grammar — Working grammar specification for the QL language parser

Crawled Reference Documentation

CodeQL Overview

• About CodeQL
• Glossary

QL Language Reference

• QL Language Reference — Consolidated reference

Language-Specific

• C/C++ Library and Analysis
• Java/Kotlin Library and Analysis

Crawl Scripts

• scripts/crawl_codeql_docs.py — Crawls all CodeQL documentation pages
  • Run: python3 scripts/crawl_codeql_docs.py
  • Output: docs/crawled/ directory with organized markdown files
  • Creates docs/crawled/manifest.json listing all downloaded pages