Installation and Setup

In this page we will go through everything you need to get YNAB Unlinked working.

Pre-requisites

YNAB Unlinked is a Python CLI built with Typer. In order to be able to run it, you would need Python installed on your system and Hatch to run the tool.

You will also need a YNAB API Key to be able to connect to YNAB.

Python

Since we are using Hatch to manage the environments we are going to use to run the tool, having Python installed in your system is enough, since this won't interfere with the system installation. However, you are free to use any Python environment you like.

To validate you have Python on your system, run

python --version

You should get an output similar to

Python 3.13.1

The specific version might vary in your system. If you get an error saying that Python is not found, download the latest version from the official python download page.

Once installed ensure you have python by running the commands above.

Hatch

Hatch is used as the packagin tool and to manage virtual environments within the project. Follow the installation guide from the Hatch website.

Once installed try running

hatch --version

You should get an output similar to

Hatch, version 1.14.0

Although the specific verison might vary since the time this guide was written.

YNAB API Key

YNAB provides an API that can be used to interact with YNAB and this is what YNAB unlinked uses to create and update transactions. Follow the steps below to get the key:

1. Sign in to the YNAB web app and go to the Account Settings page and then to the Developer Settings page.
2. Under the Personal Access Tokens section, click New Token, enter your password and click Generate to get an access token.
3. Store this token securely to be used later.

Setup YNAB Unlinked

To start using YNAB Unlinked the first step is to clone the repo within your prefered folder.

git clone [email protected]:AAraKKe/ynab-unlinked.git && cd ynab-unlinked

Now that you are in the root of the repo, keep your API key at hand, and execute:

hatch run yul setup

This process will request the api key and will ask you what is the budget you want to manage through YNAB Unlinked.