{"id":13441806,"url":"https://github.com/ledger/ledger","last_synced_at":"2025-05-13T00:30:21.535Z","repository":{"id":398172,"uuid":"16309","full_name":"ledger/ledger","owner":"ledger","description":"Double-entry accounting system with a command-line reporting interface","archived":false,"fork":false,"pushed_at":"2025-03-15T11:12:49.000Z","size":19834,"stargazers_count":5515,"open_issues_count":757,"forks_count":511,"subscribers_count":110,"default_branch":"master","last_synced_at":"2025-04-08T23:05:35.046Z","etag":null,"topics":["accounting","command-line-tool","ledger","plaintext-accounting"],"latest_commit_sha":null,"homepage":"https://www.ledger-cli.org","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ledger.png","metadata":{"files":{"readme":"README.md","changelog":"NEWS.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2008-05-12T19:39:49.000Z","updated_at":"2025-04-08T22:03:48.000Z","dependencies_parsed_at":"2023-07-05T14:47:12.496Z","dependency_job_id":"da8acb3a-dcd5-4fca-80ae-0ef503813f82","html_url":"https://github.com/ledger/ledger","commit_stats":{"total_commits":6099,"total_committers":228,"mean_commits":26.75,"dds":"0.33792424987702907","last_synced_commit":"f480f37a847100d351a970a1b83a86d9eeccbcc7"},"previous_names":[],"tags_count":36,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ledger%2Fledger","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ledger%2Fledger/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ledger%2Fledger/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ledger%2Fledger/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ledger","download_url":"https://codeload.github.com/ledger/ledger/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250494735,"owners_count":21440035,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["accounting","command-line-tool","ledger","plaintext-accounting"],"created_at":"2024-07-31T03:01:38.246Z","updated_at":"2025-04-23T18:44:41.772Z","avatar_url":"https://github.com/ledger.png","language":"C++","funding_links":[],"categories":["C++","Tutorial","others","command-line-tool","Applications and Platforms","Applications","Miscellaneous"],"sub_categories":["Windows Manager","Wealth","Directory Navigation"],"readme":"[![Join the chat at https://gitter.im/use-package/Lobby](https://badges.gitter.im/use-package/Lobby.svg)](https://gitter.im/use-package/Lobby?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n![Build Status master](https://github.com/ledger/ledger/actions/workflows/cmake.yml/badge.svg)\n[![Status](https://img.shields.io/badge/status-active-brightgreen.svg?style=flat)](https://github.com/ledger/ledger/pulse/monthly)\n[![License](https://img.shields.io/badge/license-BSD-blue.svg?style=flat)](https://opensource.org/licenses/BSD-3-Clause)\n[![GitHub release](https://img.shields.io/github/release/ledger/ledger.svg?style=flat)](https://github.com/ledger/ledger/releases)\n\n# Ledger: Command-Line Accounting\n\nLedger is a powerful, double-entry accounting system that is accessed from the\nUNIX command-line.  This may put off some users, since there is no flashy UI,\nbut for those who want unparalleled reporting access to their data there are\nfew alternatives.\n\nLedger uses text files for input.  It reads the files and generates reports;\nthere is no other database or stored state.  To use Ledger, you create a\nfile of your account names and transactions, run from the command line with\nsome options to specify input and requested reports, and get output.\nThe output is generally plain text, though you could generate a graph or\nhtml instead.  Ledger is simple in concept, surprisingly rich in ability,\nand easy to use.\n\n\n## For the Impatient\n\nI know, you just want to build and play.  If you have all the [dependencies](#dependencies)\ninstalled, then simply do this:\n\n    $ git clone git@github.com:ledger/ledger.git\n    $ cd ledger \u0026\u0026 ./acprep update  # Update to the latest, configure, make\n\nNow try your first ledger command:\n\n    $ ./ledger -f test/input/sample.dat reg\n\nFor help on keeping your journal have a look at the [documentation], the [wiki],\nand the [Resources](#resources) section at the end of this file.\nAn Emacs mode for Ledger files can be found in the\n[ledger/ledger-mode repository] and a vim plugin is located in the\n[ledger/vim-ledger repository].\n\n## Docker version\n\nIf you have Docker installed on your computer or server, you can use a [Docker version](https://hub.docker.com/r/dcycle/ledger/) of this software, without installing any further dependencies:\n\n    $ docker run --rm -v \"$PWD\"/test/input:/data dcycle/ledger:1 -f /data/sample.dat reg\n\n## Dependencies\n\nIf you wish to proceed in this venture, you'll need a few dependencies.\nNote that some features, e.g. `--import` require building Ledger with Python support.\nThe easiest way to get them for your platform is to run this handy Python script:\n\n    $ ./acprep dependencies\n\n\nIf that doesn't completely work, here are the dependencies for building the\ncurrent `master` branch:\n\nDependency  | Version (or greater)\n------------|---------------------\n[CMake]     | 3.16.2\n[Boost]     | 1.72\n[Gmp]       | 6.1.2\n[Mpfr]      | 4.0.2\n[utfcpp]    | 3.2.3\n[ICU]       | 63 _optional_\n[gettext]   | 0.17 _optional_\n[libedit]   | 20090111-3.0 _optional_\n[Python]    | 3.9 _optional_\n[Gpgmepp]   | 1.13.1 _optional_\n[doxygen]   | 1.9.5 _optional_, for `make docs`\n[graphviz]  | 2.20.3 _optional_, for `make docs`\n[texinfo]   | 4.13 _optional_, for `make docs`\n[lcov]      | 1.6 _optional_, for `make report`, used with `./acprep gcov`\n[sloccount] | 2.26 _optional_, for `make sloc`\n\n### macOS\n\nYou can use [Homebrew] or [MacPorts] to install build dependencies for Ledger\neasily on macOS.\n\n#### 1. Homebrew\n\nIf you use Homebrew, to install the dependencies you would run:\n\n    $ brew install cmake boost boost-python3 gmp mpfr\n\n#### 2. MacPorts\n\nIf you build stuff using MacPorts on macOS, as I do, here is what you would\nrun:\n\n    $ sudo port install -f cmake python37 \\\n         libiconv zlib gmp \\\n         mpfr ncurses ncursesw \\\n         gettext libedit boost-jam \\\n         boost +st+python37+icu texlive doxygen graphviz \\\n         texinfo lcov sloccount\n\n### Conda\n\nThe dependencies for building Ledger are available from [conda-forge] on certain\nplatforms (for example, `linux-64`), which can be used with [Conda] or [mamba].\n\nWith Conda you could run:\n\n    $ conda install -c conda-forge python=3 cmake boost gmp mpfr \\\n         gettext libedit texinfo doxygen graphviz\n\n### Ubuntu\n\nIf you're going to build on Ubuntu, `sudo apt-get install ...` the\nfollowing packages (current as of Ubuntu 18.04):\n\n    $ sudo apt-get install build-essential cmake doxygen \\\n         libboost-system-dev libboost-dev python3-dev gettext git \\\n         libboost-date-time-dev libboost-filesystem-dev \\\n         libboost-iostreams-dev libboost-python-dev libboost-regex-dev \\\n         libboost-test-dev libedit-dev libgmp3-dev libmpfr-dev texinfo tzdata\n\n### Debian\n\nDebian 10 (bullseye), Debian 11 (\"bullseye\"), Debian testing and Debian\nunstable (sid) contain all components needed to build ledger.  You can\ninstall all required build dependencies using the following command:\n\n    $ sudo apt-get install build-essential cmake autopoint texinfo python3-dev \\\n         zlib1g-dev libbz2-dev libgmp3-dev gettext libmpfr-dev \\\n         libboost-date-time-dev libboost-filesystem-dev \\\n         libboost-graph-dev libboost-iostreams-dev \\\n         libboost-python-dev libboost-regex-dev libboost-test-dev\n\n### Fedora\n\nYou can install all required build dependencies under Fedora using the\nfollowing command (tested with Fedora 32):\n\n    $ sudo dnf install boost-date-time boost-devel boost-filesystem \\\n        boost-iostreams boost-python3-devel boost-regex boost-system \\\n        boost-test cmake doxygen gettext git gmp-devel libedit-devel \\\n        mpfr-devel python3-devel texinfo tzdata\n\n## Building\n\nThe next step is preparing your environment for building.  While you can use\n`cmake .` and make, I've prepared a script that does a lot more of the\nfootwork for you:\n\n    $ ./acprep update\n    # or, if you want to use the Boost libraries with suffix -mt, install in\n    # $HOME/local and build with 2 processes in parallel\n    $ ./acprep update --boost-suffix=-mt --prefix=$HOME/local -j2\n\nPlease read the contents of `CMakeFiles/CMakeOutput.log` and\n`CMakeFiles/CMakeError.log` if the configure step fails.  Also,\nsee the `help` subcommand to `acprep`, which explains some of its many\noptions.  It's pretty much the only command I run for configuring, building\nand testing Ledger.\n\nYou can run `make check` to confirm the result, and `make install` to install.\n\n## Resources\n\nNow that you're up and running, here are a few resources to keep in mind:\n\n - [Homepage]\n - [Documentation]\n - [IRC channel][IRC]: #ledger channel on Libera Chat\n - [Mailing List / Forum][mailing list]\n - [GitHub project page][github]\n - [Code analysis][openhub]\n\nIf you have ideas you'd like to share, the best way is either to e-mail me a\npatch (I prefer attachments over pasted text), or to [get an account on GitHub](https://github.com/signup).\nOnce you do, fork the [Ledger project][github],\nhack as much as you like, then [open a pull request on GitHub](https://github.com/ledger/ledger/pulls).\n\n[Homepage]: https://ledger-cli.org/\n[documentation]: https://www.ledger-cli.org/docs.html\n[mailing list]: https://list.ledger-cli.org/\n[wiki]: https://wiki.ledger-cli.org/\n[IRC]: irc://irc.libera.chat/ledger\n[github]: https://github.com/ledger/ledger\n[ledger/vim-ledger repository]: https://github.com/ledger/vim-ledger\n[ledger/ledger-mode repository]: https://github.com/ledger/ledger-mode\n[Homebrew]: https://brew.sh/\n[MacPorts]: https://www.macports.org/\n[CMake]: https://cmake.org\n[Boost]: https://boost.org\n[GMP]: https://gmplib.org/\n[MPFR]: https://www.mpfr.org/\n[utfcpp]: https://utfcpp.sourceforge.net\n[ICU]: https://icu.unicode.org\n[gettext]: https://www.gnu.org/software/gettext/\n[libedit]: https://thrysoee.dk/editline/\n[Python]: https://python.org\n[Gpgmepp]: https://www.gnupg.org/related_software/gpgme/\n[doxygen]: https://www.doxygen.org/\n[graphviz]: https://graphviz.org/\n[texinfo]: https://www.gnu.org/software/texinfo/\n[lcov]: https://ltp.sourceforge.net/coverage/lcov.php\n[sloccount]: https://www.dwheeler.com/sloccount/\n[pcre]: https://www.pcre.org/\n[libofx]: https://libofx.sourceforge.net\n[expat]: https://libexpat.github.io\n\u003c!--\nxmlsoft url kept as http since its TLS certificate setup is incorrect and browser show\na \"This Connection Is Not Private\" message. [Last checked: 2023-03-13]\n--\u003e\n[libxml2]: http://xmlsoft.org\n[openhub]: https://www.openhub.net/p/ledger\n[conda-forge]: https://conda-forge.org\n[Conda]: https://conda.io\n[mamba]: https://github.com/mamba-org/mamba\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fledger%2Fledger","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fledger%2Fledger","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fledger%2Fledger/lists"}