a Wikimedia CLI guides

Explore Wikimedia data, work with services, and develop MediaWiki. Examples use the default command name, mw; the same commands work as wm when that is your executable’s name.

Read these guides offline with mw help guides; for example, mw help guides dev setup. Add --web to open a guide on MediaWiki.org. Bundled guides match your installed release.

Get started

• Install the CLI
• Keep it up to date
• Store credentials and use password managers

Wikimedia data

• Explore pageviews as a graph, JSON or CSV

Development environments

• Create an environment
• Choose a context
• Change the HTTP port
• Manage services and images
• Browse local logs
• Build custom service images
• Add custom Compose services
• Configure MediaWiki
• Configure login with Keycloak
• Add an extension, configure it and run its tests
• Work with MediaWiki and debug PHP
• Update MediaWiki checkouts safely
• Use databases
• Import and export MySQL dumps
• Debug PHP with Xdebug
• Run browser tests and record videos
• Use the gateway, dashboard and tunnels
• Troubleshoot an environment

Code and collaboration

• Work with GitLab
• Upload files and new versions
• Run a demo pod on Toolforge

Command reference

Browse all commands and options. The reference is generated from the CLI; guides explain workflows across commands.

These guides can also be edited on the wiki. Corrections are reviewed before the next release and can be brought back into the repository.

---

Read this guide offline with mw help guides.

Adapted from MediaWiki.org under CC BY-SA 4.0; see the linked page history for contributors.