RepoDNA documentation

RepoDNA is an open-source, local-first repository intelligence and code archaeology tool. It turns a repository into an evidence-backed analysis of its structure, architecture, history, dependencies, and health, which you can explore in the terminal, in a web interface, or in a desktop app, and share as reports and Project DNA cards.

This documentation is published at sanskarin.github.io/RepoDNA/docs, with search, and is in the docs folder of the repository.

Start here#

Getting started: analyze your first repository in five minutes
Installation: binaries, the desktop app, npm, WebAssembly, and building from source
The web version: analyze a folder in your browser, with nothing to install
FAQ

Using RepoDNA#

How the analysis works#

The analysis engine: stages, profiles, statuses, and performance
The RepositoryDNA model: the artifact, findings, rules, and the fingerprint
Git history and code archaeology
Architecture analysis
Dependency analysis
Complexity and code quality
Tests, build, and documentation
Security signals and safe analysis
The Codebase Time Machine

Developing RepoDNA#

Architecture
Development: setup, checks, and where to make changes
Contributing
Benchmarks and fixture repositories

The project#

Examples: RepoDNA's analysis of itself, a CI workflow, and configurations
Media kit: screenshots, promo images, and Project DNA cards for posts and talks, on the images branch
Screenshots of the web interface in every release, side by side, on the images branch
Roadmap, changelog, and the releases on the releases-info branch, one folder per version with its notes, downloads, install commands, and pull requests
Security policy, support, and the code of conduct
Privacy Policy, Terms of Use, and the third-party notices
Governance and maintainers

RepoDNA is made by Sanskar and licensed under the Apache License 2.0. More open-source projects by Sanskar are at sanskarin.github.io.