Developer docs
Contributor, developer, and maintainer docs. These aim to describe and communicate the structure, processes and workflows of the hledger project - “the machine that makes the machine”.
These mostly are kept in doc/ in the main hledger repo, and then symlinked into the hledger_site repo for rendering on hledger.org.
Start here
- CONTRIBUTING - ways to help, by role
- DEVFAQ - developer FAQ
- DEVWORKFLOWS - tools, building, testing, GHCI, working on docs
- RULES - the repo’s policies, on one page
- AI - AI usage policy
- README - the project README
Code and tests
- CODE - architecture and package overview
- FILES - repo and working copy layout
- TESTS - test suites and how to run them
- ERRORS - error message standards and examples
- BENCHMARKS - performance measurement
Specs
- SPEC-journal - journal syntax
- SPEC-finalising - the journal finalisation pipeline
- SPEC-special-postings - inferred postings and their rules
- SPEC-lots - lot tracking
- SPEC-holdings - the holdings command
- SPEC-print - print behaviour
Process
- COMMITS - commit message conventions
- PULLREQUESTS - pull request guidelines
- ISSUES - issue tracker conventions and views
- REGRESSIONS - regression tracking
- RELEASING - release process
- VERSIONNUMBERS - version numbering policy
- DOCS - documentation structure and maintenance
Project
- ROADMAP - where the project is going
- DECISIONS - notable design decisions
- ACHIEVEMENTS - achievements to unlock
- IMPACT - the project’s intended impact
- CLIMATE - environmental cost and benefit
- FINANCE - project finances
- CREDITS - contributors
- This Week In Hledger 2023-2024 - a weekly project news digest, archived
See also:
- https://deepwiki.com/hledgerorg/hledger - an AI-generated presentation of hledger’s user and dev docs. Use with caution, but they look rather useful, as an alternate overview / map. Also you can ask it questions.
Dev notes on joyful.com:
- https://joyful.com/hledger
- https://joyful.com/PTA+transaction+balancing
- https://joyful.com/PTA+lot+tracking
- https://joyful.com/hledger+lot+tracking
- https://joyful.com/hledger+workflow+2025
- https://joyful.com/hledger+project+report+2024
Links
Discussion:
https://hledger.org/support
Github:
main repo: https://code.hledger.org
commits, https://ci.hledger.org, https://nightly.hledger.org, https://release.hledger.org
https://bugs.hledger.org, https://wishes.hledger.org, https://regressions.hledger.org, ISSUES
https://prs.hledger.org, https://draftprs.hledger.org, https://readyprs.hledger.org, https://assignedprs.hledger.org, https://unassignedprs.hledger.org, PULLREQUESTS
site repo: https://site.hledger.org
finance repo: https://finance.hledger.org
related repos:
Hackage:
packages:
hledger-lib,
hledger,
hledger-ui,
hledger-web,
hledger-diff,
hledger-iadd,
hledger-interest,
hledger-irr,
*hledger*
reverse deps:
hledger-lib,
hledger,
hledger-ui,
hledger-web
Stackage:
build-constraints.yaml
open hledger-related issues
packages:
hledger-lib,
hledger,
hledger-ui,
hledger-web
versions:
hledger-lib,
hledger,
hledger-ui,
hledger-web
Repology:
quick hledger packaging status,
detailed hledger packaging status,
information for hledger,
all *hledger* packages
Homebrew:
hledger
our homebrew requested installs in last 365 days:
2025: #1632 of 28k, top 6%
2023: #1821 of 24k, top 8%
2020: #1520 of 10k, top 15%
Debian:
source packages:
haskell-hledger-lib,
bugs,
haskell-hledger,
bugs,
haskell-hledger-ui,
bugs,
haskell-hledger-web,
bugs
stable:
hledger,
bugs,
hledger-ui,
bugs,
hledger-web,
bugs
testing:
hledger,
bugs,
hledger-ui,
bugs,
hledger-web,
bugs
unstable:
hledger,
bugs,
hledger-ui,
bugs,
hledger-web,
bugs
all:
*hledger*
Popularity contest install stats:
hledger,
hledger-ui,
hledger-web
Ubuntu:
source packages:
haskell-hledger-lib,
bugs,
haskell-hledger,
bugs,
haskell-hledger-ui,
bugs,
haskell-hledger-web,
bugs
binary packages:
*hledger*
Gentoo:
*hledger*,
*hledger* overlays
Fedora:
hledger,
*hledger*,
Haskell SIG
Void Linux: package search->hledger
Nix: *hledger*
Sandstorm:
hledger web app & reviews,
issues
Reference: fosskers GHC compatibility chart
Old trello planning board: https://trello.hledger.org
hledger-web demo: https://demo.hledger.org
hledger GHCJS demo: https://hledger.fiatjaf.com, https://github.com/fiatjaf/hledger-web \