tldr

TLDR: Your Ultimate VSCode Summarization Extension

Introducing TLDR, a handy VSCode extension designed to make your life easier by reading, chunking, and summarizing long texts. Whether you're dealing with documentation, code comments, or logs, TLDR helps you quickly get the gist of any text without the hassle of sifting through it all.

If you like this extension, consider supporting me here.

What is TLDR?

TLDR (Too Long; Didn't Read) is a tool that breaks down long texts into smaller parts and provides concise summaries. It's perfect for developers, researchers, and anyone who needs to quickly understand large amounts of text. Say goodbye to information overload and hello to efficient reading with TLDR!

How it works

TLDR creates logical chunks of text from scraping a webpage. It optimizes the chunks to be within 7000 characters. Each chunk represents a page in the output of TLDR. Each OpenAI response is combined with each subsequent chunk to carry forward the summary to each invocation to OpenAI to get a full-page summary.

To get the full content, read the last page.

Features

Provide a URL, and TLDR will summarize it for you. That's it. If the text is very long, it will break it into subsegments for you to review.

shift+cmd/ctrl+p and search for TLDR: summarize. Choose TLDR URL and paste your URL to summarize.

Future Features

• Recursion web scraping - Load all pages within a context.
• PDF support
• File support - For any local documents.
• Chat support - Chat with TLDR about further questions you may have. This feature requires a vector database.
• Saving past summaries.
• Insert the summary into a Markdown file.

Requirements

Set your OpenAI API Key by running shift+cmd/ctrl+p and adding your key. Otherwise, this extension will check the environment for the OPENAI_API_KEY variable set.