red-tldr

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.

View the Project on GitHub Rvn0xsy/red-tldr

README

Red Team TL;DR

English 中文简体

What is Red Team TL;DR ?

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.

Why Red Team TL;DR ?

In my daily work, I need to memorize a lot of commands. Most of me only know the beginning of it. Human memory is limited. It is tedious to find what I want through search engines. I think we need a Linux-like one. man command.

Quick start

Install Red Team TL;DR

For Git Install

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

For Binary

$ wget https://github.com/Rvn0xsy/red-tldr/releases/download/v0.2/red-tldr_latest_linux_amd64.tar.gz
$ tar -zxvf red-tldr_latest_linux_amd64.tar.gz
$ ./red-tldr

It is recommended to add red-tldr to the environment variables of the current user

Example

  1. Keyword Search
$ red-tldr search mimikatz

search-mimikatz

  1. Fuzzy matching
$ red-tldr search mi

Fuzzy-match

Select Number : 0

When there are multiple results, you can follow the digital index to determine the result output

Select-Number

  1. Update index file
$ red-tldr search update
  1. Update database file
$ red-tldr update

Configuration file

Default configuration file path:HOMEDIR/.red-tldr/config.toml

[red-tldr]
  index-update = false
  github-update = false
  path = ""
Configuration item Description Type
index-update Whether the database index file is automatically updated Bool
github-update Whether the database file is automatically updated from github Bool
path Database file storage path string

Contributing

Interested in getting involved? We would like to help you!