Skip to content

Installation Guide

How you install fnb depends on what you're trying to do:

You are... You want to... Go to
A user Run the fnb CLI to back up your own data For Users
A developer Clone the repo to tweak, debug, or contribute to fnb itself For Developers

Not sure which one? If you just want to run fnb fetch / fnb backup / fnb upload / fnb sync against your own config, you're a user — install from PyPI. If you want to read or change fnb's source code, you're a developer — clone the repository instead.

Requirements

  • Python: 3.12 or higher
  • rsync: available locally (and on the remote host, for fetch)

Both paths below assume uv is installed:

curl -LsSf https://astral.sh/uv/install.sh | sh

pip works too and is covered as an alternative on the For Users page.