Skip to content

Usages

Jump to bottom
fumi edited this page Mar 12, 2023 · 2 revisions

Overview

This application contains following commands:

Downloading commands

  • get - This command allows you to download a single gallery.
  • recommend - This command allows to download a recommended galleries of a certain gallery.
  • search - This command allows you to search for galleries.
  • random - This command allows you to randomly pick a gallery.
  • file - This command allows you to bulk download galleries from a text file.
  • series - This command allows you to construct series from list of galleries.

Configuration commands

  • cookie - This command allows you to set cookies and browser user agent.
  • config - This command allows you to configure things such as using a tachiyomi style folder layout

In-depth Usages

get command

Supported options for get are:

  -r, --readonly    (Default: false) View the information only
  -i, --input       Required. Input Numeric Code
  -p, --pack        (Default: false) Pack downloaded gallery into single CBZ archive
  -o, --output      Destination path for gallery download

In this command, --input is required, you are only allowed to put list of numeric gallery IDs. Full URL is not supported and unnecessary.

Examples:

Perform a metadata view only (no download):

asuka get -i 1 -r

Perform a download with multiple galleries:

asuka get -i 1 2 3 4 5 6 7 8 9

The difference between series and get is that get command does not group downloads together into single folder while series does.

Download a gallery with compressing to cbz:

asuka get -i 1 --pack

Download a gallery specifying to put it in a specific folder:

asuka get -i 1 -o /tmp/

recommend command

Supported options for recommend are:

  -p, --pack      (Default: false) Pack downloaded gallery into single CBZ archive
  -o, --output    Destination path for gallery download
  -i, --input     Required. Input Numeric Code

In this command, --input is required, you are only allowed to put numeric gallery IDs. Full URL is not supported and unnecessary.

After entering the command, you'll be presented 5 galleries in a list you can pick from. Use spacebar to select and arrow keys to navigate through them. After selection, you can press Enter key to start the download.

Examples:

Download a gallery with compressing to cbz:

asuka recommend -i 1 --pack

Download a gallery specifying to put it in a specific folder:

asuka recommend -i 1 -o /tmp/

search command

Supported options for search command are:

  -q, --queries      Search queries.
  -e, --exclude      Exclude something on search.
  --page             Required. (Default: 1) Page to view its contents
  -d, --dateRange    Specify uploaded date to search
  --pageRange        Specify page range of the gallery
  --sort             (Default: date) Sort options
  -p, --pack         (Default: false) Pack downloaded gallery into single CBZ archive
  -o, --output       Destination path for gallery download

In this command, you can specify search queries in --queries option and each query can be separated in spaces (see examples). To add excluions, you can use --exclude option and each exclusion can be separated in spaces as well. This requires --page to be specified.

To further refine searches, you can use --dateRange to specify intervals of upload date and --pageRange to specify range of pages. You can specify --sort to sort search results.

--dateRange and --pageRange can be specified by specifying ranges separated in spaces and allows use range operators (such as >, >=, < and =<) (ex. --dateRange >2d <5d and --pageRange >20 =<50).

--dateRange requires specific units of time:

Unit Value
h hours
d days
w weeks
m months
y years

--sort requires following values:

Sort Description
date Sorts result from newest to oldest.
popular-week Sorts result from most popular to less popular (Weekly)
popular-today Sorts result from most popular to less popular (Today)
popular Sorts result from most popular to less popular

Additionally, you can use much more specific target by specifying tag types on --queries and --exclude:

Filter Type Description Examples
category string Specify the manga category category:manga
artist string Specify artist to filter artist:artistname
parody string Specify parody of the manga parody:"parody with spaces"
tag string Specify a tag tag:sometag
character string Specify a character in the manga character:somecharactername
language string Specify language of the manga language:somelanguage
group string Specify the group (or circle) of the manga group:somegroupname

Examples:

Download a gallery by specifying a artist and parody:

asuka search -q artist:artist1 parody:"some parody name" --page 1

Download a gallery by specifying a tag but excludes a artist:

asuka search -q sometag -e artist:artist2 --page 1

Download a gallery by specifying a tag and only pages in between 20 and 50:

asuka search -q sometag --pageRange >20 <50 --page 1

Download a gallery by specifying a tag with more than 50 pages:

asuka search -q sometag --pageRange >50 --page 1

Download a gallery by specifying only galleries under a year:

asuka search --dateRange <1y --page 1

Download a gallery with all filtering options:

asuka search -q sometag -e language:english --pageRange >20 --dateRange >1w <=2w --sort popular-today --page 1

random command

Supported options for random command are:

  -p, --pack      (Default: false) Pack downloaded gallery into single CBZ archive
  -o, --output    Destination path for gallery download

In this command, you'll be prompted for a random gallery. Press N to find other and Y to start downloading.

file command

Supported options for file command are:

  -f, --file      Required. Path to text file to read.
  -p, --pack      (Default: false) Pack downloaded gallery into single CBZ archive
  -o, --output    Destination path for gallery download

In this command, you'll only require --file option which points to a text file containing full gallery URLs separated by a new line.

Example:

Download a file from a text file name sample.txt:

asuka file -f ./sample.txt

Notes

This has limitation of 5MB in size. Who needs that anyways?

series command

Supported options for series command:

  -a, --array     Required. Create a seres from series of ids
  -p, --pack      (Default: false) Pack downloaded gallery into single CBZ archive
  -o, --output    Destination path for gallery download

In this command, Tachiyomi folder layout is enabled by default to group them into chapters. It requires --array option which each IDs are separated by spaces. This assumes that the IDs you entered are sorted in order.

Example:

Create a series from series of IDs:

asuka series -a 1 2 3 4 5 6

config command

Supported option for config are:

  -s, --set      Set value
  -r, --read     Read configuration
  -l, --list     List all configuration values
  -k, --key      Configuration to set/read
  -v, --value    New value
  --reset        Reset configuration values

In this command, you can specify set values by specifying --set option first which then requires --key and --value to set a value. Use --list option to list all configured values and --read to read a specific key by using --key option.

Key and Value are case-sensitive.

Configuration Default Values

Key Default Value Supported Values Description
color.theme dark light, dark Change text color according to theme.
layout.tachiyomi yes yes, no Use tachiyomi local folder layout in every download
tui.progress. progress progress, text, stealth Change progress indicator during downloads

cookie command

Supported option for cookie are:

  -c, --cookie       Required. Read cookies from a text file dump
  -u, --userAgent    Required. Set user agent

Before you can download/use this application, you are required to configure your cookies and user agent first due to a recent change which the site now uses Cloudflare to protect against DDoS attacks or sorts.

To export cookies, you can use cookie exporter add-ons or extensions in your browser. I recommend using EditThisCookie.

To export your cookies using that extension, you can go to the site first and then open the plugin. Use export button to export all cookies and paste them into text file and save. And then find your browser agent and finally configure it:

asuka cookie -c <your cookie text file> -u "your browser agent"
Clone this wiki locally