Command Line Options

The following options are available to aria2r. Each option can be provided at the command line as shown, or in the configuration file without the -- prefix.

-C, --config <config>

Alternate path to a configuration file.

(Default: $XDG_CONFIG_HOME/aria2r/config)

<urls> [<url> ...]

One or more urls to a file. All given urls must be mirrors to the same file and be http/https protocol. Torrent, Magnet, and Metalink files are not supported.

Warning

It is mandatory to supply either urls or the --input_file argument, but it is an error to provide both.

-i, --input_file <input_file>

Path to an aria2c formatted input file. Use this to add multiple downloads.

Warning

It is mandatory to supply either urls or the --input_file argument, but it is an error to provide both.

--dry-run

Read the input file or urls and build the request, but don’t send it to the aria2 instance. This supercedes the aria2c option of the same name. A separate option --dry-run-aria2c is available for sending the dry run option to the running aria2c instance.

--dry-run-aria2c

Add the dry-run option to all downloads in aria2c. This is the replacement for the standard --dry-run option which is used by aria2r.

--host <host>

The ip or fully qualified domain name where aria2 is located.

(Default: localhost)

--port <port>

The port that aria2 listens on.

(Default: 8600)

--rpc-secret <rpc-secret>

Secret authorization token expected by the running aria2 rpc interface. This is the only authorization method supported by aria2r as rpc-user/rpc-passwd have been deprecated.

(Default: “”)

-v, --verbose

Increase level of output.

-q, --quiet

Decrease level of output.

Passing Options to aria2

All of the normal command line options for aria2c are available in aria2r. For instance, you can provide the --http-user/--http-passwd for downloads behind basic auth. Or you can use the -d or --dir option to change the download location.

In the case of adding a single download as part of the aria2r command, these options are simply applied to that download.

In the case of adding downloads through an input file, any aria2c options provided through the comand line will be applied to all downloads in the current batch. To use an option against only some of the downloads (such as --out or if only some of the downloads require authentication), you will need to add each option to their respective download in the input file.