# ynab-buddy

### Easily convert (csv) files from _any_ bank and upload them directly to your [YNAB](https://ynab.com) Budget.

No more hassle with csv-converters and manual file uploads! Just download transactions from your bank, run ynab-buddy, and watch your transactions appear in YNAB.

https://user-images.githubusercontent.com/4604406/192013081-5b00b20c-9b67-4a74-83b0-f8ba7b728f5e.mp4

> Created with ☕ by [@nielsmaerten](https://github.com/nielsmaerten)  
> [![codecov](https://codecov.io/gh/nielsmaerten/ynab-buddy/branch/main/graph/badge.svg?token=W3P5UTSTU6)](https://codecov.io/gh/nielsmaerten/ynab-buddy) [![Node.js CI](https://github.com/nielsmaerten/ynab-buddy/actions/workflows/node.js.yml/badge.svg)](https://github.com/nielsmaerten/ynab-buddy/actions/workflows/node.js.yml)

## 📚 Table of Contents

- [🚀 How to Install](#how-to-install)
- [📈 How to Use](#how-to-use)
- [⚙️ How to Configure](#how-to-configure)
- [🆘 Where to Get Help](#where-to-get-help)
- [😊 Coffee?](#😊-coffee)
- [⚠️ Disclaimer](#disclaimer)

## 🚀 How to Install

- If you have NodeJS, run the following command: `npm install -g ynab-buddy`
- If you don't have NodeJS, [download](https://github.com/nielsmaerten/ynab-buddy/releases/latest) the latest release of ynab-buddy from GitHub

## 📈 How to Use

1. **Download** CSV-files containing your transactions from your bank
2. **Run** `ynab-buddy` from your terminal/command line, or double-click the executable
3. **Done**! Your transactions are now in YNAB. Start categorizing and take control of your finances :)

## ⚙️ How to Configure

When you run ynab-buddy for the first time, a configuration file will be created in your home directory. This file helps ynab-buddy understand the structure of your bank's files and how to process them.

To make ynab-buddy work seamlessly with your bank, open the config file and follow the instructions provided in the comments.

## 🆘 Where to Get Help

- [FAQs](./docs/FAQ.md)
- For general help: [GitHub Discussions](https://github.com/nielsmaerten/ynab-buddy/discussions)
- For bugs: [GitHub Issues](https://github.com/nielsmaerten/ynab-buddy/issues)
- Tech docs (for developers): [CONTRIBUTING.md](./CONTRIBUTING.md)
- Please **DO NOT** contact YNAB Support. This is a community project, not an official YNAB service.

## 😊 Coffee?

Did ynab-buddy save you some time? If so, consider showing your support by buying me a coffee! Your kind gesture helps me continue improving and maintaining this tool for the YNAB community.

[☕ Buy me a coffee](https://ko-fi.com/nielsmaerten)

Thank you for your support! 🙌

## ⚠️ Disclaimer

ynab-buddy is a **community-made tool** for YNAB.  
The YNAB support team, while awesome, cannot help you resolve issues with this tool.

This software is provided "as-is", without warranty of any kind. See the [full MIT License](./LICENSE)