HQL Documentation
HQL is a Lisp-shaped language that compiles to JavaScript and TypeScript. Start with the guide, then use the reference and workflow pages as you build real projects.
echo '(print "Hello, HQL")' > hello.hql
hql hello.hql
Language
| Read this when | Doc |
|---|---|
| Learning the language | GUIDE.md |
| Looking up syntax and semantics | hql/LANGUAGE.md |
| Checking authoritative language facts | hql/SPEC.md |
| Wanting a compact cheat sheet | REFERENCE.md |
| Writing types and annotations | TYPE-SYSTEM.md |
| Writing checked pure/effectful code | hql/PURE-MODE.md |
| Choosing between canonical spellings | style-guide.md |
| Reading how forms compose | hql/expression-foundation.md |
Per-feature specs and runnable examples live in docs/features/.
API Reference (generated)
| Read this when | Doc |
|---|---|
| Looking up stdlib functions | api/stdlib.md |
| Looking up built-in operators | api/builtins.md |
| Calling HQL programmatically | api/runtime.md |
| Understanding module loading | api/module-system.md |
Workflows
| Read this when | Doc |
|---|---|
| Running files or mixed HQL/JS/TS code | CLI.md |
| Managing dependencies or publishing | PACKAGES.md |
| Calling JavaScript and TypeScript | JS-INTEROP.md |
| Building web or mobile applications | WEB-MOBILE.md |
| Loading HQL in a browser (loaders/SRI/CSP) | BROWSER.md |
| Writing React components | REACT.md |
Internals And Status
| Read this when | Doc |
|---|---|
| Looking up an error code | ERROR-SYSTEM.md |
| Learning how the stdlib boots | SELF-HOSTED-STDLIB.md |
| Checking what evidence exists | PRODUCTION-READINESS.md |
| Filing a language-level defect | HQL-LANGUAGE-BACKLOG.md |
| Contributing or building source | ../CONTRIBUTING.md |
| Running repository tests | TESTING.md |
| Cutting a release | RELEASE.md |
| Editing or publishing docs | DOCS-PUBLISHING.md |
Dated performance campaign write-ups are kept under docs/performance/.
Source Authority
- Syntax and semantics:
docs/hql/LANGUAGE.mdplus the feature specs. - Stdlib reference: generated from
src/hql/lib/stdlib/stdlib.hql,packages/*/mod.hql, and verified examples. - CLI behavior:
src/hql/cli.ts, checked against public docs. - Dependencies, manifests, and publishing:
docs/PACKAGES.md. - Web and mobile project behavior:
docs/WEB-MOBILE.md.
Feedback
Found an issue with the docs? Open an issue in
hlvm-dev/hql.