Skip to content

About

Command line interface used by all Hackatime text editor plugins

Resources

Code of conduct

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

 
 

Repository files navigation

Hackatime CLI

Tests Downloads

Command line interface used by Hackatime editor plugins, such as vscode-hackatime.

hackatime-cli is a fork of wakatime-cli. It speaks the same WakaTime-compatible API and sends heartbeats to Hackatime by default.

Usage

Normally you don't need to use hackatime-cli directly unless you're building an editor plugin.

hackatime-cli reads the same INI config file as WakaTime plugins, so existing setups keep working:

$WAKATIME_HOME/.wakatime.cfg

Without an explicit config path or WAKATIME_HOME, hackatime-cli also supports an XDG config fallback when ~/.wakatime.cfg does not exist.

hackatime-cli writes JSONL logs to:

$WAKATIME_HOME/.wakatime/wakatime.log

Set debug = true in your config file to enable verbose logs.

See Usage for more details.

Differences from wakatime-cli

  • The binary and release assets are named hackatime-cli-<os>-<arch>.
  • api_url defaults to https://hackatime.hackclub.com/api/hackatime/v1.
  • There is no hardcoded IP fallback when DNS resolution fails.

The config file, ~/.wakatime/ folder, WAKATIME_* environment variables, .wakatime-project files and the wakatime/<version> user agent prefix are unchanged, so hackatime-cli can share a machine with wakatime-cli and with plugins that still use it.

Contributing

Pull requests and issues are welcome! See Contributing for more details.

Troubleshooting

See Troubleshooting for more details.

Many thanks to the WakaTime team and all contributors to wakatime-cli.

About

Command line interface used by all Hackatime text editor plugins

Resources

Code of conduct

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages