Skip to main content

No project description provided

Project description

doku is a cli tool to read and manipulate documents in DokuWiki via its XMLRPC endpoint.


pip install doku

# or as a user
pip install --user doku

# upgrade
pip install --upgrade doku


Enable XML RPC on your DokuWiki instance: Admin > Configuration Settings > Authentication

Create a new file: $HOME/.doku.ini

domain =
username = your-username
password = your-password
ssl = true
path = /

indexpage = root

Example usage:

❯ doku list
[2019-01-06 09:29:03] playground:playground
[2019-01-06 09:18:47] wiki:dokuwiki
[2019-01-06 09:18:47] wiki:syntax
[2019-01-06 09:18:47] wiki:welcome

doku list --namespace :playground
[2019-01-06 09:29:03] playground:playground

❯ doku edit wiki:welcome
# this will open your $EDITOR
# with the full content of the wiki page
Document saved.

❯ doku cat playground:playground
====== PlayGround ======

❯ doku --help
Usage: doku [OPTIONS] COMMAND [ARGS]...

  --help  Show this message and exit.



With diary commands, you can use your wiki as a diary (surprise).

The show command will show you all your logs (today).

The log command will open up your $EDITOR and after save+quit, it will append it for your diary page (today).

When you call log, doku will check all the path back and generates content for the tree.

For example:

# Today is 2019-02-21 and your index is configured to be 'root'
doku diary log

# This will create the following pages if it's not exist

# Will regenerate this page
# if you log an entry in a year previously was not there

# from stdin (pipe)
echo 'message' | doku diary log --pipe

# decorate with <code>...</code>
# automatically activated the --pipe flag
ls -la | doku diary log --code

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

doku-0.1.6.tar.gz (17.8 kB view hashes)

Uploaded source

Built Distribution

doku-0.1.6-py3-none-any.whl (21.7 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page