red-tldr - red-tldr is a lightweight text search tool, which

项目说明

!README

Red Team TL;DR

English | 中文简体

![GitHub release]()

What is Red Team TL;DR?

red-tldr is a lightweight red team command lookup tool. It helps experienced red team operators quickly find the commands, techniques, and key points they need — like a man command built for offensi.

Starting from v0.5.0, red-tldr also ships with a built-in MCP server, so AI assistants like Claude Desktop and Cursor can query your red team knowledge base directly.

Why Red Team TL;DR?

In daily red team work, you need to memorize hundreds of commands — and usually you only remember the first few characters. Searching through documentation or search engines is slow and noisy. red-tldr gives you instant, offline, deterministic answers from a curated database you control.

Features

Quick Start

Install

#### macOS

#### Arch Linux

#### From Source

#### Binary

Download from Releases.

> It is recommended to add red-tldr to your PATH.

Usage

Search

!search-mimikatz

!Fuzzy-match

When multiple results are found, select by number:

!Select-Number

Output Formats

Update & Upgrade

MCP Server

red-tldr includes a built-in MCP server that exposes your red team knowledge base to AI assistants.

Tools

| Tool | Description |
|------|-------------|
| search_redteam_commands | Search commands by keyword, platform, category, tactic, or technique |
| get_command_details | Get full details of a specific command entry |
| list_techniques | List a MITRE ATT&CK techniques in the database |

stdio Mode (Claude Desktop / Cursor)

Add to your Claude Desktop config (claude_desktop_config.json):

Streamable HTTP Mode

Configuration

Default config path: ~/.red-tldr/config.toml

| Item | Description | Type |
|------|-------------|------|
| index-update | Auto-rebuild index on search | Bool |
| github-update | Auto-download database from GitHub | Bool |
| path | Database storage path | String |
| color | Colored terminal output | Bool |

Data Model

Each entry is a YAML file in the red-tldr-db repository. The enhanced format (v0.5.0+) supports additional fields while remaining backward compatible:

pri::debug
sekurlsa::logonpasswords

All new fields (category, platforms, mitre_attack, metadata, related) are optional — existing YAML files work without modification.

Contributing

We welcome contributions!

* Report bugs via Issues.
* Submit bug fixes as Pull Requests to the dev branch.
* For new features, create an issue first to discuss the approach before submitting a PR.
* Documentation impro are always welcome.
* Contact:

Stargazers over time

![Stargazers over time]()

项目信息

开发语言：Go

Star 数：246

技术要点

该项目属于红蓝攻防方向的开源资源，代码结构清晰，适合安全研究人员学习参考。项目围绕red-tldr is a lightweight text search tool, which is used to help red team staff quickly find the commands and key points they want to execute, so it is more suitable for use by red team personnel with certain experience.展开，提供了可运行的实现，对理解相关安全机制、工具原理与攻防技术具有较高的研究价值。

从技术实现角度看，此类项目的核心在于对底层原理的深入理解与工程化落地。开发者在研究过程中可以结合官方文档与社区讨论，梳理项目的初始化流程、核心模块职责与数据流转，逐步掌握其中的技术细节与设计思路。

使用与学习建议

1. 下载源码压缩包，解压到本地环境。

2. 根据项目类型准备对应的运行环境与依赖。

3. 按照 README 中的步骤完成配置与部署。

4. 在隔离的测试环境中运行验证，避免影响生产系统。

免责声明

本资源来源于开源社区，仅供安全研究、技术学习与合法授权范围内的攻防演练使用，请勿用于任何非法或侵害他人权益的用途。使用本项目产生的一切后果由使用者自行承担。