rvn0xsy/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.

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

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

2. Fuzzy matching

$ red-tldr mi

Select Number : 0

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

3. Update index file

$ red-tldr update

4. 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 [email protected].

Stargazers over time

red-tldr's Issues

这个项目很像 tldr 和 tealdeer，主要区别是什么？

[PR] 增加更新参数，实现自动从 GitHub 更新的功能

参考 exploitdb 和 nuclei，新增参数 update-db 从 red-tldr-db 自动拉取更新，原来的 update 参数除了更新 db.json 文件还会对比 GitHub 仓库的最新 release 包自动更新 red-tldr

• [ update]
• [ update-db]

Window平台下main.go的viper.ReadInConfig()函数存在兼容问题

viper.ReadInConfig()这个函数会一直判断当前目录下是否有存在config文件，不存在则会进入生成根目录下的config文件，导致第一次执行没问题，第二次执行的时候因为存在.red-tldr文件夹，进而第二次mkdir会报错

类rofi

弄一个图形化的，开一个后台设置一个快捷键唤醒，弹出输入框，输入关键词，自动复制到剪切板。
安装rofi体验一下。

search init找不到config文件

我在search init时抛出错误panic: Fatal error config file: Config File "config" Not Found ，我该如何解决

我最新版咋个和你不一样

我的内容为啥少些