Skip to content
Privatefolio Docs

Start here

Privatefolio Logo

Privatefolio

The AI Wealth Manager - A free* and open-source toolkit for financial empowerment

X Follow Discord

GitHub downloads Visitors GitHub last commit GitHub commits GitHub contributors GitHub forks GitHub stars

Installation

Section titled “Installation”

To install the Privatefolio desktop app, you can either download the apps from privatefolio.xyz/apps or from GitHub releases.

Each release contains the binaries for Windows, Linux and Mac.

On Windows, you can run the Privatefolio-<version>.Setup.exe executable directly.

On Linux, you can run sudo dpkg -i privatefolio_<version>_amd64.deb to install the package.

On Mac, download the dmg for your platform and run the installer.

What is it?

Section titled “What is it?”

Privatefolio is a tool you own. It allows you to collect, analyze and visualize your financial data.

You can use it in conjunction with LLMs and AI agents to gain a deeper understanding of where you are at, and to plan for the future.

Privatefolio is for: 1) Investment portfolios, 2) Accounting, 3) Tax reporting & planning, 4) Financial intelligence, 5) Privacy, 6) AI workflows, 7) Expense tracking, 8) Budgeting, 9) Cashflow predictions, 10) Retirement planning, 11) FIRE, 12) Volatility simulations, 13) Risk management and much more.

Features

Section titled “Features”
Privatefolio screenshot
  • Time travel through trades to surface the strengths and weaknesses of your portfolio
  • Inspect and compare your historical net worth with no limitations
  • Use advanced TradingView features on your data like indicators, drawing tools, etc.
  • Prepare your tax report or feed data into your AI assistant
  • Extend the project under the AGPL-3.0 license

License

Section titled “License”

Privatefolio is licensed under GNU AGPL-3.0, a copyleft license.

In summary, this license gives you the following freedoms:

  • Freedom to Use: You can use the software for any purpose, including commercial use.
  • Freedom to Study and Modify: You can study how the program works and modify it to suit your needs, including for commercial purposes.
  • Freedom to Distribute Copies: You can redistribute copies of the original program.
  • Freedom to Distribute Modified Versions: You are allowed to distribute your modified versions, including for profit. However, if you run a modified version of the software on a server and allow others to interact with it, you must provide the source code of the modified version to those users.

See the LICENSE file for more details.

For Developers

Section titled “For Developers”

TypeScript React Electron Lerna Prettier

Privatefolio is built with modern technologies like TypeScript, React, Bun (Node.js) and SQLite, making it familiar for open-source developers to contribute to the project.

For detailed setup instructions, architecture blueprints and more, please refer to docs.privatefolio.app.

How to Contribute

Section titled “How to Contribute”
  1. Fork the repository and clone it locally.
  2. Install dependencies using yarn and build the project using yarn build.
  3. Use yarn dev to start the development environment.
  4. Check open issues or TODO comments in the codebase to find tasks to work on.
  5. Join our Discord community to discuss development and get help.
  6. When you are ready, commit your changes and submit a pull request.

For a complete example of adding a new feature, check out PR #46 which demonstrates how to add a new price API extension.

For deployment steps, please refer to docs.privatefolio.app.

Key Technologies

Section titled “Key Technologies”
  • Frontend: React, Vite, Material-UI
  • Backend: Node.js, Bun runtime, SQLite
  • Desktop apps: Electron
  • Mobile apps: Expo (React Native)
  • Deployment: Docker

Feel free to open issues for bugs or feature requests!