tmap-agents 0.1.0__tar.gz

tmap_agents-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

tmap_agents-0.1.0/NOTICE

@@ -0,0 +1,22 @@
+Treasure Map
+Copyright (C) 2026 JoeyZzZzZz
+
+This product includes software developed by JoeyZzZzZz
+(https://github.com/JoeyZzZzZz/treasure-map).
+
+src/treasure_map/lib/diff/ghidra/FallbackBinExport2Builder.java is a modified
+copy of BinExport2Builder.java from BinExport
+(https://github.com/google/binexport), Copyright 2019-2024 Google LLC, licensed
+under the Apache License, Version 2.0. The changes are listed at the top of the
+file.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+this file except in compliance with the License. You may obtain a copy of the
+License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed
+under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.

tmap_agents-0.1.0/PKG-INFO

@@ -0,0 +1,356 @@
+Metadata-Version: 2.4
+Name: tmap-agents
+Version: 0.1.0
+Summary: A firmware map for your AI agent. Treasure Map draws the map; your agent finds the treasure.
+Author-email: JoeyZzZzZz <86097996+JoeyZzZzZz@users.noreply.github.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/JoeyZzZzZz/treasure-map
+Project-URL: Repository, https://github.com/JoeyZzZzZz/treasure-map
+Project-URL: Changelog, https://github.com/JoeyZzZzZz/treasure-map/blob/main/CHANGELOG.md
+Keywords: iot,firmware,security,reverse-engineering,patch-diff
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Security
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: pyelftools>=0.31
+Requires-Dist: pydantic>=2.11
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: click>=8.2
+Requires-Dist: mcp<2,>=1.21.2
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.1; extra == "dev"
+Requires-Dist: ruff==0.16.0; extra == "dev"
+Requires-Dist: mypy<2.0,>=1.10; extra == "dev"
+Requires-Dist: types-PyYAML>=6.0; extra == "dev"
+Dynamic: license-file
+
+# Treasure Map
+
+[English](README.md) | [中文](README.zh.md)
+
+**A firmware map for your AI agent. Treasure Map draws the map; your agent finds the treasure.**
+
+Treasure Map turns an unpacked firmware filesystem into facts your coding agent (Claude Code, Codex,
+Cursor and others) reads through a bundled MCP server: every dangerous call it recognizes, where the
+data reaching it comes from, and — just as important — what it could not determine. Every fact points
+at an exact binary, function and address. It has no agent of its own and runs no model; deciding which
+lead is a real bug is your agent's job. **Facts are the tool's job; reasoning is the model's.**
+
+It does two things:
+
+- **Map one firmware.** Every place the compiled code runs a shell command, copies into a memory
+  buffer, formats a string or opens a file by path — each marked with what is known, what is not, and
+  why. Your agent picks the views it needs, reads the code, and records its verdicts.
+- **Diff two versions.** Every function that changed between two releases, grouped by what happened
+  around its dangerous calls. Instead of thousands of functions, your agent reviews the few that
+  changed: is this a security fix, and which 1-day does it close in the old version? Is the fix
+  complete, or does the same call survive somewhere else? Can the new check be bypassed?
+
+> **Developer preview.** Commands, config, the atlas database and MCP tool fields may change
+> incompatibly between versions. After upgrading, see [Upgrading](#upgrading).
+
+---
+
+## Quick start
+
+**1. Install.** One command installs `tmap` and then runs `tmap init`, which sets up the toolchain
+(JDK 21, Ghidra 11.4.3, BinExport, BinDiff 8 — reusing what you already have) and registers the MCP
+server with the agents you pick. No API key is needed. Restart your agent when it finishes.
+
+```bash
+curl -LsSf https://github.com/JoeyZzZzZz/treasure-map/releases/latest/download/install.sh | sh
+```
+
+**2. Map a firmware.** The input is an *already-extracted* filesystem — unpack the image first with
+any extraction tool you like.
+
+```bash
+tmap scan ./firmware.extracted -w my-fw
+```
+
+Then ask your agent:
+
+```text
+Audit firmware my-fw using treasure-map.
+Choose for yourself which views of its candidate map to review
+(by sink, by data source, or by any other layer) and find the issues in them:
+open a lead's pseudocode, trace where its input comes from, and judge it yourself.
+The candidates are leads to verify, not confirmed bugs.
+Record each conclusion with annotate so the next session starts from it.
+```
+
+**3. Or diff two versions.**
+
+```bash
+tmap scan ./fw_v1.extracted -w fw-v1
+tmap scan ./fw_v2.extracted -w fw-v2
+tmap diff --before fw-v1 --after fw-v2
+```
+
+```text
+Review the diff fw-v1 → fw-v2 using treasure-map.
+Start from the function patch view (get_diff_patch_view):
+for each changed function, compare the pseudocode of both versions
+and decide whether the change does something real, such as a new check or a changed bound.
+Record each judgement with annotate_diff.
+```
+
+That is all you run by hand. `scan` is the slow part — one Ghidra pass per binary, with progress shown.
+Re-running with the same `-w` resumes where it stopped; a different `-w` keeps another firmware
+alongside. Everything you scan and diff accumulates in one **atlas** (`~/.treasure-map/atlas.db`),
+and the agent picks which firmware or diff to work on — no reconfiguration per scan.
+
+---
+
+## What your agent gets
+
+### The firmware map
+
+Each candidate is one point on the map, annotated on several equal layers: where the data comes
+from, how much of it an attacker controls, who wrote the value, how the spot is reached, whether
+anything filters it on the way, and whether the function was fully analyzed. Each layer reads
+**YES**, **NO** or an explicit **UNKNOWN** that says what is missing and why.
+
+There is no score. The default view puts the highest-impact calls that nothing has proven safe first;
+your agent can re-sort or filter by any layer. Re-sorting changes the order, never the set of
+candidates. In every view, only a *proven-safe* fact can push a candidate down; an UNKNOWN never can.
+
+Command-execution, buffer-copy and format-string calls come with in-function argument provenance.
+Path and file calls are covered for detection and ranking; their controllability comes from a
+text-level reading, and is marked as such.
+
+### The patch diff
+
+`tmap diff` compares every binary whose content changed, in parallel, running Ghidra, BinExport and
+BinDiff end to end — you never handle an intermediate file. (`--binary NAME` limits it to one.)
+
+- **A function-level patch view.** One entry per changed function pair, grouped by what happened
+  around its dangerous calls: a call that now goes somewhere else, a dangerous call that is still
+  there, a reading that could not be decided. An optional ordering puts the entries most likely to
+  matter first.
+- **What a similarity score misses.** BinDiff's similarity ignores constants: a function can read
+  `similarity=1.0` while a buffer length went from `0x40` to `0x3f`. tmap adds an
+  address-normalized pseudocode comparison (truly identical, or only similar) and flags a changed
+  length constant at a copy or format call.
+- **Blind spots stated, not hidden.** A binary that could not be diffed is listed as such, never
+  counted as unchanged. A function with no counterpart is *undetermined* — it may have been inlined
+  or moved — never reported as removed or added.
+- **Judgments that stay.** Your agent records on each entry whether the change does something real,
+  and can carry that judgment over to the affected candidate in the firmware map.
+
+If the stored scans or diffs were made by an older tmap, `tmap diff` brings them up to date first and
+says what that involves before it starts.
+
+---
+
+## Why facts, not verdicts
+
+A scanner hands you findings and a severity score — a verdict you then have to trust or re-check. A
+modern agent already reads and reasons about one function well. What it cannot do is cover a whole
+root filesystem, or every changed binary between two releases, the same way twice — or say where it
+did not look. That is the half Treasure Map does.
+
+- **UNKNOWN is never "safe".** A fact it could not establish stays UNKNOWN; a binary the diff could
+  not analyze never reads as unchanged.
+- **Leads, not verdicts.** A candidate is a lead to verify, not a confirmed vulnerability; a changed
+  function is a change to review, not a confirmed fix. Reachability is graded one function at a time
+  — this is **not** a taint-propagation engine, and it never claims a path is unreachable.
+- **Judgments that accumulate.** Your agent's conclusions live in an annotation layer over the
+  read-only facts, so a multi-session audit picks up where it left off — with any model or agent. A
+  judgment is flagged for review again the moment the facts under it change.
+
+---
+
+## Install details
+
+`tmap init` installs the toolchain for you, or reuses what you already have if it passes the checks:
+
+| Tool | Version | Used for |
+|---|---|---|
+| **JDK** | 21 (a JDK, not a JRE) | running Ghidra (JDK 11/17 make Ghidra 11.4.3 fail to launch) |
+| **Ghidra** | 11.4.3 | decompiling every binary, headless |
+| **BinExport** | for Ghidra 11.4.3 | exporting binaries for `tmap diff` |
+| **BinDiff** | 8 | matching functions between two versions |
+
+Downloads come from pinned URLs and are checked against a pinned size and sha256 before anything is
+unpacked; they go to `~/.treasure-map/toolchain/`.
+
+| Platform | Status |
+|---|---|
+| Linux x86_64 (including WSL2) | supported |
+| macOS on Apple Silicon | supported |
+| macOS on Intel | runs the same toolchain; not acceptance-tested |
+| Linux arm64, native Windows | not supported (no Ghidra decompiler / BinDiff build) — on Windows use WSL2 |
+
+`tmap init`, step by step:
+
+1. **finds** an existing JDK 21, Ghidra 11.4.3, BinExport and BinDiff 8 (config, `GHIDRA_HOME`,
+   `JAVA_HOME`, PATH, common install locations) and checks each at file level;
+2. **asks** for a path, or offers the pinned download, for anything missing;
+3. **lists your agents** (Claude Code, Codex, Cursor, Claude Desktop, dsh), pre-selecting those
+   installed here — Space to unselect, Enter to confirm;
+4. **shows the plan** (every download with URL, size and sha256; every file it will change) and asks
+   `Apply N changes? [Y/n]`;
+5. **applies** it, runs the **doctor**, and prints the two prompts shown in [Quick start](#quick-start).
+
+Run it again any time; an up-to-date setup reports "everything current, nothing to do".
+
+<details>
+<summary>Flags and other ways to install</summary>
+
+- `install.sh --dry-run` prints the plan and changes nothing. The script installs
+  [uv](https://docs.astral.sh/uv/) if it is missing (without editing your shell rc), then `tmap`
+  (PyPI package `tmap-agents`) with a uv-managed Python 3.11.
+- Already have uv: `uv tool install --python 3.11 tmap-agents`, then `tmap init`.
+- `tmap init` flags: `--dry-run` (plan only), `--yes` (no questions, downloads included; registers
+  only the agents named with `--client`), `--non-interactive` (no questions, no downloads),
+  `--ghidra / --java-home / --bindiff PATH` (use exactly this), `--offline DIR` / `--mirror URL`
+  (archives from elsewhere, same checksums).
+- `tmap doctor` re-runs the checks and writes nothing.
+
+</details>
+
+---
+
+## Connect your agent
+
+`tmap init` registers the MCP server for you; restart the agent afterwards.
+
+### Registering by hand
+
+The command is always `<absolute path of tmap> mcp` (`command -v tmap` prints the path).
+
+| Agent | Register |
+|---|---|
+| **Claude Code** | `claude mcp add -s user treasure-map -- "$(command -v tmap)" mcp` |
+| **Codex** | `codex mcp add treasure-map -- "$(command -v tmap)" mcp` |
+| **Cursor / Claude Desktop / other JSON clients** | add the block below to the client's MCP config file |
+| **dsh** | `tmap init --client dsh` adds the entry to `$DSH_HOME/cordis.patch.yml` (default `~/.dsh`), the layer every profile reads |
+
+```json
+{
+  "mcpServers": {
+    "treasure-map": {
+      "command": "/absolute/path/to/tmap",
+      "args": ["mcp"]
+    }
+  }
+}
+```
+
+Config files: Cursor `~/.cursor/mcp.json`; Claude Desktop
+`~/Library/Application Support/Claude/claude_desktop_config.json` (macOS); Windsurf
+`~/.codeium/windsurf/mcp_config.json`; Gemini CLI `~/.gemini/settings.json`. With Claude Code use
+`-s user`: a project-local entry of the same name hides it inside that project (`tmap doctor` points
+such entries out).
+
+---
+
+## Upgrading
+
+```bash
+tmap update                                 # install the newest tmap
+tmap rescan                                 # re-scan every run an older tmap made
+tmap diff --before fw-v1 --after fw-v2      # re-runs the diffs that are out of date
+```
+
+`tmap update` checks PyPI for the newest version, shows its plan and asks once (`--check` only
+reports, `--yes` skips the question). It replaces the installed version, names any other `tmap` on
+PATH that would shadow the new one, and then starts the new version's `tmap init` by itself — you do not type it. That init also
+tells you how many of your runs predate the new version. A diff made by an older tmap, or with
+another toolchain, is recomputed once.
+
+With no arguments, `tmap rescan` re-scans every run an older tmap made. To rescan a single firmware,
+name its run — the `-w` name you scanned it with, unless you set `--run-id` — for example
+`tmap rescan fw-v1`. `--dry-run` lists what would be rescanned and why, without running anything.
+
+`tmap update` works on the install the one-line installer makes (`uv tool`). Installed another way,
+update it the same way you installed it.
+
+---
+
+## Troubleshooting
+
+Run `tmap doctor` first. Each check shows ✅, ⚠ (works, worth knowing), `·` (information), ❌, or `?`
+(could not be determined — never shown as ✅); it exits non-zero on any ❌ or `?`.
+
+- **`tmap: command not found`** — the tool's bin directory is not on PATH. Run
+  `uv tool update-shell`, then open a new shell.
+- **`ghidra` / `java` / `bindiff` ❌** — run `tmap init` again for the pinned download, or pass
+  `--ghidra / --java-home / --bindiff PATH`. On WSL keep everything on the Linux side, not under
+  `/mnt/c/...`.
+- **`binexport` ❌ "two copies"** — Ghidra loads extensions from both its own `Ghidra/Extensions` and
+  its user settings directory; remove one of the two.
+- **A binary is missing from a diff** — ask your agent for `list_diff_blindspots`, which names every
+  binary the diff could not analyze and why. After fixing a toolchain problem,
+  `tmap diff … --force-retry` tries them again.
+- **Your own Ghidra 11.4.3 starts with an unexpected JDK** — Ghidra remembers the JDK it last ran with
+  (`java_home.save` in its settings directory), and tmap's runs record the JDK tmap uses there. Set
+  `JAVA_HOME` when you start Ghidra yourself.
+
+---
+
+## Uninstalling
+
+```bash
+tmap uninstall
+```
+
+It shows its plan, asks once, then removes the treasure-map entry from each agent, removes the
+toolchain `tmap init` downloaded (never a JDK, Ghidra or BinDiff you installed yourself), and offers
+to remove the program itself.
+
+**Your data stays:** `~/.treasure-map/config.yaml`, `.env`, the **atlas** and the workspaces —
+reinstalling reuses all of it. `tmap uninstall --purge-data` deletes them too, after you type a
+confirmation phrase (not recoverable), but only what is provably tmap's: the atlas, what a scan
+wrote in each workspace directory holding a tmap `analysis.db`, and the `config.yaml` / `.env` that
+`tmap init` wrote. The workspace base itself stays (unless it is the default inside
+`~/.treasure-map` and left empty), and nothing in it is deleted when it is your home directory or
+above it. Anything else — a file you wrote yourself, in a workspace or beside one — is kept and
+listed.
+
+<details>
+<summary>Details</summary>
+
+- An agent entry named treasure-map that does not run tmap is left alone, and so is one inside a dsh
+  profile's own file.
+- The program is removed with `uv tool uninstall tmap-agents` when it was installed with `uv tool`;
+  installed another way, `tmap uninstall` tells you to remove it the same way.
+- `--dry-run` prints the plan and changes nothing; `--yes` skips the questions, but never the
+  confirmation phrase.
+
+</details>
+
+---
+
+## Intended use & legal
+
+**Purpose.** Treasure Map supports defensive security auditing and vulnerability research on
+firmware. It produces analysis leads; by design it does **not** generate proof-of-concept exploits,
+payloads, shellcode, or other directly weaponizable output.
+
+**Lawful use is yours to ensure.** Only analyze firmware you lawfully possess — a device you own, or
+firmware made genuinely public by its vendor and obtained **without** bypassing any login, paywall
+or access control. Even lawfully obtained firmware may carry license, terms-of-service or contractual
+restrictions on reverse engineering; you are responsible for reviewing them.
+
+**Findings are candidates, not verdicts.** Output requires independent human verification and is not
+a confirmed vulnerability.
+
+**No warranty.** The tool is provided "as is". You are solely responsible for how you use it and for
+ensuring your activity is lawful in your jurisdiction. If unsure, consult qualified legal counsel.
+
+---
+
+## Contributing
+
+Issues and pull requests are welcome — see [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## License
+
+[Apache-2.0](LICENSE).