waka-cli 0.2.1

Command-line client for the WakaTime API
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

# waka-cli

A command-line client for the [WakaTime](https://wakatime.com/) API, built on the
[`waka`](https://crates.io/crates/waka) crate. It covers every documented endpoint:
coding statistics, summaries, durations, heartbeats, goals, insights, leaderboards,
organizations, and the write operations.

## Installation

```sh
cargo install waka-cli
```

## Authentication

Get your API key from [wakatime.com/api-key](https://wakatime.com/api-key) and provide
it via a flag, an environment variable, or a `.env` file in the working directory:

```sh
# flag
waka-cli --api-key 'waka_…' user

# environment
export WAKATIME_API_KEY='waka_…'
waka-cli user

# .env file
echo "WAKATIME_API_KEY=waka_…" > .env
waka-cli user
```

OAuth 2.0 access tokens are supported via `--bearer-token` / `WAKATIME_BEARER_TOKEN`.

### Environment variables

| Variable | Flag | Description |
|---|---|---|
| `WAKATIME_API_KEY` | `--api-key` | API key, sent as HTTP Basic auth |
| `WAKATIME_BEARER_TOKEN` | `--bearer-token` | OAuth 2.0 access token, sent as Bearer auth |
| `WAKATIME_USER` | `--user` | The user to query; defaults to `current` |
| `WAKATIME_BASE_URL` | `--base-url` | Override the API base URL |
| `WAKATIME_TIMEOUT` | `--timeout` | Request timeout in seconds |

## Usage

```sh
# Your coding stats for the last week
waka-cli stats last_7_days

# Daily summaries for a date range
waka-cli summaries 2026-01-01 2026-01-08

# Today's activity, as shown in editor status bars
waka-cli status-bar

# All projects, across all pages
waka-cli projects --all

# Send a heartbeat
waka-cli heartbeats send --entity /path/to/file.rs --type file --project my-project

# Log an external duration, e.g. a meeting
waka-cli external-durations send --external-id standup-42 --entity "Daily standup" \
    --type event --category meeting --start 1750000000 --end 1750000900

# Replace custom rules from a JSON file (or stdin)
waka-cli custom-rules set --file rules.json

# Request a data dump export
waka-cli data-dumps create daily
```

Run `waka-cli --help` for the full list of subcommands, and
`waka-cli <command> --help` for the options of each command.

## Shell completions

Generate completions for your shell with the `completions` subcommand
(supported: `bash`, `zsh`, `fish`, `elvish`, `powershell`):

```sh
# bash
waka-cli completions bash > ~/.local/share/bash-completion/completions/waka-cli

# zsh
waka-cli completions zsh > ~/.zfunc/_waka-cli

# fish
waka-cli completions fish > ~/.config/fish/completions/waka-cli.fish
```

## JSON output

Every command supports `--json`, which prints the raw API response as
pretty-printed JSON to stdout instead of the human-readable rendering:

```sh
waka-cli stats last_7_days --json | jq '.languages[0]'
waka-cli summaries 2026-01-01 2026-01-08 --json > summaries.json
```

## License

Licensed under the European Union Public Licence (EUPL), Version 1.2.