Skip to content

armgit / Ix

Public Imported from GitHub
0

Understand any codebase instantly. System intelligence for codebases, built for humans and AI.

fix(deps): stop the prerequisites doc being parsed as a pip manifest (#332)

Joseph Mikhail1ab2e0882f46
diff --git a/README.md b/README.md
index 97977b9a..2d148f69 100644
--- a/README.md
+++ b/README.md
@@ -159,6 +159,8 @@ All you need beforehand is a terminal with `curl` (or `wget`). On Windows, insta
Works on macOS, Linux, and Windows, on both x86-64 and arm64.
+For the full list, including the endpoints the installer reaches and the directories it creates, see [docs/prerequisites.md](docs/prerequisites.md).
+
## Supported Languages
Ix parses and extracts symbols, calls, and imports across 26 languages, and recognizes several more config and data formats.
diff --git a/requirements.txt b/docs/prerequisites.md
similarity index 81%
rename from requirements.txt
rename to docs/prerequisites.md
index 1524be7b..b3dfb2a5 100644
--- a/requirements.txt
+++ b/docs/prerequisites.md
@@ -1,3 +1,27 @@
+# System Prerequisites
+
+Everything the Ix installer checks for and installs, and the endpoints and
+directories it touches. Reference documentation — not a dependency manifest.
+
+> **Do not move this back to `requirements.txt`, and do not give it a `.txt` or
+> `.in` extension.**
+>
+> Every entry below is a *system* package — curl, git, node, docker, ripgrep —
+> and none is a PyPI dependency of this repo. While this file lived at
+> `requirements.txt`, GitHub's dependency graph parsed it as pip and recorded
+> nine phantom PyPI packages against the repo; seven of those (`arangodb`,
+> `docker`, `docker-compose`, `homebrew`, `node`, `npm`, `ripgrep`) are real
+> PyPI names owned by unrelated projects, so the SBOM asserted dependencies
+> that do not exist. The graph job then failed outright on
+> `ix-memory-layer==latest`, which pip cannot parse.
+>
+> The extension matters as much as the name: Dependabot's pip fetcher
+> enumerates `.txt` and `.in` files in the repo root *and one directory deep*,
+> then decides by filename or by whether every line parses as a requirement.
+> Keeping this as Markdown puts it outside that scan entirely, rather than
+> relying on one line staying unparseable.
+
+```
# Ix — System Requirements
#
# Everything listed here is checked and installed by the install script:
@@ -114,3 +138,4 @@ ripgrep>=13
#
# Wrapper: /usr/local/bin/ix (if writable) or ~/.local/bin/ix (fallback)
# Ports: 8090 (Memory Layer), 8529 (ArangoDB) — localhost only
+```