Teleproompter Plugin for Neovim

Teleproompter is a plugin that extends Harpoon to enable quick creation, management, and usage of context files for LLM prompting. It allows you to organize files into different categories (context, resources, instructions) and put results of command executions inside the prompt.

Problems

1. Instead of pivoting to AI editors, you'd rather integrate your LLM prompting framework into the optimized file navigation and text editing capabilities from Neovim.

2. You want to specifically craft the LLM prompt you know is right for the task at hand, without relying on it crawling all of your codebase, wasting time and tokens away.

3. You're a cheap f*ck that lives in Europe and codes 16 hours a day, so you can't afford to send 60 M tokens to Claude per day (but you have a Claude pro subscription and the chat is way cheaper than the API).

Solutions

• You probably already have the context your LLM needs in your head. And as a neovim user bent on having a navigation system where everything you need is at your fingertips, it is probably also in harpoon. So using harpoon as a source for a list of file and commands to give to a LLM sounds like a good idea.

• So the whole workflow would be putting project files into separate harpoon lists representing specific parts of the prompt, have a way to visualize all these files and navigate to it instantly to edit them, and finally, craft the output from the file content and the command outputs to put it in the clipboard.

Prerequisites

The plugin requires:

• Neovim >= 0.10.0
• Harpoon 2
• Telescope

Installation

Using Packer

Add to your packer.lua file:

use {
    'yourusername/teleproompter',
    requires = {
        'ThePrimeagen/harpoon',
        'nvim-telescope/telescope.nvim'
    },
    config = function()
        require('teleproompter').setup()
    end
}

Using Lazy.nvim

{
    'yourusername/teleproompter',
    dependencies = {
        'ThePrimeagen/harpoon',
        'nvim-telescope/telescope.nvim'
    },
    config = function()
        require('teleproompter').setup()
    end
}

Manual Installation

Clone the repository:

git clone https://github.com/yourusername/teleproompter.git ~/.config/nvim/pack/plugins/start/teleproompter

Then add to your init.lua:

require('teleproompter').setup()

Usage

Basic Concepts

Teleproompter organizes files into different lists, each with specific purposes:

1. Context List - Files containing context information for LLM prompts
2. Command Context List - Shell commands to execute and include their output
3. Resources List - Reference files or resources
4. Instructions List - Files containing instructions for LLMs

Each list is managed separately but can be viewed and manipulated together. The plugin leverages Harpoon's list functionality to maintain these lists.

Default Keybindings

Adding Files to Lists

• <leader>c - Add current file to context list
• <leader>r - Add current file to resources list
• <leader>i - Add current file to instructions list

Toggling List Menus

• <leader>lc - Toggle context list menu
• <leader>lt - Toggle command context list menu
• <leader>lr - Toggle resources list menu
• <leader>li - Toggle instructions list menu

List Views

• <leader>la - Show all lists in a single window
• <leader>ls - Show all lists in Telescope
• <C-e> - Toggle Telescope with Harpoon integration

Commands

• <leader>tc - Add a command to the command context list

Clipboard Operations

• <leader>yc - Copy contents of all marked files to clipboard
• <leader>ye - Execute commands and copy output to clipboard
• <leader>ya - Copy all content and command outputs to clipboard

List Management

When viewing lists, you can:

• Press q to close the list window
• Press y to copy all content to clipboard
• Press o to set item order (in the all lists view)

In Telescope view, you can:

• Press <CR> to select and open a file/execute a command
• Press <C-y> to copy the selected item's content

Customization

You can customize the plugin by passing options to the setup function:

require('teleproompter').setup({
    -- Custom list configurations
    lists = {
        context = {
            type = "file",
            title = "My Context",
            list_name = "__my_context_list__",
            order = 1,
            key = "context",
        },
        custom_list = {
            type = "file",
            title = "Custom List",
            list_name = "__my_custom_list__",
            order = 5,
            key = "custom_list",
        },
        -- Add more custom lists as needed
    },
    
    -- Custom keymaps
    keymaps = {
        lists = {
            context = "<leader>mc",
            resources = "<leader>mr",
            instructions = "<leader>mi",
            custom_list = "<leader>mx"  -- For your custom list
        },
        toggle_lists = {
            context = "<leader>tc",
            cmd_context = "<leader>tt", 
            resources = "<leader>tr",
            instructions = "<leader>ti",
            custom_list = "<leader>tx"  -- For your custom list
        },
        show_all_lists = "<leader>ta",
        show_all_telescope = "<leader>ts",
        copy_all = "<leader>yp",
        add_command = "<leader>ac",
        exec_commands = "<leader>ec",
        copy_everything = "<leader>yy",
        telescope_toggle = "<C-t>"
    }
})

List Configuration Structure

Each list is configured with the following properties:

• type - The list type, either "file" or "command"
• title - The display title for the list
• list_name - The internal name used by Harpoon
• order - The display order in combined views
• key - The identifier used in configurations and API calls

Features

UI Windows

Teleproompter provides various UI windows:

• Individual list menus (via Harpoon)
• Combined list view showing all lists in one window
• Command output displays
• Telescope integration for advanced filtering

Command Execution

Commands added to the command list can be:

• Executed individually
• Executed all at once with output captured
• Included in the final clipboard output

Telescope Integration

The plugin integrates with Telescope to provide:

• Advanced filtering of list items
• File previews
• Specialized actions for both files and commands

System Prompt Feature

Teleproompter now supports a system prompt feature, which allows you to include a standard prompt at the beginning of all copied content. This is particularly useful for setting up consistent instructions for LLMs across different prompts.

System Prompt Behavior

The system prompt:

• Always appears as the first item in copied content
• Is consistent across projects by default
• Can be overridden on a per-project basis

Configuration

You can configure the system prompt in several ways:

1. Default Hardcoded Prompt: A sensible default is provided out of the box
2. Global Configuration File: Set a custom system prompt file in your Neovim config
3. Project-Specific Override: Create a TELEPROOMPTER.md file in your project root

Default Configuration

require('teleproompter').setup({
    -- System prompt configuration
    system_prompt_file = vim.fn.stdpath("config") .. "/teleproompter_system_prompt.md",
    default_system_prompt = [[
# System Prompt
You are a helpful AI assistant. You will be given context, instructions, and resources to help you respond to the user's request.

1. First, carefully read and understand any context provided
2. Follow the instructions given to you precisely
3. Use the resources provided to inform your response
4. Be concise yet thorough in your answers
5. If you're unsure about something, acknowledge the uncertainty rather than making assumptions
]]
})

Custom System Prompt File

Create a Markdown file at the configured path with your preferred system prompt content:

# Custom System Prompt

You are an assistant specialized in coding and system design. When analyzing code:

1. First identify the overall architecture and key components
2. Focus on potential performance bottlenecks
3. Suggest improvements with specific code examples
4. Keep backward compatibility in mind

Project-Specific Override

To override the system prompt for a specific project, create a TELEPROOMPTER.md file in the project root:

# Project-Specific System Prompt

You are a specialist in refactoring Neovim plugins. When analyzing this codebase:

1. Focus on maintaining the existing API
2. Suggest performance improvements
3. Identify opportunities for better error handling
4. Recommend ways to improve the user experience

Priority Order

When determining which system prompt to use, Teleproompter checks in this order:

1. Project-specific TELEPROOMPTER.md file (highest priority)
2. Configured system prompt file path
3. Default hardcoded system prompt (lowest priority)

The first available prompt will be used.

License

MIT