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.2.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.2-py3-none-any.whl (87.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aria2tui-0.1.13.2.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.2.tar.gz
Algorithm Hash digest
SHA256 b8ef707888020dac4524b29900511383b7da355fcb5aa3d87a0565b48d2291be
MD5 0c6cddcafd9f443cc2b19e698ef01a42
BLAKE2b-256 9219bf4b739c126993f5b6984db5b06edf0b5e9410693515465b27ff09c42d56

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aria2tui-0.1.13.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 615b6847473c76d74daf70b1ea8f23f923cbb418187057280f1f03bb73e8602c
MD5 6f5b5073c14af9c347397b0fe8d40cda
BLAKE2b-256 0ff0e9f3d024b19c51952787f5587b7e7d01c57fd07950b2ae45fdc6ce218082

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