# OrbTorrent Docs

> How to use OrbTorrent, the free, open-source torrent app made for the Mac, and how to build extensions for it in TypeScript.

## Use OrbTorrent

#### Get started

[Install OrbTorrent](https://orbtorrent.com/docs/get-started/install), [add your first download](https://orbtorrent.com/docs/get-started/first-download), and [bring your downloads over](https://orbtorrent.com/docs/get-started/switch) from Transmission or qBittorrent.

#### Everyday use

[The menu bar](https://orbtorrent.com/docs/guides/menu-bar), [the library window](https://orbtorrent.com/docs/guides/library), [each download's details](https://orbtorrent.com/docs/guides/download-details), and [choosing files](https://orbtorrent.com/docs/guides/files) and the order they download in.

#### Network and privacy

[Download only through a VPN](https://orbtorrent.com/docs/guides/vpn), keep your VPN's [forwarded port](https://orbtorrent.com/docs/guides/port-forwarding) in step, and [find more peers](https://orbtorrent.com/docs/guides/peers) for slow downloads.

#### Help

[Troubleshooting](https://orbtorrent.com/docs/help/troubleshooting) for the usual problems, every [setting](https://orbtorrent.com/docs/reference/settings) and [shortcut](https://orbtorrent.com/docs/reference/shortcuts), and how to [report a problem](https://orbtorrent.com/docs/help/report-a-problem).

## Build extensions

Extensions are TypeScript. They check a download before it starts, and can hold it until you decide, or act on it once it finishes. They run in a sandbox, and reach only the files and sites they list.

- [Your first extension](https://orbtorrent.com/docs/extensions/getting-started): Make one from a template, test it, and run it on one of your downloads in about ten minutes.
- [Build with a coding agent](https://orbtorrent.com/docs/extensions/coding-agents): Say what it should do, and Claude Code, Codex, Cursor or Gemini CLI writes it, tests it and tries it.
- [API reference](https://orbtorrent.com/docs/extensions/reference/api): fetch, files, storage, progress, settings and everything else @orbtorrent/api provides.
- [The orb command](https://orbtorrent.com/docs/extensions/reference/cli): Every orb command and option, its JSON output, and what it needs from OrbTorrent.

## For language models

Every page here is also plain Markdown, at its address plus `.md`, and has a **Copy page** button under its title. [llms.txt](https://orbtorrent.com/llms.txt) lists the whole site, and [llms-full.txt](https://orbtorrent.com/llms-full.txt) holds all of these docs in one file. Coding agents building an extension can read just [the extension docs](https://orbtorrent.com/docs/extensions/llms-full.txt).
