metrics/source/plugins/wakatime/README.md

← Back to plugins index
⏰ WakaTime
This plugin displays statistics from a WakaTime account. It is also compatible with self-hosted instances from wakapi.
⚠️ Disclaimer	This plugin is not affiliated, associated, authorized, endorsed by, or in any way officially connected with WakaTime. All product and company names are trademarks™ or registered® trademarks of their respective holders.
Supported features → Full specification	📗 Classic template
	👤 Users
	🗝️ plugin_wakatime_token

➡️ Available options

Option	Description
plugin_wakatime	Enable wakatime plugin
type: boolean default: no
plugin_wakatime_token	WakaTime API token
🔐 Token type: token
plugin_wakatime_url	WakaTime URL Can be used to specify a wakapi instance
type: string default: https://wakatime.com
plugin_wakatime_user	WakaTime username
⏯️ Cannot be preset type: string default: current
plugin_wakatime_sections	Displayed sections time: show total coding time and daily average projects: show most time spent project projects-graphs: show most time spent projects graphs languages: show most used language languages-graphs: show languages graphs editors: show most used code editor editors-graphs: show code editors graphs os: show most used operating system os-graphs: show operating systems graphs
type: array default: time, projects, projects-graphs, languages, languages-graphs, editors, os allowed values: time projects projects-graphs languages languages-graphs editors editors-graphs os os-graphs
plugin_wakatime_days	Time range
type: string default: 7 allowed values: 7 30 180 365
plugin_wakatime_limit	Display limit (entries per graph)
type: number (0 ≤ 𝑥) zero behaviour: disable default: 5
plugin_wakatime_languages_other	Other languages
type: boolean default: no
plugin_wakatime_languages_ignored	Ignored languages
type: array (comma-separated)
plugin_wakatime_repositories_visibility	Repositories visibility Can be used to toggle private activity visibility
type: string default: all allowed values: public all

🗝️ Obtaining a WakaTime token

Create a WakaTime account and retrieve API key in Account settings.

Then setup WakaTime plugins to be ready to go!

ℹ️ Examples workflows

name: WakaTime
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.wakatime.svg
  token: NOT_NEEDED
  base: ""
  plugin_wakatime: yes
  plugin_wakatime_sections: time, projects, projects-graphs, languages, languages-graphs, editors, os
  plugin_wakatime_token: ${{ secrets.WAKATIME_TOKEN }}