Wikipedia:WPCleaner/Installation

icon WPCleaner – 2.05 (August 26, 2022 (2022-08-26)) [±]
icon WPCleaner

General information about WPCleaner

icon Discussion

Discuss the application

icon Typos

Suggestions for spelling and typography

icon FAQ

Frequently asked questions

icon Installation

Install instructions

Bug report or feature request · History of changes · Configuration (help, template) · Wikis · Languages · Users · Screenshots

WPCleaner is a maintenance tool, developed with Java 17+. The installation program is hosted on Toolforge since release 2.0 of WPCleaner. The minimum required version is Java 17, and it should run with any later version.

Prerequisites

Prerequisites to install and use WPCleaner are:

Installation with WPCleaner installer

The easiest way to install WPCleaner is with the dedicated installation program (Note: currently, the installation program has only been tested on a small number of computers running a Windows or Ubuntu operating system, so please report any result with your installation on WPCleaner's talk page).

The following actions are required to install WPCleaner:

Note: This procedure is a wrapper for the installation with getdown, so the automatic updating of WPCleaner will be handled by getdown.

Installation with getdown

Installation tutorial on Windows 10

Another way to install WPCleaner is with getdown, an independent tool dedicated to installing and automatic updating of Java programs. This installation lets you automatically update WPCleaner at each execution.

The following actions are required to install WPCleaner:


You can customize WPCleaner installation to simplify its daily usage:

General syntax Example
user=[Username]
password=[Password]
user=NicoV
password=MyPassword

Usage

To start the graphical interface of WPCleaner, you can use the following methods (It is advised to create a shortcut or optionally for the Mac, an Automator script):

To run WPCleaner in bot mode without any graphical interface (handling specific tasks), check the file Bot.bat or Bot.sh for explanations about the parameters to be used.

Troubleshooting

This section tries to give answers for a few possible problems arising during the installation.

Java version

Even if you've installed Java 17 or more recent on your computer, the one that is used in the command line may be an older one. You can see this problem at several steps in the installation process:

In each case, it means that the command line is using an older version of Java. You can either uninstall the older Java or make sure that the command line uses the newer Java.


Security

WPCleaner needs your Wikipedia login and password to read and edit articles on which you want to work. To test WPCleaner, without the ability to save your modifications, you can use the Demo mode without providing a password.

If you have activated two-factor authentication on your Wikipedia account, you need to create a bot password for WPCleaner, cf. this guide.

Network configuration

If you have a special network configuration (proxy, ...), some further configuration might be required.

User box

If you want to show on your user page that you're using WPCleaner, you can use {{Wikipedia:WPCleaner/Userbox}} which will add the following user box

This user is a dedicated user of WPCleaner.

Using same preferences on another computer

On Windows, WPCleaner stores most of its information in the Windows registry. If you change your computer and want to keep your configuration, you just need to copy the WPCleaner part of the registry from the old computer to the new one.

To copy your Windows configuration from one PC to a new PC, you can use Regedit:

  1. On the old PC, click Start > Run...
  2. Type regedit and click OK
  3. Select the folder HKEY_CURRENT_USER\Software\JavaSoft\Prefs\org\wikipediacleaner
  4. Click File > Export...
  5. Enter a file name and click Save
  6. Copy the .reg file from the old PC to the new PC
  7. On the new PC, right click on the .reg file and choose Merge
  8. When asked "Are you sure you want to add the information", click Yes
  9. Once the merge is complete, click OK

For Mac and Linux, there's a preference file for WPCleaner that can be copied over to another computer that uses Linux or Mac.