fork of the wakatime cli program for rana
Go to file
Luna 57ef0ab810 update README 2019-06-06 14:56:17 -03:00
tests fix tests on py2 2019-05-07 18:25:39 -07:00
wakatime api: fix error when base_url not given 2019-06-06 14:12:38 -03:00
.appveyor.yml run Windows tests on Python 3.4 through 3.6 2018-09-30 21:45:14 -07:00
.coveragerc remove unused python token parser method 2016-08-31 17:13:25 +02:00
.gitignore pull vim-rana changes into rana-cli 2019-06-06 13:59:35 -03:00
.travis.yml re-enable travis tests on Python 2.6 2018-09-26 20:36:10 -07:00
AUTHORS add, update AUTHORS 2019-06-06 14:25:37 -03:00
HISTORY.rst fix typo 2019-05-07 18:46:58 -07:00
LICENSE update copyright year to 2016 2016-03-06 13:02:46 -08:00 add NOTICE to manifest for pypi 2015-05-27 22:34:46 -07:00
NOTICE add NOTICE file for vendorized python libraries 2015-05-27 22:34:19 -07:00 update README 2019-06-06 14:56:17 -03:00
README.rst add base_url setting to README 2019-06-06 14:03:53 -03:00
dev-requirements.txt downgrade mock for py2.6 2019-05-07 18:36:23 -07:00
setup.cfg include non-executed python files in coverage report 2015-09-29 15:50:33 -07:00 add support for python 3.6 2017-02-16 12:11:12 -08:00
tox.ini run tests locally on py 3.6 2017-02-16 12:20:33 -08:00


Command line interface to rana.

This is a fork of the wakatime CLI tool for use with rana.

Rana is not affiliated with WakaTime.

Go to to install the plugin for your text editor or IDE.

Installation / Forking WakaTime plugins

Note: You shouldn't need to directly use this package unless you're building your own plugin or forking an existing WakaTime plugin for support with Rana.

Since plugins install the WakaTime CLI directly, the recommendation for plugin forkers is to copy this repository into the plugin's installation of WakaTime CLI.

For example, this would happen on vim-rana:

cp -rv path/to/rana-cli/wakatime/* path/to/vim-rana/packages/wakatime/

WakaTime plugins can be found in

WakaTime plugins with Rana support can be found in


rana-cli aims to be a seamless replacement of WakaTime CLI. As such, all existing documentation of WakaTime CLI applies to rana-cli.


rana-cli, as of right now, has a single extra field in the configuration file: api_key, so that you can switch easily between rana instances (e.g prod/local)

The config file is found on $WAKATIME_HOME/.wakatime.cfg, which is the user's current home directory for UNIXes.

An example config file is as follows.

debug = false
api_key = your-api-key
base_url =
hide_file_names = false
hide_project_names = false
exclude =
include =
include_only_with_project_file = false
status_bar_icon = true
status_bar_coding_activity = true
offline = true
proxy = https://user:pass@localhost:8080
no_ssl_verify = false
ssl_certs_file =
timeout = 30
hostname = machinename

projects/foo = new project name
^/home/user/projects/bar(\d+)/ = project{0}

disable_submodules = false

The default config file may be:

debug = false
hidefilenames = false
ignore =


Check for other config options.

Running tests

Install dev requirements:

virtualenv venv
venv/bin/pip install -r dev-requirements.txt
venv/bin/pip install tox

Run tests:



Thank you to the WakaTime developers and contributors for writing the CLI tool.