Wikidata-CLI

The Command-line interface interface to Wikidata

This project is funded by a Wikimedia Project Grant.

Summary

• Dependencies
  • General
  • Per feature
• Installation
  • Via NPM
  • Via Docker
• Commands
  • Read operations
  • Write operations
  • Config
• See Also
• You may also like
• License

Dependencies

General

• NodeJs >= v6.4.0 (recommended way to install it: use the awesome NVM)
• Git

Per feature

• to use the clipboard option: see copy-paste dependencies

Installation

via npm

npm install -g wikidata-cli

Installing globally allows to make the command wikidata-cli and its alias wd accessible from your shell $PATH

via docker

# Might require to be run with sudo depending on your Docker installation 
docker run --rm -t maxlath/wikidata-cli
# You can make an alias out of it: 
alias wd="docker run --rm -t maxlath/wikidata-cli"
# You're then ready to use it as in the documentation examples 
wd label Q1

That would work, but all operations using cached data (such as the list of all properties) would need to re-fetch those data for each operations, and all operations editing Wikidata would require you to enter your username and password everytime. To work around this, you can allow this container to persist some files on your system, using shared volumes:

mkdir -p $HOME/.local/share/wikidata-cli
alias wd='docker run --rm --volume "$HOME/.local/share/wikidata-cli:/wikidata-cli/local" -t maxlath/wikidata-cli'

NB: Beware that using wikidata-cli through a Docker container has a performance cost of something like 1s per command, so if you need to run many commands (for instance in a script to mass edit Wikidata), you should probably rather use the NPM package directly for long series of commands

Commands

Read operations

see Read operations

Write operations

see Write operations

Config

Allows to persist options

see Config

See Also

• wikidata-sdk: A javascript tool suite to query and work with Wikidata data, heavily used by wikidata-cli
• wikidata-edit: Edit Wikidata from NodeJS, used in wikidata-cli for all write operations
• wikidata-filter: A command-line tool to filter a Wikidata dump by claim
• wikidata-subset-search-engine: Tools to setup an ElasticSearch instance fed with subsets of Wikidata
• wikidata-taxonomy: A command-line tool to extract taxonomies from Wikidata
• import-wikidata-dump-to-couchdb: Import a subset or a full Wikidata dump into a CouchDB database
• Other Wikidata external tools

You may also like

Do you know inventaire.io? It's a web app to share books with your friends, built on top of Wikidata! And its libre software too.

License

MIT