Skip to main content

aria2tui: A TUI Frontend for the Aria2c Download Manager

Project description

aria2tui

Aria2TUI is a download management tool. It acts as a TUI client for the aria2c download utility, facilitating bulk downloading, torrenting, queue control, the fine-tuning of download options (e.g., piece length, user-agent, max speed, etc.), downloading via proxy, and much more.

Aria2tui communicates with an aria2c daemon over RPC. The UI is provided by my TUI picker listpick.

https://github.com/user-attachments/assets/7c77a13f-90c7-4e67-9946-7b7009c835ad

Quickstart

Install aria2tui using pip:

python -m pip install aria2tui

When you run aria2tui for the first time it will bring up a config creation form with the defaults pre-set. This creates a config file in ~/.config/aria2tui/config.toml when you click save. Just enter your url, port, and token into the form and you are good to go.

aria2tui

Tips

Keybinds

  • Press ? in aria2tui to see the help page which will list the available keybinds.
  • Ctrl-l will redraw the screen; useful if there are stray artifacts after dropping to the shell
  • Switch between open aria2tui instances with { and }
  • Toggle the right-pane with ' and cycle between right-pane views with ".

Cursor Tracking and Auto-Refresh

Cursor Tracking Modes

By default, the cursor follows the selected download task. If you're viewing an active download that completes and moves to the bottom of the list, the cursor moves with it.

For scenarios where you want the cursor to stay at a fixed position (e.g., watching active downloads at the top), you can enable pin cursor mode:

  • Press ` and type pc to toggle pin cursor mode
  • Alternatively, press ~ to open settings and select the pin cursor option
  • A pin symbol (📌) in the footer indicates which tracking mode is active

Auto-Refresh Control

When performing bulk operations on rapidly changing downloads (e.g., hundreds of images transitioning from active/waiting to completed), it's recommended to disable auto-refresh to maintain data integrity during selection. To toggle auto-refresh:

  • Press ~ and toggle the auto-refresh option

Important

  • Aria2TUI was made to work on UNIX systems.
  • Changing download options for a task that is in progress--whether active or paused--will most likely restart the download (!!).

Aria2TUI makes use of...

  • yazi for selecting torrent files.
  • nvim for viewing/editing download options as well as adding URIs, magnet links and torrent files
  • curses for controlling the terminal display
  • listpick for the terminal user-interface
  • plotille for graphs
  • pyperclip for clipboard access

Similar Projects

  • Ariang A web client for aria2c

Support and Feedback

Feel free to request features. Please report any errors you encounter with appropriate context.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aria2tui-0.1.13.4.tar.gz (2.7 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aria2tui-0.1.13.4-py3-none-any.whl (87.4 kB view details)

Uploaded Python 3

File details

Details for the file aria2tui-0.1.13.4.tar.gz.

File metadata

  • Download URL: aria2tui-0.1.13.4.tar.gz
  • Upload date:
  • Size: 2.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for aria2tui-0.1.13.4.tar.gz
Algorithm Hash digest
SHA256 08e41b3c686b3344cc158a1cd6e611d6e2dc446ac61aa84fb64bb9b913576d2b
MD5 d3912d48cc50f64266e014d7267cbe67
BLAKE2b-256 bfbdf30502e8286b630e542b63a61bb88c627dcbcb49893aff1efb102d51e036

See more details on using hashes here.

File details

Details for the file aria2tui-0.1.13.4-py3-none-any.whl.

File metadata

  • Download URL: aria2tui-0.1.13.4-py3-none-any.whl
  • Upload date:
  • Size: 87.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for aria2tui-0.1.13.4-py3-none-any.whl
Algorithm Hash digest
SHA256 c497edd851b0a39218da04ad1096a0a4676152d211972119afd3c3920a8caf3b
MD5 d9c67c436f6960aceb7c6333566c5a23
BLAKE2b-256 c4e7f235abaf9c63fd0c9c38525756caacc131fddbda82176020227889991fdd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page