torq

A BitTorrent client implementation in TypeScript using Node.js.

Features

• Decode - Decode bencoded strings
• Info - Display torrent file metadata (tracker URL, length, info hash, piece info)
• Peers - Discover peers from tracker
• Handshake - Perform BitTorrent handshake with peers

Installation

pnpm install

Usage

# launch the terminal UI
pnpm dev

# display torrent file info
pnpm exec tsx app/cli.ts info sample.torrent

# discover peers from tracker
pnpm exec tsx app/cli.ts peers sample.torrent

# perform peer handshake with tracker
pnpm exec tsx app/cli.ts handshake sample.torrent <peer_ip>:<peer_port>

# download a piece from tracker
pnpm exec tsx app/cli.ts download_piece -o /tmp/test-piece sample.torrent <piece_index>

# download a complete file from tracker
pnpm exec tsx app/cli.ts download -o /tmp/out.test sample.torrent

Development

# run application in cli mode
pnpm exec tsx app/cli.ts <cmd>

# run the complete test suite
npm test

Project Structure

• app/main.ts - TUI entry point
• app/cli.ts - CLI entry point
• app/cmds/ - CLI commands
• app/core/ - Core torrent logic
• app/utils/ - Utilities (bencode, buffer)
• app/ui/ - UI components (TUI)

Contributing

Contributions are welcome! Please follow these guidelines:

1. Fork the repository
2. Create a feature branch (git switch -c feature/amazing-feature)
3. Make your changes
4. Add tests for new functionality
5. Ensure all tests pass (npm test)
6. Commit your changes
7. Push to the feature branch
8. Open a pull request