Installation Guide

June 12, 2026 ยท View on GitHub

Package Manager Installation

{
    "georgeharker/comment-tasks.nvim",
    config = function()
        require("comment-tasks").setup({
            default_provider = "clickup", -- Choose your preferred provider
            
            providers = {
                -- Configure only the providers you use
                clickup = {
                    enabled = true,
                    api_key_env = "CLICKUP_API_KEY",
                    list_id = "your_clickup_list_id",
                    team_id = "your_clickup_team_id", -- Optional
                    statuses = {
                        new = "To Do",
                        in_progress = "In Progress", 
                        review = "Code Review",
                        completed = "Complete",
                    }
                },
                
                -- Add other providers as needed
            },
        })
        
        -- Set up keybindings (optional) - see docs/api-reference.md
    end
}

Using packer.nvim

use {
    "georgeharker/comment-tasks.nvim",
    config = function()
        require("comment-tasks").setup({
            -- Your configuration here
        })
    end
}

Using vim-plug

Plug 'georgeharker/comment-tasks.nvim'

Then in your init.vim or init.lua:

require("comment-tasks").setup({
    -- Your configuration here
})

Dependencies

Required

  • curl - HTTP requests are made by spawning the system curl binary via vim.system(); no external Lua dependencies are needed

Optional

  • Tree-sitter parsers - For enhanced comment detection (automatically installed by most Neovim distributions)

Environment Variables

Set up API keys for the task management systems you want to use:

# ClickUp
export CLICKUP_API_KEY="your_api_key_here"

# GitHub  
export GITHUB_TOKEN="your_personal_access_token"

# Asana
export ASANA_ACCESS_TOKEN="your_personal_access_token"

# Linear
export LINEAR_API_KEY="your_api_key_here"

# Jira (the instance URL is set via the server_url config option)
export JIRA_API_TOKEN="your_api_token"

# Notion
export NOTION_API_KEY="your_integration_token"

# Monday.com
export MONDAY_API_TOKEN="your_api_token"

# Trello
export TRELLO_API_KEY="your_api_key"
export TRELLO_API_TOKEN="your_token"

# GitLab (a self-hosted instance URL is set via the gitlab_url config option)
export GITLAB_TOKEN="your_personal_access_token"

# Todoist
export TODOIST_API_TOKEN="your_api_token"

Verification

After installation, verify everything works:

  1. Check plugin is loaded:

    :lua print(require("comment-tasks"))

  2. Test a provider (example with ClickUp):

    :ClickUpTask new

  3. Check environment variables:

    :lua print(vim.env.CLICKUP_API_KEY)

Next Steps