https://github.com/samwilson/mwcli
A command line client for MediaWiki wikis.
https://github.com/samwilson/mwcli
backup cli client export hacktoberfest mediawiki
Last synced: 25 days ago
JSON representation
A command line client for MediaWiki wikis.
- Host: GitHub
- URL: https://github.com/samwilson/mwcli
- Owner: samwilson
- Archived: true
- Created: 2019-06-14T23:46:01.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2025-01-28T03:08:31.000Z (3 months ago)
- Last Synced: 2025-02-23T01:36:31.309Z (2 months ago)
- Topics: backup, cli, client, export, hacktoberfest, mediawiki
- Language: PHP
- Homepage: https://mwcli.toolforge.org/
- Size: 180 KB
- Stars: 14
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
> :warning: **This project has moved** to Wikimedia's GitLab, it can be found at https://gitlab.wikimedia.org/toolforge-repos/mwcli
MediaWiki CLI
=============
A command line client for [MediaWiki](https://www.mediawiki.org/) wikis.
[](https://github.com/samwilson/mwcli/actions/workflows/ci.yml)
## About
MediaWiki CLI (or `mwcli` for short) is a multilingual cross-platform PHP command-line tool
for interacting with MediaWiki installations,
to carry out tasks such as uploading and downloading files, and exporting pages.
It is designed to operate on multiple wikis
and the configuration for these is stored in the `config.yml` file.
The wikis are usually remote from the computer on which wmcli is run,
but can also be local (i.e. it can be used on a server to perform some tasks).
The config file can be edited directly,
or via commands such as `sites:add` and `sites:modify`.
## Installation
1. Clone the repository:
```console
git clone https://github.com/samwilson/mwcli
```
2. Install dependencies:
```console
cd mwcli
composer install --no-dev
```
3. Optionally add `mwcli` to your $PATH. For example, on Linux:
```console
echo 'export PATH=$PATH:'$(pwd)/bin >> ~/.profile
```
## Upgrading
1. Update the code:
```console
cd mwcli
git pull origin main
```
2. Update dependencies:
```console
composer install --no-dev
```
## Usage
### sites:add
Add a new site to the config file.
sites:add [-c|--config [CONFIG]] [--url URL]
* `--config` `-c` — Path of the Yaml config file to use.
Default: '[CONFIG]/mwcli/config.yml'
* `--url` — The URL of the wiki. Can be to any page or even api.php.
*Required.*
### sites:info
Get general information about a wiki.
sites:info [-c|--config [CONFIG]] [-w|--wiki WIKI]
* `--config` `-c` — Path of the Yaml config file to use.
Default: '[CONFIG]/mwcli/config.yml'
* `--wiki` `-w` — The mwcli name of the wiki to use. Use sites:list to list all.
*Required.*
### sites:list
List all configured sites.
sites:list [-c|--config [CONFIG]]
* `--config` `-c` — Path of the Yaml config file to use.
Default: '[CONFIG]/mwcli/config.yml'
### sites:remove
Remove a site from the config file.
sites:remove [-c|--config [CONFIG]] [-w|--wiki WIKI]
* `--config` `-c` — Path of the Yaml config file to use.
Default: '[CONFIG]/mwcli/config.yml'
* `--wiki` `-w` — The mwcli name of the wiki to use. Use sites:list to list all.
*Required.*
### export:category
Export pages and files in a category (and its subcategories).
export:category [-c|--config [CONFIG]] [-w|--wiki WIKI] [-a|--category CATEGORY] [-d|--dest DEST]
* `--config` `-c` — Path of the Yaml config file to use.
Default: '[CONFIG]/mwcli/config.yml'
* `--wiki` `-w` — The mwcli name of the wiki to use. Use sites:list to list all.
*Required.*
* `--category` `-a` — Name of the category to export (with or without the leading 'Category:', and in any language).
*Required.*
* `--dest` `-d` — The destination directory for exported files.
Default: '[CWD]/categories'
### export:contribs
Export a user's contributions.
export:contribs [-c|--config [CONFIG]] [-w|--wiki WIKI] [-u|--user USER] [-d|--dest DEST] [-o|--only-author]
* `--config` `-c` — Path of the Yaml config file to use.
Default: '[CONFIG]/mwcli/config.yml'
* `--wiki` `-w` — The mwcli name of the wiki to use. Use sites:list to list all.
*Required.*
* `--user` `-u` — Export contributions of this username.
*Required.*
* `--dest` `-d` — The destination directory for exported files.
Default: '[CWD]/contribs'
* `--only-author` `-o` — Export only where the given user is the original author of a page.
### export:wikitext
Export a wiki's pages as text files.
export:wikitext [-c|--config [CONFIG]] [-w|--wiki WIKI] [-d|--dest DEST] [-e|--ext EXT]
* `--config` `-c` — Path of the Yaml config file to use.
Default: '[CONFIG]/mwcli/config.yml'
* `--wiki` `-w` — The mwcli name of the wiki to use. Use sites:list to list all.
*Required.*
* `--dest` `-d` — The destination directory for exported files.
Default: '[CWD]/wikitext'
* `--ext` `-e` — File extension to use for the exported files.
Default: 'txt'
### extension:install
Install an extension into a local wiki. Requires 'install_path' to be set in a site's config.
extension:install [-c|--config [CONFIG]] [-w|--wiki WIKI] [-g|--git] [-u|--gituser GITUSER] [--]
* `--config` `-c` — Path of the Yaml config file to use.
Default: '[CONFIG]/mwcli/config.yml'
* `--wiki` `-w` — The mwcli name of the wiki to use. Use sites:list to list all.
*Required.*
* `--git` `-g` — Use Git to install the extension, instead of the default tarball method.
* `--gituser` `-u` — The username to use for Git. Implies --git
*Required.*
* `` The extension's name (CamelCase, with underscores for spaces).
### extension:outdated
Shows a list of installed extensions that have updates available, including their latest version.
extension:outdated [-c|--config [CONFIG]] [-w|--wiki WIKI]
* `--config` `-c` — Path of the Yaml config file to use.
Default: '[CONFIG]/mwcli/config.yml'
* `--wiki` `-w` — The mwcli name of the wiki to use. Use sites:list to list all.
*Required.*
### upload:files
Upload local files to a wiki.
upload:files [-c|--config [CONFIG]] [-w|--wiki WIKI] [-m|--comment COMMENT] [--] [...]
* `--config` `-c` — Path of the Yaml config file to use.
Default: '[CONFIG]/mwcli/config.yml'
* `--wiki` `-w` — The mwcli name of the wiki to use. Use sites:list to list all.
*Required.*
* `--comment` `-m` — Revision comment.
*Required.*
* `` Filenames of files to upload.
### upload:pages
Upload local text files as wiki pages.
upload:pages [-c|--config [CONFIG]] [-w|--wiki WIKI] [-m|--comment [COMMENT]] [-t|--watch] [--]
* `--config` `-c` — Path of the Yaml config file to use.
Default: '[CONFIG]/mwcli/config.yml'
* `--wiki` `-w` — The mwcli name of the wiki to use. Use sites:list to list all.
*Required.*
* `--comment` `-m` — Revision comment.
* `--watch` `-t` — Keep watching the files and upload on any change.
* `` Directory from which to import wiki pages.
## License: MIT
Copyright 2019 Sam Wilson.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software
and associated documentation files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or
substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.