aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorblasty <blasty@local>2026-08-09 22:55:38 +0200
committerblasty <blasty@local>2026-08-09 22:55:38 +0200
commit90bbe6de2af245af37bfdc66796c2fa7d6dc27e0 (patch)
tree1ad296a31419d793cb6d2cc4c073120618573873 /README.md
parentSPEED: replace the historical backend table with a real 0.3.1 vs 0.3.2 A/B (diff)
downloadida-tui-90bbe6de2af245af37bfdc66796c2fa7d6dc27e0.tar.gz
ida-tui-90bbe6de2af245af37bfdc66796c2fa7d6dc27e0.tar.xz
ida-tui-90bbe6de2af245af37bfdc66796c2fa7d6dc27e0.zip
Ship the idatui agent skill in-repo at .agents/skills/
Follows the Agent Skills standard (agentskills.io) rather than a contrib/ dir: harnesses discover .agents/skills/<name>/SKILL.md automatically from the repo root, and it is vendor-neutral (not .claude/ or .pi/ specific). Not a verbatim copy of the local one -- it was ~85% generic and the rest had to go before redistributing: * the backend is described as a normal pyproject dependency, with the editable-git-checkout setup demoted to a conditional note (that is one maintainer's layout, but the 'upstream pull silently swaps the backend' warning is worth keeping for anyone who does it); * personal agent tooling (bgrun/waitfor wrappers) replaced by the underlying lesson -- a backgrounded subshell holds the inherited stdout, so redirect all three fds -- which is true without those scripts; * maintainer commit authorship dropped; * absolute ~/dev paths made relative to the repo root; ~/ida-venv kept but marked as this project's assumption, matching the README. Also fixes the README's stale full-run count (788/~2m -> 1031/~50s), lists the docs that were missing from the index, and warns that a user-level skill of the same name shadows this one -- otherwise a personal copy silently wins and the in-repo copy rots.
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 17 insertions, 1 deletions
diff --git a/README.md b/README.md
index d301c2f..5993d6b 100644
--- a/README.md
+++ b/README.md
@@ -175,7 +175,7 @@ test is empty while the protocol works fine).
```sh
python3 tests/run.py --fast # 380 checks, <1s, any python3 — between edits
python3 tests/run.py --list # what runs, and what needs IDA
-python3 tests/run.py # 788 checks, ~2m — before a commit
+python3 tests/run.py # 1031 checks, ~50s — before a commit
```
Every suite declares `NEEDS_IDA`; `--fast` runs only the pure ones (stdlib, no
@@ -194,6 +194,22 @@ flake, and the four ways a test here wastes minutes.
- [`docs/RPC.md`](docs/RPC.md) — the RPC protocol, verb by verb
- [`docs/GRAPH_VIEW.md`](docs/GRAPH_VIEW.md) — how the graph is laid out
+- [`docs/CODEMODE_UPSTREAM.md`](docs/CODEMODE_UPSTREAM.md) — findings from porting to
+ IDA Code Mode, and which are fixed upstream
+- [`docs/PROJECTS.md`](docs/PROJECTS.md), [`docs/SPLIT_VIEW.md`](docs/SPLIT_VIEW.md),
+ [`docs/TEXTUAL_NOTES.md`](docs/TEXTUAL_NOTES.md),
+ [`docs/PAGING_FINDINGS.md`](docs/PAGING_FINDINGS.md),
+ [`docs/TRISKEL_EVAL.md`](docs/TRISKEL_EVAL.md)
+
+### Working on this with an LLM agent
+
+[`.agents/skills/idatui/SKILL.md`](.agents/skills/idatui/SKILL.md) is an
+[Agent Skills](https://agentskills.io/specification) skill describing the
+architecture, the run/test loop and the traps that cost real time here (Code Mode,
+Textual, the graph engine, terminal graphics). Harnesses implementing that standard
+discover `.agents/skills/` automatically; others can be pointed at the file directly.
+A user-level skill of the same name takes precedence, so delete or symlink yours if
+you keep a personal copy.