Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brianlusina/tclient
Small BitTorrent Client
https://github.com/brianlusina/tclient
bittorrent-client client go golang torrent torrent-client
Last synced: 26 days ago
JSON representation
Small BitTorrent Client
- Host: GitHub
- URL: https://github.com/brianlusina/tclient
- Owner: BrianLusina
- License: mit
- Created: 2022-07-15T10:55:48.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-04T07:03:03.000Z (9 months ago)
- Last Synced: 2024-06-20T06:25:26.728Z (5 months ago)
- Topics: bittorrent-client, client, go, golang, torrent, torrent-client
- Language: Go
- Homepage:
- Size: 130 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# TClient
[](https://github.com/BrianLusina/tclient/actions/workflows/build_app.yml)
[](https://github.com/BrianLusina/tclient/actions/workflows/lint.yml)
[](https://github.com/BrianLusina/tclient/actions/workflows/tests.yml)
[](https://www.codacy.com/gh/BrianLusina/tclient/dashboard?utm_source=github.com&utm_medium=referral&utm_content=BrianLusina/tclient&utm_campaign=Badge_Grade)
A simple BitTorrent client in Go.
## Getting started
This client is pretty small & simple, however it has been structured to use minimal dependencies and follows a standard pattern to make the code easier to read.
There are a couple of things needed to get started.
1. [Go 1.18](https://go.dev/)
Instructions on installing Go 1.18 can be found in the link provided.
Pretty much that's it :)
Now, download dependencies with:
```bash
make install
```
## Usage
The options available are:
``` plain
Usage:
-input string
Input file
-output string
Where to download the file (default "./")
```
You can build the application and run it or run it directly with:
``` bash
go run cmd/cli/main.go -input -output
```
`` is the file path of the torrent file, `` is the output path that you intend the file to be downloaded to.
For example:
```bash
go run cmd/cli/main.go -input debian-11.4.0-amd64-netinst.iso.torrent -output debian.iso
```
Optionally, you can build the application
```bash
make build
# or
go build -o cmd/cli/main.go
```
> This will build the application in the [bin](./bin/) directory. If you use the second option to build the application, you can specify the `` directory.
Once done, you can use the binary as well:
```bash
tclient -input debian-10.2.0-amd64-netinst.iso.torrent -output debian.iso
```
> This assumes the binary built is called `tclient`
## Tests
Tests have been written for the source code and can be validated with running:
```bash
make test
# or
go test ./...
```
## Linting
Linting can be done using [golanci-lint](https://golangci-lint.run/) and setup is as below:
```bash
make setup-linting
```
Now run linting with:
```bash
make lint
```
Other commands can be found in the [Makefile](./Makefile).
## Limitations
- Only supports .torrent files (no magnet links)
- Only supports HTTP trackers
- Does not support multi-file torrents
- Strictly leeches (does not support uploading pieces)
## Versioning
[SemVer](https://semver.org/) is used for versioning. For the versions available, see the [tags](https://github.com/BrianLusina/tclient/tags) in this repository.
## License
View the project license [here](./LICENSE)