Configuring

wikicmd looks for ~/.wikicmd.json in order to read your configuration. You can either create this file by hand, or you can run the config command where a command-line wizard will help you to accomplish the same.

$ wikicmd config
Wiki address: (https://en.wikipedia.org/w)
Login: myuser
Password: mypassword
Next, a configuration file will be created for you and saved as /home/myuser/.wikicmd.json

Is this OK? (yes):    
Done!

If you want your configuration file to be located in a place other than ~/.wikicmd.json, you can set the WIKICMD_CONFIG shell environment variable, pointing to a place of your preference.

Configuration Structure

A configuration file is formatted as follows:

{
  "wikis": [
    {
      "id": "my_wiki",
      "address": "https://en.wikipedia.org/w",
      "user": "myuser",
      "password": "mypassword"
    }
  ]
}

The wikis field takes a list of "Wiki Configuration Objects". In the example above, we have only one Wiki, my_wiki, that we want to manage with wikicmd. If you want to configure wikicmd to be able to use multiple wikis, make sure to read about the switch command.

Configuration Parameters

Wiki Object

id

An ID to identify a Wiki with.

address

A Wiki URL. For example https://en.wikipedia.org/w.

user

A username that you can login with.

password

Your password.

importExtensions (optional)

A list of file extensions that can be be imported.

MediaWiki by default allows only a set of file types to be uploaded. However there are extensions that enhance MediaWiki to allow other kinds of files. If you customised your wiki to enable uploading other types of files, you can use this configuration parameter to enable wikicmd to import these files.

"importExtensions": [
  "mp4",
  "avi",
  "wmv"
]

wikicmd