Skip to content
fandom

Quick start

Run your first fandom commands.

Once fandom is on your PATH:

fandom version

Pick a wiki

Every command takes --wiki to select a wiki by its subdomain slug. The default is starwars.

fandom --wiki minecraft info        # wiki metadata
fandom --wiki harrypotter info
fandom --wiki onepiece info
fandom --wiki starwars search "lightsaber"
fandom --wiki minecraft search "creeper" -n 5
fandom --wiki starwars top
fandom --wiki minecraft top -n 10
fandom --wiki starwars list --offset 0 -n 25

Fetch a full article

The page command returns everything the MediaWiki API knows about a page: wikitext, rendered Markdown, categories, images, internal and external links, templates, infobox fields, thumbnail, last editor, and word count.

fandom --wiki starwars page "Luke Skywalker" -o json | jq .categories
fandom --wiki starwars page "Lightsaber" -o json | jq .infobox_fields
fandom --wiki starwars page "Death Star" --no-wikitext -o json

Enumerate all pages

allpages streams every page stub in namespace 0. Without --limit it paginates to completion.

fandom --wiki minecraft allpages | wc -l
fandom --wiki starwars allpages -n 100 -o jsonl > stubs.jsonl

Revisions and site stats

fandom --wiki starwars revisions "Luke Skywalker" -n 20
fandom --wiki minecraft siteinfo
fandom --wiki starwars recent -n 30

Discover wikis

fandom wikis --search "one piece"
fandom wikis --hub Anime
fandom wikis --hub Gaming -n 20

Output formats

Every command defaults to a table on a terminal and JSONL in a pipe. Switch with -o:

fandom --wiki starwars search "yoda" -o json
fandom --wiki minecraft allpages -o jsonl | jq .title
fandom --wiki starwars top -o csv > top.csv

Where to go next