Skip to content

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.

License

Notifications You must be signed in to change notification settings

Rvn0xsy/red-tldr

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

README

Red Team TL;DR

English | 中文简体

GitHub release

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

The new version already supports automatic update of the database!

Install Red Team TL;DR

Mac OS Install

$ brew install red-tldr

For Git Install

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

For Arch Linux

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

For Binary

Download Release version.

$ 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 mimikatz

search-mimikatz

  1. Fuzzy matching
$ red-tldr 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 update
  1. Update database file
$ red-tldr upgrade

Configuration file

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

[red-tldr]
  index-update = false
  github-update = false
  path = ""
  color = true
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
color Print highlight command Bool

Contributing

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

  • Take a look at our issues list and consider sending a Pull Request to dev branch.
  • If you want to add a new feature, please create an issue first to describe the new feature, as well as the implementation approach. Once a proposal is accepted, create an implementation of the new features and submit it as a pull request.
  • Sorry for my poor English. Improvements for this document are welcome, even some typo fixes.
  • If you have great ideas, send an email to rvn0xsy@gmail.com.

Stargazers over time

Stargazers over time

About

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.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages