nyora-cli — command-line manual

nyora-cli is the independent Nyora command-line tool. It drives the same embedded JavaScript parser runtime as the library — no helper required — through a small subcommand tree, and it doubles as the launcher for the interactive terminal reader (TUI).

The nyora binary is an alias for nyora-cli.

Install

npm install -g nyora     # global: puts `nyora-cli` (and `nyora`) on PATH
Copy

Or run without installing:

npx nyora sources
Copy

Usage

nyora-cli [--json] <command> [options]
nyora-cli                         launch the interactive terminal reader (TUI)
Copy

Running nyora-cli with no subcommand launches the TUI. With a subcommand it runs that command and exits.

Global options

Option	Effect
--json	Emit raw JSON instead of pretty text. Place it before the subcommand.
-h, --help	Print usage and exit 0.

-s/--source accepts a source id or a fuzzy name (e.g. asura, mangadex).

Commands

sources — list or filter sources

nyora-cli sources [--search Q]
Copy

Flag	Meaning
--search Q	Keep only sources whose id or name contains Q (case-insensitive).

nyora-cli sources
nyora-cli sources --search asura
nyora-cli --json sources                 # array of Source objects
Copy

Text output is id<TAB>name<TAB>lang, ending with a (N sources) count.

search — search a source

nyora-cli search -s SRC [-p N] <query>
Copy

Flag	Meaning
-s, --source	Required. Source id or fuzzy name.
-p, --page	Page number (default 1).

nyora-cli search -s asura "Solo Leveling"
nyora-cli search -s mangadex -p 2 "Frieren"
nyora-cli --json search -s asura "Solo Leveling"
Copy

popular — popular manga from a source

nyora-cli popular -s SRC [-p N]
Copy

nyora-cli popular -s mangadex
nyora-cli popular -s mangadex -p 3
Copy

latest — latest updated manga

nyora-cli latest -s SRC [-p N]
Copy

nyora-cli latest -s mangadex
Copy

search, popular, and latest print a numbered list of title<TAB>url, then (N entries[, more available]). With --json they print a SearchPage.

details — manga details and chapters

nyora-cli details -s SRC <url>
Copy

nyora-cli details -s mangadex "https://mangadex.org/title/<id>"
nyora-cli --json details -s mangadex "<manga-url>"
Copy

Text output prints the title, authors, state, description, and a numbered chapter list. JSON output is a MangaDetails ({ manga, chapters }).

pages — chapter page image URLs

nyora-cli pages -s SRC [--branch B] <url>
Copy

Flag	Meaning
--branch B	Select a scanlation branch/translation.

nyora-cli pages -s mangadex "<chapter-url>"
nyora-cli pages -s mangadex --branch "English" "<chapter-url>"
nyora-cli --json pages -s mangadex "<chapter-url>"     # array of MangaPage
Copy

download — save a chapter as a .cbz archive

nyora-cli download -s SRC [--branch B] [-o OUT] <url>
Copy

Flag	Meaning
-o, --out OUT	Output path (~ is expanded). If it ends in .cbz it is used as the file; otherwise it is treated as a directory that will contain <chapter-slug>.cbz. Default: <chapter-slug>.cbz in the current directory.
--branch B	Select a scanlation branch/translation.

Downloads the chapter and writes a single CBZ archive — a standard Comic Book ZIP readable by any comic reader (e.g. YACReader, CDisplayEx, Kavita) and by the Nyora apps. The archive holds the page images in reading order, named zero-padded with their original extension (001.jpg, 002.webp, …, inferred from the URL or Content-Type). Images are already compressed, so the ZIP uses the store method; there is no extra dependency.

The chapter slug is derived from the last path segment of the chapter URL.

# default: writes <chapter-slug>.cbz in the current directory
nyora-cli download -s mangadex "<chapter-url>"

# -o as a directory: writes <chapter-slug>.cbz inside it
nyora-cli download -s mangadex -o ./out "<chapter-url>"

# -o as a file: writes exactly that .cbz
nyora-cli download -s mangadex -o "~/Comics/frieren-ch1.cbz" "<chapter-url>"

# machine-readable result
nyora-cli --json download -s mangadex "<chapter-url>"   # { file, pages, total }
Copy

Representative output:

Saved 18/18 pages to /home/you/out/chapter-1.cbz
Copy

{ "file": "/home/you/chapter-1.cbz", "pages": 18, "total": 18 }
Copy

The download uses each page's required headers (e.g. Referer) automatically. Pages that fail to fetch are reported on stderr and skipped; the command exits 0 if any page was packed into the archive, 1 if none could be downloaded.

update — apply OTA parser updates

nyora-cli update [--force]
Copy

Flag	Meaning
--force	Re-download and reload even if already current.

nyora-cli update
nyora-cli update --force
nyora-cli --json update           # { updated, version, bundlePath, sourcesPath }
Copy

serve — run the helper-compatible REST server

nyora-cli serve [--host H] [--port N]
Copy

Flag	Meaning
--host H	Bind interface (default 127.0.0.1).
--port N	Bind port; 0 picks a free port (default 0).

nyora-cli serve                       # ephemeral port on loopback
nyora-cli serve --host 0.0.0.0 --port 8787
nyora-cli --json serve                # { "baseUrl": "http://127.0.0.1:54123" }
Copy

Prints the base URL, writes a helper.port discovery file, and runs until Ctrl+C (SIGINT/SIGTERM). See the Server guide for the endpoint table and a worked attach example.

version — show package and OTA versions

nyora-cli version
Copy

nyora-cli version
nyora-cli --json version          # { package: "0.1.0", ota: 7 }
Copy

Prints the package version and the installed OTA parser version (bundled when no update has been applied yet).

Exit codes

Code	Meaning
0	Success (or --help, or a clean TUI exit / non-TTY notice).
1	A handled error: missing/invalid flag, no results to download, or an SDK/parser failure. Printed as error: <message> on stderr (no stack trace).
2	Unknown command (usage is printed on stderr).

Recipes

Find a source, then browse it, as JSON for a script:

SRC=$(nyora-cli --json sources --search asura | node -pe 'JSON.parse(require("fs").readFileSync(0)).at(0).id')
nyora-cli --json popular -s "$SRC"
Copy

Search → details → pages, piping JSON through jq:

nyora-cli --json search -s mangadex "Frieren" | jq -r '.entries[0].url'
nyora-cli --json details -s mangadex "<manga-url>" | jq -r '.chapters[0].url'
nyora-cli --json pages   -s mangadex "<chapter-url>" | jq -r '.[].url'
Copy

Download the first chapter of a search hit as a .cbz (shell glue):

URL=$(nyora-cli --json search -s mangadex "Frieren" | jq -r '.entries[0].url')
CH=$(nyora-cli --json details -s mangadex "$URL" | jq -r '.chapters[0].url')
nyora-cli download -s mangadex -o ./frieren "$CH"            # writes ./frieren/<slug>.cbz
FILE=$(nyora-cli --json download -s mangadex "$CH" | jq -r '.file')   # capture the .cbz path
Copy

Keep parsers fresh in CI before a scripted run:

nyora-cli update && nyora-cli --json sources | jq 'length'
Copy

When stdout is not a TTY (piped, redirected, CI), running bare nyora-cli does not start the TUI — it prints a short friendly notice and exits 0. Use the subcommands above for scripting.