Command Line
Run aniworld --help for the current built-in reference and aniworld --examples for longer examples.
Common commands
# Interactive terminal menu
aniworld
# Start the Web UI
aniworld -w
# Download one URL without the menu
aniworld --no-menu "URL"
# Download every URL in a text file
aniworld --episode-file episodes.txt --no-menuURLs may point to a supported series, season, episode, movie, or manga title. What is accepted depends on the site.
The CLI normalizes supported URL aliases before choosing and constructing a model. SerienStream links such as /serie/stream/SLUG work as /serie/SLUG, and Moflix browser links with title slugs are converted to the backend's canonical form. Episode selectors in query parameters or fragments are preserved. See supported inputs.
Only AniWorld and SerienStream series URLs open the episode-selection menu. Season and episode URLs, and other sites, run the requested action directly. Use --no-menu for multiple positional URLs; without it, only the first is used unless --episode-file is supplied. Episode files append their nonblank lines to any positional URLs and process them directly.
Choose the action
aniworld --no-menu --action Download "URL"
aniworld --no-menu --action Watch "URL"
aniworld --no-menu --action Syncplay "URL"Download is the default. Watch opens the configured player and Syncplay starts a synchronized room. MangaFire provides downloads only.
The terminal menu hides Watch and Syncplay when ANIWORLD_MENU_DOWNLOAD_ONLY=1, as set by the Docker image. Its Save Location starts from ANIWORLD_DOWNLOAD_PATH, with ~ expanded and relative paths based on your home directory. This menu setting does not restrict explicit CLI actions.
Choose language and provider
aniworld --no-menu \
--language "German Dub" \
--provider VOE \
"URL"Languages are German Dub, English Dub, English Sub, and German Sub. Not every title offers every language.
The selected provider is tried first. If it fails, the configured fallback order is used for providers available in the selected language. The downloader does not automatically choose another language.
Adult-site backends
Hanime, HentaiTV, AnimeIDHentai, and HentaiHaven support direct CLI downloads:
aniworld --no-menu "https://hanime.tv/videos/hentai/reika-wa-karei-na-boku-no-joou-4"
aniworld --no-menu "https://animeidhentai.com/inaka-ni-wa-kore-kurai-shika-goraku-ga-nai-episode-1"
aniworld --no-menu "https://hentaihaven.xxx/watch/ane-wa-yanmama-junyuu-chuu/"
aniworld --no-menu "https://hentai.tv/hentai/hamehara-sore-sekuhara-desu-episode-1-p83"Hanime video URLs download the selected video, like other episode URLs. Use HanimeTVSeries through the Python API to process the whole franchise. Hanime also has a Web UI tab, disabled by default; enable it with ANIWORLD_ENABLE_HTV=1. Its episode model defaults to Japanese and the HanimeTV provider.
HentaiTV and HentaiHaven also have optional Web UI search and download tabs, enabled with ANIWORLD_ENABLE_HENTAITV=1 and ANIWORLD_ENABLE_HENTAIHAVEN=1. AnimeIDHentai supports CLI and Python only. HentaiHaven title URLs process the title's episodes; HentaiTV and AnimeIDHentai accept episode URLs. These three models default to English Sub and use their own site provider. That preset describes the model's stream selection. HentaiTV and AnimeIDHentai do not fetch separate subtitle files. HentaiHaven fetches an English WebVTT track when its master playlist provides one and muxes it into MKV/MP4 files that lack an English subtitle track. Missing tracks or subtitle-processing errors leave the video without that added track; repeating the download retries missing subtitles without downloading the video again or duplicating an existing English track. Do not assume every saved video contains subtitles.
All four backends offer keyword search through the Python API. Hanime, HentaiTV, and HentaiHaven also support search in their Web UI tabs; there is no dedicated CLI search flag for these sites.
Useful options
| Option | Purpose |
|---|---|
-nm, --no-menu | Process URLs directly |
-a, --action | Download, Watch, or Syncplay |
-l, --language | Select the audio and subtitle preset |
-p, --provider | Select the preferred stream hoster |
-o, --output | Set the download location |
-f, --episode-file | Read one URL per line from a file |
-sk, --aniskip | Skip detected intros and outros during playback |
-kw, --keep-watching | Continue from an episode URL through the rest of its season |
-r, --random-anime | Pick a random AniWorld title |
-sto, --use-sto-search | Prefer SerienStream in interactive search |
-A, --anime4k | Install High or Low shaders, or Remove them |
-d, --debug | Show detailed logs |
Web UI options
| Option | Purpose |
|---|---|
-w, --web-ui | Start the Web UI |
-wP, --web-port | Change port 8080 |
-wN, --no-browser | Do not open a browser automatically |
-wE, --web-expose | Listen on every network interface |
-wA, --web-auth | Enable local accounts |
-wS, --web-sso | Enable OIDC alongside --web-auth |
-wFS, --web-force-sso | Allow only OIDC login |
Syncplay options
aniworld --no-menu --action Syncplay \
--syncplay-host syncplay.pl:8998 \
--syncplay-room "Movie Night" \
--syncplay-username "Alex" \
"URL"When no room is supplied, AniWorld Downloader creates one from the episode filename. AniWorld and SerienStream use the original seasonal episode number for this name so title-based download numbering and existing filenames share the same room. --syncplay-password hashes that filename with your value to derive the room name; it does not authenticate to the Syncplay server and is ignored with an explicit room. See Syncplay configuration for the environment settings.
Direct provider URL
Use this only when you already have a provider page URL:
aniworld --provider VOE --provider-url "https://voe.sx/e/example"The media is written to input.mkv in the configured download folder, which is created if needed. This uses the shared download-root rules: ANIWORLD_DOWNLOAD_PATH=Downloads means ~/Downloads, and an unset or blank value also defaults to ~/Downloads. --output overrides that setting and keeps CLI path semantics.
Paths and output formats
aniworld --no-menu --output "/path/to/downloads" "URL"Quoted home paths work too: --output "~/Videos" uses your home directory, as does --episode-file "~/urls.txt". Relative arguments such as --output "./downloads" or --episode-file "urls.txt" use the current working directory. See path configuration for the different rules used by environment settings and Python model paths.
Use the naming template to control folders, filenames, and the MKV/MP4 extension. ANIWORLD_VIDEO_CODEC=copy preserves the original streams without re-encoding. Direct HTTP downloads, including HentaiTV and AnimeIDHentai, copy the source video regardless of the encoding preference. Multi-language muxing examples are available in the repository's AniWorld examples and SerienStream examples.
MangaFire downloads
Choose JPG, CBZ, or EPUB in the download dialog, or set ANIWORLD_MANGAFIRE_FORMAT (default jpg). EPUB requires the optional aniworld[epub] extra; JPG and CBZ need no extra.
JPG saves chapter images. Title downloads create one CBZ or EPUB per available English volume, falling back to chapters when volume grouping is unavailable. Explicit chapter downloads remain chapter files. Changing format in the Web UI resets page selections.
EPUB pages remain images; WebP is converted to PNG. Repeated archive downloads reuse valid pages and preserve previously saved unselected pages. Open saved manga in an external reader; the Web UI Library has no manga reader. See the Python API or HTTP API for page selection.
Standalone chapters, pages and archives use the manga title beneath the chosen root. Direct chapter URLs support both ID-only and slugged title forms; see the Python API for chapter objects and destination options. Download-dialog page markers currently recognize loose images only, not pages already stored inside CBZ/EPUB archives.
Playback enhancements
--aniskip uses available AniSkip timing data to skip openings and endings. It depends on matching metadata and timing availability; it is not a universal skip detector for every site.
--anime4k High, --anime4k Low, and --anime4k Remove manage the Anime4K shaders used for playback. They do not upscale the saved video file. Choose the shader level according to your playback hardware. This option configures shaders and then continues with the selected action; it does not exit. Combine it with a Watch/Syncplay URL, or expect the normal interactive flow when no URL is supplied.
Automating commands
Use --no-menu with URLs or an episode file when no interactive selection is wanted. Site captchas may still require interaction. The HTTP API is an alternative for scripts that should submit work to an already-running Web UI queue.
