> For the complete documentation index, see [llms.txt](https://trs.deadbits.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://trs.deadbits.ai/trs-documentation.md).

# trs: documentation

Threat intelligence report analysis via LLM

## Overview 🏕️

`trs` is a command line tool that leverages an LLM (OpenAI) to chat with and analyze cyber threat intelligence reports and blogs.

Supply a threat report to pre-built commands for summarization, MITRE TTP extraction, mindmap creation, and identification of detection opportunities, or run your own custom prompts against the report content.

Each URL's text content is stored in a Chroma vector database so you can have QnA / Retrieval-Augmented-Generation (RAG) chat sessions with the processed reports.

The OpenAI model `gpt-3.5-turbo-16k` is used in order to support larger contexts more easily, but feel free to swap this out for the `gpt-4-32k` model in the config if you have access.

* **Repo**: <https://github.com/deadbits/trs>

## Quick links

{% content-ref url="/pages/GGt99ahnes2jQA4hT6QO" %}
[Install](/overview/install.md)
{% endcontent-ref %}

{% content-ref url="/pages/i6A6yfigI9z1YJWhPFcC" %}
[Use](/overview/use.md)
{% endcontent-ref %}

{% content-ref url="/pages/W9k87tOlOSBhZ6rWLZ6i" %}
[Screenshots](/overview/screenshots.md)
{% endcontent-ref %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://trs.deadbits.ai/trs-documentation.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.