Wikidata-CLI

Command-line tools to make working with wikidata zuper easy.
For most, those tools are just wikidata-sdk functions wrapped for the command-line needs.

• Dependencies
• Installation
• Commands
  • wd label
  • wd claims
  • wd data
  • wd wikiqid
  • wd props
  • wd sparl
  • wd open
• Pre-2.0.0 API
• See Also
  • wikidata-filter
  • wikidata-agent
  • wikidata-taxonomy

• NodeJs (recommended way to install it: use the awesome NVM)

npm install -g wikidata-cli

Installing globally allows to make the command wd accessible from your shell $PATH

Working with Wikidata, we often end up with obscure ids. We can always look-up those ids labels on the website but that means loading pages and pages, when a small API call and parsing could return just what we need: a label

wd label Q1103345
# => The Cluetrain Manifesto

By default, the result uses your environment local language (process.env.LANG), but we can pass a 2-letters language code as second argument

wd label Q1103345 de
# => Cluetrain-Manifest

A quick way to access the claims of an entity

# all Q2001's claims
wd claims Q2001
# or just his place of birth
wd claims Q2001 P19
# or by specifying another language than your local language
wd claims Q2001 fr
wd claims Q2001 P19 fr

A quick way to access an entities data

wd data Q1496

This simply outputs the result of https://www.wikidata.org/w/api.php?action=wbgetentities&format=json&ids=Q1496, parsed to keep only what is relevant to the requested entity (here Q1496). The output is valid json, so it lets you the possibility to pipe it to a JSON parser such as jsondepth:

wd data Q1496 | jd labels.pt
# => { language: 'pt', value: 'Fernão de Magalhães' }

This one is kind of the inverse of qlabel: pass it the title of a Wikipedia article and it will return the corresponding Wikidata id

wd wikiqid Cantabria
# => Q3946
wd wikiqid New Delhi
# => Q987

Options

• -l, --lang: specify from which language the title comes By default, it will look at the Wikipedia corresponding to your environment local language (process.env.LANG), but you can specify another language by passing a 2-letters language code

wd wikiqid -l fr science politique
# => Q36442

You can also pass it full Wikipedia urls and let it find the language from there

wd wikiqid https://en.wikipedia.org/wiki/Friedrich_Nietzsche
# => Q9358

A command to access the list of all Wikidata properties in a given language (by default the environment local language)

• Get the list of all Wikidata properties in your environment local language:

wd props

Output a JSON object of the kind:

[...]
  "P2897": "identifiant Eldoblaje Movie",
  "P2898": null,
  "P2899": "âge minimal",
[...]

NB: properties without a label in the requested language are set to null, as you can see above for P2898 in French

• Get the list of all Wikidata properties in another language Options
• -l, --lang: specify the properties labels language

wd props -l sv
# outputs the properties in Swedish

This command first tries to find the list in the props folder (created at wikidata-cli root), and request them to query.wikidata.org if missing.

This means that after a while, your local version will miss new and updated properties: this can be solved by using the --reset options

Options

• -r, --reset: clear properties cache

A command to run a SPARQL query and get its JSON output

From this SPARQL query file: ./path/to/query.rq

SELECT ?work WHERE {
  ?work wdt:P50 wd:Q42 .
}

get its output from your terminal like so:

wd sparql ./path/to/query.rq > ./results.json

Options

• -s, --simplify: output the results simplifed by wikidata-sdk simplifySparqlResults function

wd sparql -s ./path/to/query.rq > ./simplified_results.json

A command to open an entity's or property's page on Wikidata in a browser (yep, you can be that lazy)

wd open Q123
# opens https://wikidata.org/wiki/Q123 in your default browser

wd open P659
# opens https://www.wikidata.org/wiki/Property:P659

# also working with any string that matches /(Q|P)\d+/
wd open https://inventaire.io/entity/wd:Q33977
# opens https://wikidata.org/wiki/Q33977

Options

• -p, --wikipedia: open the Wikipedia article instead

wd open -p Q123
# opens https://fr.wikipedia.org/wiki/Septembre because my system language is French

• -l, --lang: specify which Wikipedia edition should be targeted

wd open -p -l sv Q123
# opens https://sv.wikipedia.org/wiki/September instead

###qlabel Renamed wd label ###qclaims Renamed wd claims ###qdata Renamed wd data ###wdprops Renamed wd props ###wikiqid Renamed wd wikiqid ###wdsparql Renamed wd sparql ###wdsparqlsimplify Removed: use wd sparql --simplify

Commands that got their own modules:

a command-line tool to filter a Wikidata dump by claim

a small server to edit Wikidata from the terminal: curl -X POST http://localhost:4115/claim -d 'entity=Q4115189&property=P2002&value=Zorg'

command-line tool to extract taxonomies from Wikidata

MIT