{"id":13569662,"url":"https://github.com/fbdtemme/torrenttools","last_synced_at":"2025-04-04T06:31:14.211Z","repository":{"id":37100832,"uuid":"329039030","full_name":"fbdtemme/torrenttools","owner":"fbdtemme","description":"Commandline tool for inspecting, creating and editing BitTorrent metafiles.","archived":false,"fork":false,"pushed_at":"2023-02-25T13:59:40.000Z","size":15296,"stargazers_count":200,"open_issues_count":29,"forks_count":15,"subscribers_count":11,"default_branch":"main","last_synced_at":"2024-11-05T02:35:38.683Z","etag":null,"topics":["bittorrent","cli","file-sharing","torrent"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fbdtemme.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null},"funding":{"github":"fbdtemme"}},"created_at":"2021-01-12T16:03:15.000Z","updated_at":"2024-10-12T18:50:52.000Z","dependencies_parsed_at":"2024-01-14T15:23:23.905Z","dependency_job_id":"d767f4c3-9963-49cb-9741-288f5d9f8eaf","html_url":"https://github.com/fbdtemme/torrenttools","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fbdtemme%2Ftorrenttools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fbdtemme%2Ftorrenttools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fbdtemme%2Ftorrenttools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fbdtemme%2Ftorrenttools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fbdtemme","download_url":"https://codeload.github.com/fbdtemme/torrenttools/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247134397,"owners_count":20889396,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bittorrent","cli","file-sharing","torrent"],"created_at":"2024-08-01T14:00:42.506Z","updated_at":"2025-04-04T06:31:09.197Z","avatar_url":"https://github.com/fbdtemme.png","language":"C++","funding_links":["https://github.com/sponsors/fbdtemme"],"categories":["cli","CLI Tools","C++"],"sub_categories":["Upload Assistant"],"readme":"![](resources/images/torrenttools-banner.svg)\n\n![build](https://github.com/fbdtemme/torrenttools/workflows/build/badge.svg)\n[![Copr build status](https://copr.fedorainfracloud.org/coprs/fbdtemme/torrenttools/package/torrenttools/status_image/last_build.png)](https://copr.fedorainfracloud.org/coprs/fbdtemme/torrenttools/package/torrenttools/)\n[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/fbdtemme/torrenttools)](https://github.com/fbdtemme/torrenttools/releases)\n[![C++ standard](https://img.shields.io/badge/C%2B%2B-20-blue)](https://isocpp.org/)\n[![Codacy Badge](https://api.codacy.com/project/badge/Grade/5cc3eec94d8a486dab62afeab5130def)](https://app.codacy.com/manual/floriandetemmerman/torrenttools?utm_source=github.com\u0026utm_medium=referral\u0026utm_content=fbdtemme/bencode\u0026utm_campaign=Badge_Grade_Dashboard)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\nA commandline tool for creating, inspecting and modifying bittorrent metafiles.\n\n[**Features**](#Status) |\n[**Documentation**](#Documentation) |\n[**Binary releases**](#binary-releases) |\n[**Building**](#Building) |\n[**License**](#License)\n\n## Features\n\n* Creating bittorrent metafiles.\n* Inspecting bittorrent metafiles.\n* Verifying bittorrent metafiles against local data.\n* Editing existing bittorrent metafiles.\n* Support for the new [v2 and hybrid protocols](https://blog.libtorrent.org/2020/09/bittorrent-v2/) .\n* Support for tracker abbreviations.\n* Support for announce substitution parameters.\n* Fast multi-buffer hashing with Intel ISA-L.\n\n## Example\n\n![](resources/images/create-demo.gif)\n\n## Status\n\nThis project is under development.\nThe commandline interface can change at any release prior to 1.0.0.\n\n## Performance\n\nFollowing test were performed on a in in-memory filesystem with 1 MiB piece size\nand as target a file filed with random data totalling 15.0 GiB:\nThe tested CPU is an Intel i7-7700HQ in a Dell XPS 15-9560 machine.\n\n![Benchmark](benchmark/benchmark.svg)\n\n## Documentation\n\nDocumentation is hosted on [Github Pages](https://fbdtemme.github.io/torrenttools/).\n\n\n## Binary releases\n\n### Contents\n\n* [Windows](#Windows)\n* [macOS](#macOS)\n* [Linux](#Linux)\n    * [Fedora](#Fedora)\n    * [CentOS](#CentOS/RHEL)\n    * [Ubuntu](#Ubuntu)\n    * [Debian](#Debian)\n    * [Ubuntu](#Ubuntu)\n    * [OpenSUSE](#OpenSUSE)\n    * [SUSE Linux Enterprise Server](#SUSE-Linux-Enterprise-Server-15)\n    * [Arch](#Arch)\n    * [AppImage](#AppImage)\n* [Docker](#inux)\n\n    \n### Windows\n\nAn .msi installer is available as a [release asset](https://github.com/fbdtemme/torrenttools/releases).\n\n__IMPORTANT: Please use a modern terminal that supports most ANSI escape codes, like [Windows Terminal](https://www.microsoft.com/en-us/p/windows-terminal/9n0dx20hk701) (not cmd or PowerShell).__\n\n### macOS\n\nA .pkg installer is available as a [release asset](https://github.com/fbdtemme/torrenttools/releases).\n\n### Linux\n\n#### Fedora\n\nBinary and source packages for Fedora 32, Fedora 33, Fedora 34 and Fedora Rawhide and CentOS\nstream are available in a [COPR repo](https://copr.fedorainfracloud.org/coprs/fbdtemme/torrenttools/).\n\n```shell\nsudo dnf copr enable fbdtemme/torrenttools\nsudo dnf install torrenttools\n```\n\n#### CentOS/RHEL\n\nBinary and source packages for CentOS8/RHEL8 and CentOS stream are available\nin a [COPR repo](https://copr.fedorainfracloud.org/coprs/fbdtemme/torrenttools/).\n\n```shell\nsudo dnf copr enable fbdtemme/torrenttools\nsudo dnf install torrenttools\n```\n#### Ubuntu\n\nBinary and source packages for Ubuntu 20.04, Ubuntu 20.10, Ubuntu 21.04 are available\nas a PPA via [launchpad](https://launchpad.net/torrenttools).\n\n```shell\nsudo add-apt-repository ppa:fbdtemme/torrenttools\nsudo apt-get update\nsudo apt install torrenttools\n```\n#### Debian\n\nA binary package is available for Debian Sid.\nOlder debian distributions should use the AppImage.\n\n```shell\necho 'deb http://download.opensuse.org/repositories/home:/fbdtemme/Debian_Unstable/ /' | sudo tee /etc/apt/sources.list.d/home:fbdtemme.list\ncurl -fsSL https://download.opensuse.org/repositories/home:fbdtemme/Debian_Unstable/Release.key | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/home_fbdtemme.gpg \u003e /dev/null\nsudo apt update\nsudo apt install torrenttools\n```\n\n#### openSUSE\n\nFor openSUSE Tumbleweed run the following as root:\n\n```shell\nzypper addrepo https://download.opensuse.org/repositories/home:fbdtemme/openSUSE_Tumbleweed/home:fbdtemme.repo\nzypper refresh\nzypper install torrenttools\n```\nFor openSUSE Leap 15.2 run the following as root:\n```shell\nzypper addrepo https://download.opensuse.org/repositories/home:fbdtemme/openSUSE_Leap_15.2/home:fbdtemme.repo\nzypper refresh\nzypper install torrenttools\n```\nFor openSUSE Leap 15.3 run the following as root:\n```shell\nzypper addrepo https://download.opensuse.org/repositories/home:fbdtemme/openSUSE_Leap_15.3/home:fbdtemme.repo\nzypper refresh\nzypper install torrenttools\n```\n\n#### SUSE Linux Enterprise Server 15\nFor SLE 15 SP2 run the following as root:\n```shell\nzypper addrepo https://download.opensuse.org/repositories/home:fbdtemme/SLE_15_SP2/home:fbdtemme.repo\nzypper refresh\nzypper install torrenttools\n```\nFor SLE 15 SP3 run the following as root:\n```shell\nzypper addrepo https://download.opensuse.org/repositories/home:fbdtemme/SLE_15_SP3/home:fbdtemme.repo\nzypper refresh\nzypper install torrenttools\n```\n\n#### Arch\n\nA source package for Arch linux is available on [AUR](https://aur.archlinux.org/packages/torrenttools/).\n\n```shell\ngit clone https://aur.archlinux.org/torrenttools.git\ncd torrenttools\nmakepkg -is\n```\n\n#### AppImage\n\nDistributions that have no package yet can use the AppImage that is available for download as a [release asset](https://github.com/fbdtemme/torrenttools/releases).\n\n\n### Docker\n\nA docker image is available on [dockerhub](https://hub.docker.com/repository/docker/fbdtemme/torrenttools).\n\n```shell\ndocker pull fbdtemme/torrenttools\n```\n\n\n## Building\n\nThis library depends on following projects:\n\n*  [CLI11](https://github.com/CLIUtils/CLI11)\n*  [Catch2](https://github.com/catchorg/Catch2)\n*  [CTRE](https://github.com/hanickadot/compile-time-regular-expressions)\n*  [gsl-lite](https://github.com/gsl-lite/gsl-lite)\n*  [RE2](https://github.com/google/re2)\n*  [expected-lite](https://github.com/martinmoene/expected-lite)\n*  [fmt](https://github.com/fmtlib/fmt)\n*  [nlohmann/json](https://github.com/nlohmann/json)\n*  [yaml-cpp](https://github.com/jbeder/yaml-cpp)\n*  [bencode](https://github.com/fbdtemme/bencode)\n*  [date](https://github.com/HowardHinnant/date)\n*  [OpenSSL](https://github.com/openssl/openssl)\n*  Optional: [ISA-L Crypto](https://github.com/intel/isa-l_crypto)\n\nAlmost all dependencies can be fetched from github during configure time or can be installed manually.\nOpenSSL has to be installed on the system in advance.\n\n### Installing build dependencies\n\nUbuntu\n\n```shell\nsudo apt install build-essential git cmake g++-10 libssl-dev \n```\n\nDebian\n\n```shell\nsudo apt install build-essential git cmake g++-10 libssl-dev libtbb-dev\n```\n\nFedora/RHEL/CentOS\n\n```shell\nsudo dnf install cmake make g++ git openssl-devel automake autoconf\n```\n\n### Configuration\n\n| Option                         |  Type    |  Description                 |\n|--------------------------------|----------|------------------------------| \n| TORRENTTOOLS_BUILD_TESTS       | Bool     | Build tests.                 |\n| TORRENTTOOLS_BUILD_DOCS        | Bool     | Build documentation.         |\n| TORRENTTOOLS_INSTALL           | Bool     | Generate an install target.  |\n| DOTTORRENT_MB_CRYPTO_LIB       | String   | Pass \"isal\" for fast multibuffer hashing |\n\n### Building\n\nThis project requires C++20.\nCurrently only GCC 10 or later is supported.\n\nThis project can be build as every other project which makes use of the CMake build system.\n\n```{bash}\nmkdir build\ncd build\ncmake -DCMAKE_BUILD_TYPE=Release ..\ncmake --build . --target torrenttools\n```\n\n### Installation\n\nInstalling the project:\n\n```{bash}\nsudo cmake --install . --component torrentttools\n```\n\n## License\n\nDistributed under the MIT license. See `LICENSE` for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffbdtemme%2Ftorrenttools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffbdtemme%2Ftorrenttools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffbdtemme%2Ftorrenttools/lists"}