otty / dotfiles

All tools/WakaTime

WakaTime

wakatime

Command line interface used by all WakaTime text editor plugins.

Detected by wakatime-cli, wakatime | macOS, Linux, Windows |wakatime.com

Sync it wakatime.toml

Sync rules

What travels, what stays, what never leaves

WakaTime in your home directory Every rule on this page, by file

…

debug = false

api_url = https://api.wakatime.com/api/v1

api_key = waka_FAKE0000-0000-4000-8000-000000000000

hostname = octocat-laptopmachine-local

hide_file_names = false

hide_project_names = false

exclude =

…

Each machine keeps its own copy of these.

api_key

Lifted into your secret store; the rest of the file syncs.

· ~/.wakatime/ Exclude

· ~/.wakatime.bdb Exclude

· ~/.wakatime.db Exclude

· ~/.wakatime.log Exclude

Only what the catalog names. A directory that syncs brings everything inside it except what is listed as excluded here.

apps/wakatime.tomlThe file this page is generated from

id = "wakatime"

name = "WakaTime"

homepage = "https://wakatime.com"

description = "Command line interface used by all WakaTime text editor plugins."

icon = "SimpleIcons:wakatime"

# wakatime-cli is the binary every editor plugin downloads and runs; `wakatime`

# is the name the older Python package installed and the one still typed by

# hand. Both are listed.

detect = ["wakatime-cli", "wakatime"]

# USAGE.md in wakatime/wakatime-cli: "$WAKATIME_HOME/.wakatime.cfg", with

# $WAKATIME_HOME defaulting to the user's home directory. It is an INI file

# whose main section is [settings]; the same page documents [projectmap],

# [project_api_key], [api_urls] and [git] beside it.

# A literal dotfile in the home directory — the docs give no XDG or %APPDATA%

# spelling — so it is written as such.

paths = ["~/.wakatime.cfg"]

# The heartbeat database, the offline queue and the log wakatime-cli writes

# beside the config are state, not configuration.

exclude = [

"~/.wakatime/",

"~/.wakatime.bdb",

"~/.wakatime.db",

"~/.wakatime.log",

]

# .wakatime.cfg is not a whole-file secret: the exclusions, the project map and

# the privacy switches in it are worth carrying. Only the key is lifted out.

secret = []

# A one-shot process: each heartbeat is a fresh run that reads the file and

# exits.

side_effect = false

# USAGE.md's settings table: "api_key | Your wakatime api key". One prefix

# covers both spellings an INI file has for it, `api_key = …` and `api_key=…`.

# It also reaches api_key_vault_cmd, the alternative that names a shell command

# to fetch the key instead of storing it — that line is not a credential, but

# over-reaching a prefix costs a consumer nothing while missing one would sync

# the key in the clear.

# The [project_api_key] section, from the same page, maps a directory to a

# second key. Its left-hand sides are arbitrary paths, so no prefix can name

# those lines, and a consumer that scans content is the only thing that catches

# them. Said here rather than papered over with a rule that would not run.

[[secret_paths]]

file = "~/.wakatime.cfg"

match = { prefix = ["api_key"] }

# Same table: "hostname | Optional name of local machine. By default,

# auto-detects the local machine's hostname". It names this machine and nothing

# else, and wakatime.com groups a user's coding time by it, so the value is

# worth keeping for the device it belongs to rather than carried to the next

# one.

[[machine_lines]]

file = "~/.wakatime.cfg"

match = { prefix = ["hostname"] }

scope = "backup"

Use it with your dotfile manager

Same data, in the shape your tool already reads

Opens Otty and adds this tool to what it syncs

Opens otty://sync/add/wakatime. Otty ships with this catalog, so the link only has to name the tool — nothing is downloaded.

Every one of these is generated from the same rules as this page. None of them splits hostname for you — that part is Otty’s own sync, or a template you write by hand.