Install red-tldr with Homebrew

Project links

• Homepage
• Repository
• Package manager page

Commands and aliases

• red-tldr

Project history

red-tldr began as a lightweight lookup tool for experienced red-team operators who remember fragments of commands but need fast access to exact syntax and operational notes. It uses a curated, locally searchable database rather than general web search.

The project later added Bleve-powered full-text and fuzzy search, structured text, JSON, and Markdown output, richer entries with MITRE ATT&CK mappings, and an independently maintained red-tldr-db repository.

Version 0.5.0 introduced a built-in Model Context Protocol server supporting both standard input/output and Streamable HTTP transports.

Adoption history

red-tldr is available through Homebrew on macOS, the Arch User Repository, downloadable release archives, and source builds. Its offline-first design avoids cloud or API-key dependencies.

From version 0.5.0, the project broadened its audience beyond direct terminal use by embedding an MCP server for AI assistants such as Claude Desktop and Cursor.

How it is used

Operators search using a complete keyword or a remembered fragment and choose among ranked matches. Results can be printed for terminal reading or emitted as JSON or Markdown.

The update command rebuilds the local search index, while upgrade downloads the latest database from GitHub. The serve command exposes the knowledge base to MCP clients over stdio or Streamable HTTP.

The default configuration at ~/.red-tldr/config.toml controls automatic index rebuilding, database downloads, the database storage path, and colored output. No API credentials are required.

Why package nerds care

red-tldr packages an operator-maintained offensive-security knowledge base behind a fast local CLI. Its separation of the search program from a YAML database, deterministic offline behavior, structured output, and built-in MCP endpoint make it an unusual bridge between traditional command cheat sheets and agent-accessible security references.

Timeline

• Initial project: Introduced a lightweight local lookup tool for red-team commands and key operational notes.
• Version 0.5.0: Added an MCP server and an enhanced, backward-compatible data model.
• Current packaging: Distributed through Homebrew, AUR, release binaries, and source builds.

Related projects

• red-tldr-db is the companion repository containing the YAML knowledge-base entries searched by the client.
• The project's concise command-reference model is conceptually related to tldr pages, but it is specialized for offensive-security commands and experienced red-team workflows.

Sources

• Companion database linked by the official README: https://github.com/Rvn0xsy/red-tldr-db
• Official project site: https://payloads.online/red-tldr
• Official repository and README: https://github.com/Rvn0xsy/red-tldr
• Package availability: source_facts.package-manager