mwutil

A CLI tool which helps managing MediaWiki development environments.

Note

This tool is specifically built to work with mw-dev-kit and will not work in other development environments.

Installation

Requirements:

• uv
• for autocompletion: bash or zsh

Either use uv tool install git+https://github.com/SomeMWDev/mwutil, or clone and install the tool manually:

cd /path/to/mwutil
uv tool install . -e

Enabling mwutil in a dev environment

echo "{}" > /path/to/basedir/.mwutil.json

Autocompletion

Bash:

uv tool install argcomplete
activate-global-python-argcomplete
echo 'eval "$(register-python-argcomplete mwutil)"' >> ~/.bashrc
source ~/.bashrc

Zsh:

uv tool install argcomplete
activate-global-python-argcomplete
echo 'eval "$(register-python-argcomplete mwutil)"' >> ~/.zshrc
source ~/.zshrc

Features

Creating a new dev environment

1. Go to a folder where you want to create the new environment (it will create a subfolder there).
2. Run mwutil init
3. Follow the instructions

Database dumps

Dumps will be stored in a subdirectory of the basedir, which can be configured via the dumpdir option in the JSON config. The default is dumps.

Create a dump:

mwutil dump create test

Delete a dump:

mwutil dump delete test

Import a dump:

mwutil dump import test