跳转至

使用 Wakapi 记录自己的工作情况

预计阅读时长 : 2 分钟

Wakatime ⧉ 是一个可以记录自己工作情况的工具,可以记录自己使用的工具软件,从事的项目,以及使用的时间等数据。

Wakapi 作为 Wakatime ⧉ 的开源替代品,不仅免费而且在样式和功能上都做到了青出于蓝而胜于蓝。强烈推荐用它来记录自己的工作情况,毕竟就算是摸鱼咱也得摸得清清楚楚不是。

而且 Wakapi 实现了 Wakatime 的 API 接口,这意味可以直接使用 Wakatime 的各类 IDE 插件。就我个人常用的工具来说,VS Code、PyCharm、XTerminal、Edge,一个不剩不留死角。

Docker 安装

Wakapi 的安装非常简单,只需要使用 Docker 构建即可,具体的配置可见官方示例 ⧉

version: '3.8'

services:
  wakapi:
    image: ghcr.io/muety/wakapi:latest
    ports:
      - "3000:3000"
    environment:
      WAKAPI_PASSWORD_SALT: "your_generated_salt" # 替换为自行生成的 SALT 密码
    volumes:
      - wakapi-data:/data
    restart: always

volumes:
  wakapi-data:

插件配置

利用 Wakatime 的插件,可以在各种工具软件中使用 Wakapi 记录自己的工作情况,官方 ⧉已经支持了上百种工具软件,可以根据自己的需要进行添加。

VS Code & PyCharm

VS Code 和 PyCharm 的 Wakatime 插件配置方式调用是同一个配置文件,因此只需要在配置文件中配置一次即可完成同时两者的配置。

具体的操作流程可见 vscode-wakatime ⧉ 插件的说明,需要注意配置文件中的 api_url 的格式。

1
2
3
4
5
6
7
[settings]

# Your Hakatime server URL
api_url = https://time.10k.xyz/api

# Your Hakatime API key
api_key = cdceeeaa-xxxx-xxxx-xxxx-08751d6012c2

正确配置之后,就可以在 IDE 的下方状态栏中看到 Wakapi 的实时记录更新。

Chrome & Edge

浏览器插件的配置相对而言会复杂一些,尤其是 API Url 和上面 VS Code 的配置不同,需要特别注意。

以下图为例,API Url 的地址类似 https://wakapi.dev/api/compat/wakatime/v1,只要在 wakapi.dev 换成自己的 Wakapi 服务器地址即可。

还可以进一步配置其他的属性,更加定制化的记录自己的工作相关浏览情况。

  • Logging style : 可选只记录白名单中的网站,或者只排除黑名单中的网站。
  • Logging type : 可选是记录网站的根域名,还是记录网站的每个页面的详细地址。
  • Whitelist : 白名单,可以在网站名的后面使用 @@ 符号添加项目标签。
  • Hostname : 为当前设备添加一个主机名,可以用来区分不同的设备。

Terminal

官方推荐的 Terminal 插件工作功能比较弱,使用替代品 wakatime-zsh-plugin ⧉ 可以更全面的记录在 Terminal 中的工作情况。

该插件依赖于 wakatime-cli ⧉,配置方式也是通过 ~/.wakatime.cfg 文件完成。

python3 -c "$(wget -q -O - https://raw.githubusercontent.com/wakatime/vim-wakatime/master/scripts/install_cli.py)"

数据整合

由于数据来源太多,且部分数据无法辨别细分属性,因此为了数据展示的美观度,还需要到 Settings-Data 中进行一些整合操作。

Alias

通过 Alias 的配置,可以为项目、语言、编辑器等等添加别名,这样可以将多个相同的项目或者语言进行合并,从而减少数据的冗余。

Project

通过 Project 的配置,可以将多个项目进行合并到几个 Label 下,进而对工作进行分组汇总,更容易看出来时间的去向。

样式美观

Wakapi 的样式默认是使用的单一绿色色系,可以通过修改 Settings - Data- Vibrant Colors 中开关使用多彩色系,整体的效果会更加美观。

徽章嵌入

埋头干活而不炫耀,等于没有干活,因此还需要将 Wakapi 的数据嵌入到自己的网站中,这样才能更好的展示自己的工作情况。

Wakapi 提供了徽章的嵌入代码,可以直接复制到自己的网站中展现。