Worklog

Overview

worklog is a Neovim plugin automatically captures and commits a summary of your work to a specified Git repository.

Features

• Captures modified files
• Tracks recent changes
• Logs current buffer content
• Automatically commits summary to Git repository

Installation

Using packer

use {
  'franpfeiffer/worklog.nvim',
  config = function()
    require('worklog').setup({
      repoPath = '/path/to/your/log/repo'
    })
  end
}

Using lazy

{
  'franpfeiffer/worklog.nvim',
  config = function()
    require('worklog').setup({
      repoPath = '/path/to/your/log/repo'
    })
  end
}

Advanced config

-- Packer
use {
  'franpfeiffer/worklog.nvim',
  config = function()
    require('worklog').setup({
      repoPath = '/path/to/your/log/repo'
      logFile = 'yourlogfile.md' -- Optional (default: 'WORKLOG.md')
      commitInterval = 420 -- Optional (default: 1800sec => 30min)
    })
  end
}

-- Lazy
{
  'franpfeiffer/worklog.nvim',
  config = function()
    require('worklog').setup({
      repoPath = '/path/to/your/project/repo'
      logFile = 'yourlogfile.md' -- Optional (default: 'WORKLOG.md')
      commitInterval = 420 -- Optional (default: 1800sec => 30min)
    })
  end
}

Usage

Manual Triggering

Use the :Worklog command in Neovim to manually trigger a work log capture and commit immediately.

Checking Status

Use the :WorklogStatus command to check the status of the worklog timer. It will display the time remaining until the next automatic commit or indicate that a commit is due.

Stopping the Timer

Use the :WorklogStop command to stop the worklog timer.

Requirements

• Neovim 0.7+
• Git installed and configured
• A Git repository initialized at the specified path