Liking cljdoc? Tell your friends :D

Atlas Documentation

Status: Proof of Concept (Alpha). APIs may change.

Atlas is a semantic registry for software architecture: describe your system's components, functions, and relationships as compound identities (sets of semantic aspects), then query, validate, and visualize your architecture as a single queryable graph.

Start here

DocWhat
Getting Started5-minute tutorial
Core ConceptsCompound identities, tiers, data flow
API ReferenceFunction reference
ExamplesAnnotated example registries

Guides

DocWhat
Authoring GuideBuilding entity definitions interactively
SourcesRegistry in EDN files, plain defns with ^{:atlas.source/id …}, bb source, Emacs hover (experimental)
Compound-ID RefactoringReviewing/improving compound-ids to avoid drift
Dependency TraversalForward/reverse recursive dependency analysis
Semantic AggregationRolling aspects up the dependency graph
Declared DispatchThe Atlas execution pattern
Source TrackerCorrelating registry entities with git history
Upgrade CheckWhat a new atlas version changes for your project: registry and tool answers, before and after (experimental)

Semantic-Driven Development

DocWhat
Semantic-Driven DevelopmentThe SDD vision
LLM-IDE GuideFor LLMs: the registry model and atlas.llm-ide tools
Lens DesignThe lens abstraction

Tooling

DocWhat
Emacs IntegrationIDE support via CIDER
KeybindingsEmacs keybindings reference
Visual ExplorerBrowser-based graph UI (v1/v2)
UI v3SSE-driven semantic browser (experimental)
atlas-dev moduleDev-tooling library
Overarch AdapterExport to C4/UML/GraphViz diagrams (experimental)
YAML-LD / JSON-LD AdapterExport to W3C linked data / RDF (experimental)

Modules

Atlas is a monorepo of independently-publishable libraries:

  • core/ — atlas — the production library (registry, query, invariants, datalog)
  • dev-tools/ — atlas-dev — source tracking and dev tooling
  • ui/ — atlas-ui — the browser-based visual explorer
  • emacs/ — CIDER-driven IDE integration

The cloud service (team sync, versioning, branches) and its docs live in a separate repo.


Internal design notes and working documents live in internal/ (not part of the published documentation set).

Can you improve this documentation?Edit on GitHub

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
←Move to previous article
→Move to next article
Ctrl+/Jump to the search field
× close