torlink Documentation

To install torlink system-wide on NixOS, add inputs.torlink.packages.${pkgs.system}.default to your environment.systemPackages list in configuration.nix.

# configuration.nix
{ pkgs, inputs, ... }: 

{ 
  environment.systemPackages = with pkgs; [ 
    ... 
    inputs.torlink.packages.${pkgs.system}.default 
    ... 
  ]; 
}

torlink is a terminal-based torrent finder that requires Node.js. You can run it immediately without a permanent installation using npx.

npx torlnk

To install torlink for a specific user using home-manager, add inputs.torlink.packages.${pkgs.system}.default to your home.packages list in home.nix.

# home.nix
{ pkgs, inputs, ... }: 

{ 
  home.packages = with pkgs; [ 
    ... 
    inputs.torlink.packages.${pkgs.system}.default 
    ... 
  ]; 
}

To contribute to or work on torlink locally, follow these steps:

1. Clone the repository.
2. Install dependencies using npm install.
3. Run the development version using npm run dev.
4. Alternatively, build and run the bundled version:

   npm run build
   npx torlnk

To use torlink, add the repository as an input to your flake.nix. Note that the package is built using the unstable channel. If you are using a stable channel (e.g., 26.05) and wish to avoid using unstable dependencies, you can overwrite this by setting inputs.nixpkgs.follows = "nixpkgs" in your flake configuration.

Once installed, the binary is executed using the command torlnk.

inputs = {
  ...
  torlink.url = "github:baairon/torlink";
  ...
}

Once torlink is running, you can interact with it using the following keyboard shortcuts:

• Search: Type your query and press Enter.
• Browse: Press Enter on an empty search bar to browse the curated library.
• Download: Arrow to a result and press d to save it to your default downloads folder.
• Custom Download Location: Arrow to a result and press shift+d to pick a specific folder for that download.
• Change Default Downloads Folder: Press o in the Downloads pane.
• Help: Press ? to view the full list of commands.
• Seeding Control: Open the Seeding tab and press p to pause or stop an item.

The torlnk daemon exposes a local HTTP server that allows external programs (scripts, web apps, or curl) to manage torrents without interactive keypresses.

Security Note: By default, the server binds to 127.0.0.1. If you attempt to bind to a public interface, you must provide a token to authorize requests. You can set this via the --token CLI flag or the TORLINK_API_TOKEN environment variable.

Default Port: 9161

The maximum number of active downloads can be configured in two ways:

1. Constructor: Pass maxDownloads in the options object when instantiating DownloadQueue.
2. Environment Variable: Set TORLINK_MAX_DOWNLOADS to a positive integer. If unset or invalid, the limit is 0 (unlimited).

You can relocate all persisted application state (data and configuration) by setting the TORLINK_STATE_DIR environment variable.

When this environment variable is set:

• The configuration directory is moved to $TORLINK_STATE_DIR/config.
• The data directory is moved to $TORLINK_STATE_DIR/data.

This is useful for portable-state setups or for redirecting application data to a temporary directory during testing.

When running the server via runServe, you can provide a ServeOptions object to customize the runtime behavior:

torlink searches a curated list of reputable sources. If a source is offline, the search continues with the remaining sources.

| Category | Sources |
| --- | --- |
| Games | FitGirl |
| Movies | YTS, The Pirate Bay, 1337x, BitTorrented |
| TV | EZTV, The Pirate Bay, 1337x, BitTorrented |
| Anime | Nyaa, SubsPlease |