BTFS(1)

💖 BTFS — bestie, you can literally mount a torrent as a filesystem 💖

okay so hi, welcome to btfs(1), a page from the General Commands Manual (yes, section 1, we're in the big leagues). grab a snack, this is gonna be fun 🍓

---

✨ NAME ✨

btfs — mount torrent files or magnet links as a file system 🦋

---

🌸 SYNOPSIS 🌸

btfs [options] metadata mountpoint

---

👑 DESCRIPTION 👑

btfs lets you mount any torrent file or a magnet link as a file system. that's it, that's the whole vibe 💅

the contents of the files get downloaded on-demand — like, as they're read by applications. so you're not waiting for the whole thing to land before you can peek at it. it's giving main character energy fr fr ✨

---

🎀 OPTIONS 🎀

• -v, --version — print version 👑
• -h, --help — print help 🫶
• -b, --browse-only — download metadata only, no actual file content 🧚
• -k, --keep — keep files after unmount (so they don't ghost you) 💖
• -s, --silent — do not create logs 🤫
• --utp-only — do not use TCP 🙈
• --data-directory=*DIRECTORY* — the directory in which to put btfs download data. it will by default use $XDG_DATA_HOME if defined, else use $HOME/btfs, or /tmp/btfs if the latter is unavailable 🌈
• --min-port=*PORT* — start of listen port range ⭐
• --max-port=*PORT* — end of listen port range ⭐
• --max-download-rate=*RATE* — maximum download rate (in kilobytes per second) 🔥
• --max-upload-rate=*RATE* — maximum upload rate (in kilobytes per second) 🔥

---

🦋 EXAMPLES 🦋

mounting a torrent file:

btfs video.torrent ~/mnt

mounting a magnet link:

btfs 'magnet:?xt=urn:btih:...' ~/mnt

unmounting:

fusermount -u ~/mnt

---

💀 BUGS 💀

found something cursed? please report any bugs to https://github.com/johang/btfs. they wanna know, no cap 😭

---

💜 AUTHORS 💜

BTFS has been written by Johan Gunnarsson <johan.gunnarsson@gmail.com> 👑

This man page was written by Donat Kh. <donat@opmbx.org> 🌸

---

and that's the whole page bestie — you just read BTFS(1) from the General Commands Manual, page 1 of 1, absolutely ate, no notes 💅✨🫶