MCPcopy Index your code
hub / github.com/Rvn0xsy/red-tldr

github.com/Rvn0xsy/red-tldr @v0.5.0

Chat with this repo
repository ↗ · DeepWiki ↗ · release v0.5.0 ↗ · + Follow
118 symbols 387 edges 18 files 14 documented · 12% updated 4mo agov0.4.3 · 2021-09-22★ 246
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

Red Team TL;DR

English | 中文简体

GitHub release

什么是 Red Team TL;DR?

red-tldr 是一个轻量级的红队命令速查工具,帮助有经验的红队人员快速找到所需的命令、技术和关键要点 —— 就像一个专为攻击性安全打造的 man 命令。

从 v0.5.0 开始,red-tldr 内置了 MCP 服务器,AI 助手(如 Claude Desktop、Cursor)可以直接查询你的红队知识库。

为什么选择 Red Team TL;DR?

在日常红队工作中,需要记忆大量命令,而多数时候你只记得开头几个字符。通过搜索引擎翻找文档既慢又嘈杂。red-tldr 从你自己掌控的策展数据库中给出即时、离线、确定性的答案。

特性

  • 全文搜索 — 基于 Bleve 的 BM25 加权搜索(name×5、tags×3、data×1),支持模糊匹配
  • 多格式输出text(带颜色的终端输出)、jsonmarkdown
  • MCP 服务器 — 内置 Model Context Protocol 服务器,支持 AI 助手集成(stdio + Streamable HTTP)
  • MITRE ATT&CK 映射 — 条目可标记战术和技术编号
  • 增强数据模型 — category、platforms、mitre_attack、metadata(author/source/confidence)、related
  • 向后兼容 — 兼容现有 YAML 数据库,新增字段均为可选
  • 离线优先 — 无需云服务、无需 API Key,完全确定性输出
  • 安全修复 — 修复了 zip-slip 漏洞,所有解压操作均有路径校验

快速开始

安装

macOS

$ brew install red-tldr

Arch Linux

# AUR: https://aur.archlinux.org/packages/red-tldr
$ sudo pacman -S red-tldr

源码编译

$ git clone https://github.com/Rvn0xsy/red-tldr
$ cd red-tldr
$ go build

二进制安装

下载 Release 版本。

$ tar -zxvf red-tldr_latest_linux_amd64.tar.gz
$ ./red-tldr

建议将 red-tldr 加入环境变量中使用。

使用方法

搜索

# 关键字搜索
$ red-tldr mimikatz

search-mimikatz

# 模糊匹配 — 只需输入几个字符
$ red-tldr mi

Fuzzy-match

当存在多个结果时,输入数字索引选择:

Select-Number

输出格式

# JSON 输出
$ red-tldr mimikatz -f json

# Markdown 输出
$ red-tldr mimikatz -f markdown

更新与升级

# 重建本地索引(JSON + Bleve)
$ red-tldr update

# 从 GitHub 下载最新数据库
$ red-tldr upgrade

MCP 服务器

red-tldr 内置 MCP 服务器,可以将红队知识库暴露给 AI 助手使用。

工具列表

工具 说明
search_redteam_commands 按关键字、平台、分类、战术或技术搜索命令
get_command_details 获取指定命令条目的完整详情
list_techniques 列出数据库中的 MITRE ATT&CK 技术

stdio 模式(Claude Desktop / Cursor)

$ red-tldr serve

在 Claude Desktop 配置文件(claude_desktop_config.json)中添加:

{
  "mcpServers": {
    "red-tldr": {
      "command": "red-tldr",
      "args": ["serve"]
    }
  }
}

Streamable HTTP 模式

$ red-tldr serve --http --addr localhost:8080 --endpoint /mcp

配置文件

默认路径:~/.red-tldr/config.toml

[red-tldr]
  index-update = false
  github-update = false
  path = ""
  color = true
配置项 说明 类型
index-update 搜索时是否自动重建索引 Bool
github-update 是否从 GitHub 自动更新数据库 Bool
path 数据库文件存放路径 String
color 终端输出是否带颜色高亮 Bool

数据模型

每个条目是 red-tldr-db 仓库中的一个 YAML 文件。v0.5.0 的增强格式支持额外字段,同时保持向后兼容:

name: mimikatz-sekurlsa
tags:
  - mimikatz
  - credentials
  - lsass
data: |
  # Mimikatz Sekurlsa
  ```
  privilege::debug
  sekurlsa::logonpasswords
  ```
category: credential-access
platforms:
  - windows
mitre_attack:
  tactics:
    - credential-access
  techniques:
    - T1003.001
metadata:
  author: Rvn0xsy
  confidence: high
related:
  - mimikatz-dpapi

所有新增字段(categoryplatformsmitre_attackmetadatarelated)均为可选 —— 现有 YAML 文件无需修改即可正常使用。

贡献

red-tldr 是一个免费且开源的项目,我们欢迎任何人贡献力量。

  • 使用过程中遇到问题,请通过 Issues 反馈。
  • Bug 修复请提交 Pull Request 到 dev 分支。
  • 新功能请先创建 Issue 描述方案,采纳后再提交 PR。
  • 欢迎改进文档,帮助更多人使用 red-tldr。
  • 联系方式:rvn0xsy@gmail.com

提醒:项目相关问题请优先在 Issues 中反馈,方便其他人搜索解决方案。

Stargazers over time

Stargazers over time

Core symbols most depended-on inside this repo

Close
called by 21
internal/search/bleve.go
Search
called by 12
internal/search/bleve.go
argString
called by 11
internal/mcp/server.go
BuildIndex
called by 10
internal/search/bleve.go
OpenOrCreate
called by 8
internal/search/bleve.go
fieldString
called by 7
internal/search/bleve.go
New
called by 6
internal/render/render.go
matchesTags
called by 6
internal/db/search.go

Shape

Function 81
Method 23
Struct 13
TypeAlias 1

Languages

Go100%

Modules by API surface

internal/search/bleve.go16 symbols
internal/mcp/server.go14 symbols
internal/search/bleve_test.go12 symbols
internal/db/search_test.go12 symbols
internal/render/render.go10 symbols
internal/db/model.go8 symbols
cmd/root.go7 symbols
internal/updater/updater.go6 symbols
internal/config/config.go6 symbols
internal/updater/updater_test.go5 symbols
internal/render/render_test.go5 symbols
internal/mcp/server_test.go4 symbols

For agents

$ claude mcp add red-tldr \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page