torrent-tui 0.0.3 → 0.0.4

package/README.md

@@ -54,7 +54,8 @@ From inside the app:
 | --- | --- |
 | `j` / `k` or arrow keys | Move selection |
 | `Tab` | Change focus |
-| `a` | Add a `.torrent` file |
+| `a` | Add a `.torrent` file or magnet link |
+| `/` in add dialog | Type a magnet link manually |
 | `Space` | Pause or resume the selected torrent |
 | `d` | Remove the selected torrent |
 | `D` | Remove the selected torrent and downloaded files |
@@ -68,18 +69,24 @@ The package also exposes a few command-line checks around the same torrent engin
 torrent-tui --help
 torrent-tui --version
 torrent-tui file.torrent
+torrent-tui 'magnet:?xt=urn:btih:...'
 torrent-tui file.torrent --verify
 torrent-tui file.torrent --handshake
 torrent-tui file.torrent --download
+torrent-tui 'magnet:?xt=urn:btih:...' --download
 ```
 
 | Command | Description |
 | --- | --- |
 | `torrent-tui` | Start the terminal UI. |
 | `torrent-tui <file.torrent>` | Start the TUI and add the torrent. |
+| `torrent-tui <magnet-uri>` | Start the TUI, fetch magnet metadata, cache it, and start the torrent. |
 | `torrent-tui <file.torrent> --verify` | Create storage and verify local pieces. |
 | `torrent-tui <file.torrent> --handshake` | Connect to peers and print a connection summary. |
 | `torrent-tui <file.torrent> --download` | Run the downloader without launching the TUI. |
+| `torrent-tui <magnet-uri> --download` | Fetch magnet metadata, cache it, then run the downloader without launching the TUI. |
+
+Magnet support covers BitTorrent v1 `btih` magnets with trackers (`tr`), explicit peers (`x.pe`), or DHT-discovered peers. After metadata is cached, `--verify` and `--handshake` can use the same magnet URI.
 
 ## Configuration
 
@@ -120,6 +127,7 @@ The TUI shows detailed per-torrent states while keeping the sidebar filters simp
 | State | Meaning |
 | --- | --- |
 | `Queued` | The `.torrent` was accepted and is waiting for engine startup. |
+| `Metadata` | A magnet link was accepted and metadata is being fetched from peers. |
 | `Checking` | Local files are being checked against torrent piece hashes. |
 | `Connecting` | Trackers were contacted and the client is connecting to peers. |
 | `Downloading` | Pieces are actively being requested or received. |
@@ -161,7 +169,8 @@ The `Downloading` sidebar filter includes queued, checking, connecting, download
 | Peer handshakes and piece download | Available |
 | Resume data | Available |
 | Multi-torrent TUI | Available |
-| Magnet links | Not included yet |
+| Magnet links | Available for v1 magnets with tracker, explicit-peer, or DHT discovery |
+| Peer discovery | Trackers, DHT, and PEX |
 | Standalone binaries | Not included yet |
 
 ## Development

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "torrent-tui",
-	"version": "0.0.3",
+	"version": "0.0.4",
 	"description": "A Bun-powered terminal BitTorrent client.",
 	"module": "src/index.ts",
 	"type": "module",

package/src/app.ts

@@ -1,4 +1,8 @@
-import { type CliRenderer, createCliRenderer } from "@opentui/core";
+import {
+	type CliRenderer,
+	createCliRenderer,
+	type PasteEvent,
+} from "@opentui/core";
 import { loadConfig } from "./config";
 import { AppController } from "./controllers/app-controller";
 import { AddTorrentDialog } from "./layout/add-torrent-dialog";
@@ -9,7 +13,9 @@ import { StatusBar } from "./layout/status-bar";
 import { ToastManager } from "./layout/toast-manager";
 import { Store } from "./store";
 import { TorrentBridge } from "./torrent/bridge";
+import { isMagnetUri } from "./torrent/magnet";
 import type { LayoutDimensions } from "./types/layout";
+import { env } from "./utils/env";
 import { calculateLayout } from "./utils/layout";
 
 const INITIAL_STATE = {
@@ -37,7 +43,11 @@ export class App {
 	async start(initialTorrentPath?: string): Promise<void> {
 		const config = loadConfig();
 
-		this.renderer = await createCliRenderer({ exitOnCtrlC: true });
+		this.renderer = await createCliRenderer({
+			exitOnCtrlC: true,
+			openConsoleOnError: env.SHOW_CONSOLE,
+			useConsole: env.SHOW_CONSOLE,
+		});
 		this.store = new Store(INITIAL_STATE);
 		this.layout = calculateLayout(this.renderer.width, this.renderer.height);
 		this.bridge = new TorrentBridge(this.store, config);
@@ -81,6 +91,10 @@ export class App {
 			return this.addDialog.handleInput(key);
 		};
 
+		this.controller.onDialogPaste = (event: PasteEvent) => {
+			return this.addDialog.handlePaste(event);
+		};
+
 		this.controller.onQuit = async () => {
 			await this.bridge.stopAll();
 			this.renderer.destroy();
@@ -143,11 +157,13 @@ export class App {
 	}
 
 	private async addTorrentInBackground(
-		filePath: string,
+		input: string,
 		filename: string,
 	): Promise<void> {
 		try {
-			const result = await this.bridge.addTorrent(filePath);
+			const result = isMagnetUri(input)
+				? await this.bridge.addMagnet(input)
+				: await this.bridge.addTorrent(input);
 			this.toastManager.show({
 				id: `added-${Date.now()}`,
 				type: result.added ? "success" : "info",

package/src/constants/index.ts

@@ -3,7 +3,7 @@ export const APP_NAME = "torrent-tui";
 export const SIDEBAR_WIDTH = 20;
 
 export const SIDEBAR_ITEMS = {
-	status: ["All", "Downloading", "Seeding", "Completed", "Stopped"],
+	status: ["All", "Downloading", "Paused", "Seeding", "Completed", "Stopped"],
 } as const;
 
 export type SidebarSection = keyof typeof SIDEBAR_ITEMS;

package/src/controllers/app-controller.ts

@@ -1,4 +1,4 @@
-import type { CliRenderer, KeyEvent } from "@opentui/core";
+import type { CliRenderer, KeyEvent, PasteEvent } from "@opentui/core";
 import { SIDEBAR_ITEMS } from "../constants";
 import type { ConfirmDialog } from "../layout/confirm-dialog";
 import type { ContentWindow, FocusArea } from "../layout/content-window";
@@ -38,7 +38,8 @@ export class AppController {
 	onAddTorrent?: () => void;
 	onQuit?: () => void;
 	onDialogClose?: () => void;
-	onDialogInput?: (key: string) => boolean;
+	onDialogInput?: (key: KeyEvent) => boolean;
+	onDialogPaste?: (event: PasteEvent) => boolean;
 	onPauseTorrent?: (id: string) => Promise<void> | void;
 	onResumeTorrent?: (id: string) => Promise<void> | void;
 	onStartTorrent?: (id: string) => Promise<void> | void;
@@ -101,6 +102,9 @@ export class AppController {
 		this.renderer.keyInput.on("keypress", (key) => {
 			this.handleKeyPress(key);
 		});
+		this.renderer.keyInput.on("paste", (event: PasteEvent) => {
+			this.handlePaste(event);
+		});
 
 		this.refreshView();
 	}
@@ -216,8 +220,13 @@ export class AppController {
 				if (key.name === "escape") {
 					this.focusMode = "global";
 					this.onDialogClose?.();
+					key.preventDefault();
+					key.stopPropagation();
 				} else {
-					this.onDialogInput?.(key.name);
+					if (this.onDialogInput?.(key)) {
+						key.preventDefault();
+						key.stopPropagation();
+					}
 				}
 			}
 			return;
@@ -346,11 +355,20 @@ export class AppController {
 		} else if (key.name === "a") {
 			this.focusMode = "dialog";
 			this.onAddTorrent?.();
+			key.preventDefault();
+			key.stopPropagation();
 		} else if (key.name === "q") {
 			this.onQuit?.();
 		}
 	}
 
+	private handlePaste(event: PasteEvent): void {
+		if (this.focusMode !== "dialog" || this._confirmDialog?.getIsOpen()) return;
+		if (this.onDialogPaste?.(event)) {
+			event.preventDefault();
+		}
+	}
+
 	private nextFocusArea(): FocusArea {
 		switch (this.focusArea) {
 			case "sidebar":

package/src/index.ts

@@ -21,12 +21,17 @@ async function printHelp(): Promise<void> {
 Usage:
   torrent-tui                         Start the terminal UI
   torrent-tui <file.torrent>          Start the TUI and add the torrent
+  torrent-tui <magnet-uri>            Start the TUI and fetch magnet metadata
   torrent-tui <file.torrent> --verify Verify local pieces and trackers
   torrent-tui <file.torrent> --handshake
                                       Connect to peers and print handshake summary
-  torrent-tui <file.torrent> --download
+  torrent-tui <file.torrent|magnet> --download
                                       Download from the command line
 
+Magnet links:
+  Supported for BitTorrent v1 btih magnets with trackers, x.pe peers, or DHT peers.
+  --verify and --handshake can use a magnet after its metadata is cached.
+
 Options:
   --help, -h                          Show this help
   --version, -v                       Print the version`);
@@ -42,6 +47,27 @@ function validateTorrentArg(arg: string): string {
 	return arg;
 }
 
+async function resolveTorrentArg(arg: string): Promise<string> {
+	const { isMagnetUri } = await import("./torrent/magnet");
+	if (!isMagnetUri(arg)) return validateTorrentArg(arg);
+	const { resolveMagnetToTorrent } = await import("./torrent/magnet-resolver");
+	const result = await resolveMagnetToTorrent(arg);
+	return result.torrentPath;
+}
+
+async function cachedTorrentArg(arg: string): Promise<string> {
+	const { isMagnetUri, parseMagnetUri } = await import("./torrent/magnet");
+	if (!isMagnetUri(arg)) return validateTorrentArg(arg);
+	const { metadataCachePath, readCachedMetadata } = await import(
+		"./torrent/metadata-cache"
+	);
+	const magnet = parseMagnetUri(arg);
+	if (!readCachedMetadata(magnet.infoHashHex)) {
+		fail("Error: cached metadata not found; add or download the magnet first");
+	}
+	return metadataCachePath(magnet.infoHashHex);
+}
+
 function sep(): void {
 	console.log("-".repeat(44));
 }
@@ -184,9 +210,16 @@ async function runHandshake(torrentPath: string): Promise<void> {
 }
 
 async function runDownload(torrentPath: string): Promise<void> {
-	const { announce } = await import("./torrent/tracker/announce");
 	const { PeerManager } = await import("./torrent/peer/manager");
 	const { getPeerId, peerIdToString } = await import("./torrent/peer/peer-id");
+	const { DiscoveryCoordinator } = await import(
+		"./torrent/discovery/coordinator"
+	);
+	const {
+		createUploadedAccumulator,
+		recordRemovedPeerUpload,
+		uploadedSnapshot,
+	} = await import("./torrent/upload-accounting");
 	const { metadata, session } = await loadTorrent(torrentPath);
 	const { log } = await import("./torrent/metadata");
 
@@ -195,25 +228,42 @@ async function runDownload(torrentPath: string): Promise<void> {
 
 	await session.start();
 
-	const trackerResult = await announce(metadata).catch(() => null);
-	const peers = trackerResult?.peers ?? [];
-
 	console.log("");
 	const manager = new PeerManager(metadata);
 	await manager.start();
-	await manager.connect(peers);
-
-	if (manager.connections.size === 0) {
-		log("error", "no peers connected — cannot download");
-		manager.close();
-		return;
-	}
-
-	const unchoked = manager.getUnchoked().length;
-	log("peers", `${manager.connections.size} connected   ${unchoked} unchoked`);
+	const uploadedAccumulator = createUploadedAccumulator();
+	const trackerCoordinator = new DiscoveryCoordinator(metadata, manager, {
+		getSnapshot: () => {
+			const downloaded = session.storage.downloadedBytes;
+			const uploaded = uploadedSnapshot(
+				uploadedAccumulator,
+				manager.connections.values(),
+			);
+			return {
+				downloaded,
+				uploaded,
+				left: Math.max(0, metadata.totalSize - downloaded),
+			};
+		},
+		onPeers: (peers) => {
+			void manager.connect(peers).then(() => {
+				const unchokedNow = manager.getUnchoked().length;
+				log(
+					"peers",
+					`${manager.connections.size} connected   ${unchokedNow} unchoked`,
+				);
+			});
+		},
+	});
+	manager.on("peerRemoved", (conn: { uploadedTotal: number } & object) => {
+		recordRemovedPeerUpload(uploadedAccumulator, conn);
+		if (manager.connections.size === 0) trackerCoordinator.refreshNow();
+	});
+	await trackerCoordinator.start();
 
 	manager.startChoking();
 	const downloader = session.download(manager);
+	session.on("complete", () => trackerCoordinator.markCompleted());
 
 	await new Promise<void>((resolve) => {
 		session.on("complete", () => resolve());
@@ -253,6 +303,7 @@ async function runDownload(torrentPath: string): Promise<void> {
 	}
 	console.log(line);
 
+	await trackerCoordinator.stop();
 	manager.close();
 }
 
@@ -275,25 +326,34 @@ async function main() {
 	const isDownload = args.includes("--download");
 
 	if (torrentArg) {
-		const torrentPath = validateTorrentArg(torrentArg);
+		const { isMagnetUri } = await import("./torrent/magnet");
+		const torrentPath = isMagnetUri(torrentArg)
+			? torrentArg
+			: validateTorrentArg(torrentArg);
 
 		if (isVerify) {
-			await runVerify(torrentPath).catch((e) =>
-				fail(`Error: ${e instanceof Error ? e.message : e}`),
+			const resolvedPath = await cachedTorrentArg(torrentPath);
+			await runVerify(resolvedPath).catch((e: unknown) =>
+				fail(`Error: ${e instanceof Error ? e.message : String(e)}`),
 			);
 			return;
 		}
 
 		if (isHandshake) {
-			await runHandshake(torrentPath).catch((e) =>
-				fail(`Error: ${e instanceof Error ? e.message : e}`),
+			const resolvedPath = await cachedTorrentArg(torrentPath);
+			await runHandshake(resolvedPath).catch((e: unknown) =>
+				fail(`Error: ${e instanceof Error ? e.message : String(e)}`),
 			);
 			return;
 		}
 
 		if (isDownload) {
-			await runDownload(torrentPath).catch((e) =>
-				fail(`Error: ${e instanceof Error ? e.message : e}`),
+			const resolvedPath = await resolveTorrentArg(torrentPath).catch(
+				(e: unknown) =>
+					fail(`Error: ${e instanceof Error ? e.message : String(e)}`),
+			);
+			await runDownload(resolvedPath).catch((e: unknown) =>
+				fail(`Error: ${e instanceof Error ? e.message : String(e)}`),
 			);
 			return;
 		}