Skip to content

sandepten/worklog.nvim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 

Repository files navigation

worklog.nvim

A Neovim plugin for managing worklog tasks directly from your editor.

Features

  • ✅ Add tasks to your worklog without leaving Neovim
  • ✅ Mark tasks as completed by selecting them in the picker
  • ✅ View today's tasks in a picker interface
  • ✅ Fully async operations using Neovim's job API
  • ✅ Uses JSON API for clean, reliable task parsing

Requirements

  • Neovim 0.7.0 or higher
  • worklog CLI tool installed and in your PATH

Installation

Using lazy.nvim

{
  "sandepten/worklog.nvim",
  lazy = false,
  config = function()
    require("worklog").setup({
      -- Optional: disable keybindings
      -- keybindings = false,
      
      -- Optional: customize keybindings
      -- keymaps = {
      --   add = "<leader>wa",
      --   list = "<leader>wl",
      -- },
    })
  end,
}

Using packer.nvim

use({
  "sandepten/worklog.nvim",
  config = function()
    require("worklog").setup()
  end,
})

Using vim-plug

Plug 'sandepten/worklog.nvim'

Then in your init.lua or init.vim:

require("worklog").setup()

Commands

  • :WorklogAdd - Add a new task to today's worklog
  • :WorklogList - List today's tasks in a picker interface (select tasks to mark as done)

Keybindings

By default, the following keybindings are enabled:

  • <leader>wa - Add a new task
  • <leader>wl - List today's tasks

To disable keybindings:

require("worklog").setup({
  keybindings = false,
})

To customize keybindings:

require("worklog").setup({
  keymaps = {
    add = "<leader>ta",  -- Custom add keybinding
    list = "<leader>tl", -- Custom list keybinding
  },
})

Configuration

The plugin works out of the box with default settings. All configuration is optional:

require("worklog").setup({
  -- Disable automatic keybindings
  keybindings = false,
  
  -- Custom keybindings
  keymaps = {
    add = "<leader>wa",
    list = "<leader>wl",
  },
})

Usage

  1. Add a task: Run :WorklogAdd or press <leader>wa, then enter your task description
  2. View and mark tasks as done: Run :WorklogList or press <leader>wl to see all tasks in a picker interface. Select a pending task to mark it as done.

Related Projects

  • worklog - The CLI tool this plugin integrates with

License

MIT

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages