heimdall-code 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,17 @@
1
+ {
2
+ "$schema": "https://anthropic.com/claude-code/marketplace.schema.json",
3
+ "name": "heimdall",
4
+ "description": "Code knowledge graph for AI agents -- callers, blast radius and call paths from a SQLite index instead of a grep sweep.",
5
+ "owner": {
6
+ "name": "Bogdan Sapovskyi",
7
+ "url": "https://github.com/stPhoenix"
8
+ },
9
+ "plugins": [
10
+ {
11
+ "name": "heimdall",
12
+ "description": "Indexes any repository into a SQLite property graph and serves it over MCP: what calls this, what breaks if I change it, how does A reach B.",
13
+ "source": "./",
14
+ "category": "development"
15
+ }
16
+ ]
17
+ }
@@ -0,0 +1,13 @@
1
+ {
2
+ "name": "heimdall",
3
+ "version": "0.1.0",
4
+ "description": "A code knowledge graph that sees everything. Indexes any repo into a SQLite property graph and answers what calls this, what breaks if I change it, and how does A reach B.",
5
+ "author": {
6
+ "name": "Bogdan Sapovskyi",
7
+ "url": "https://github.com/stPhoenix"
8
+ },
9
+ "homepage": "https://github.com/stPhoenix/heimdall",
10
+ "repository": "https://github.com/stPhoenix/heimdall",
11
+ "license": "Apache-2.0",
12
+ "keywords": ["code-intelligence", "knowledge-graph", "mcp", "static-analysis", "tree-sitter"]
13
+ }
@@ -0,0 +1,56 @@
1
+ # Publish heimdall-code to PyPI when a v* tag is pushed.
2
+ #
3
+ # No API token anywhere: PyPI trusted publishing exchanges GitHub's OIDC token for a
4
+ # short-lived upload credential, which is why `id-token: write` is the one permission
5
+ # granted. Configure the publisher once at
6
+ # https://pypi.org/manage/project/heimdall-code/settings/publishing/
7
+ # (or as a pending publisher, before the first release) with:
8
+ # owner stPhoenix / repo heimdall / workflow release.yml / environment pypi
9
+ name: Release
10
+
11
+ on:
12
+ push:
13
+ tags: ["v*"]
14
+ workflow_dispatch: # re-run a failed publish without cutting another tag
15
+
16
+ permissions: {}
17
+
18
+ jobs:
19
+ publish:
20
+ runs-on: ubuntu-latest
21
+ environment: pypi
22
+ env:
23
+ # the floor in pyproject.toml, so the gate tests what the package claims to support
24
+ # rather than whatever the runner image ships this month
25
+ UV_PYTHON: "3.12"
26
+ permissions:
27
+ contents: read
28
+ id-token: write
29
+ steps:
30
+ - uses: actions/checkout@v5
31
+ - uses: astral-sh/setup-uv@v9.0.0 # setup-uv stopped publishing moving major tags
32
+ with:
33
+ enable-cache: true
34
+
35
+ - run: uv sync --locked
36
+
37
+ # a PyPI version is immutable, so catch a mismatched tag before the upload, not after
38
+ - name: Version matches the tag
39
+ if: startsWith(github.ref, 'refs/tags/v')
40
+ run: |
41
+ v=$(python -c 'import tomllib; print(tomllib.load(open("pyproject.toml","rb"))["project"]["version"])')
42
+ [ "v$v" = "$GITHUB_REF_NAME" ] || { echo "pyproject.toml says $v, tag says $GITHUB_REF_NAME"; exit 1; }
43
+
44
+ - run: uv run ruff check .
45
+ - run: uv run pytest -q
46
+
47
+ - run: uv build
48
+
49
+ # the wheel is what users actually get, and a PyPI version cannot be replaced:
50
+ # install it clean and drive it once before the upload, not after
51
+ - name: Smoke test the wheel
52
+ run: |
53
+ uv run --isolated --no-project --with dist/*.whl heimdall index . --json
54
+ uv run --isolated --no-project --with dist/*.whl heimdall stats
55
+
56
+ - run: uv publish --trusted-publishing always
@@ -0,0 +1,10 @@
1
+ __pycache__/
2
+ *.py[cod]
3
+ .venv/
4
+ .heimdall/
5
+ dist/
6
+ build/
7
+ *.egg-info/
8
+ .pytest_cache/
9
+ .ruff_cache/
10
+ .idea/
@@ -0,0 +1,8 @@
1
+ {
2
+ "mcpServers": {
3
+ "heimdall": {
4
+ "command": "uvx",
5
+ "args": ["--from", "heimdall-code", "heimdall", "mcp"]
6
+ }
7
+ }
8
+ }
@@ -0,0 +1,44 @@
1
+ # Changelog
2
+
3
+ Notable changes, newest first. Versions follow [semver](https://semver.org); until 1.0
4
+ the graph schema and the JSON payloads may still move.
5
+
6
+ ## 0.1.0 — unreleased
7
+
8
+ First release.
9
+
10
+ ### Added
11
+
12
+ - **Index.** `heimdall index` builds `.heimdall/graph.db` in four passes — discover
13
+ (`git ls-files`, submodules included), parse (tree-sitter, one process per core),
14
+ resolve, FTS5. 1.7 s and 48 MB for Django's 2,927 files.
15
+ - **Query.** `search`, `context`, `impact`, `trace`, `stats`, `projects` and a read-only
16
+ `sql` escape hatch over a two-table schema. Every command takes `--json` and
17
+ `-p/--project`.
18
+ - **18 languages**, declared as data in `parse.py` and each covered by a test that fails
19
+ if a grammar renames a node type.
20
+ - **MCP server** (`heimdall mcp`): one process serves every repo in
21
+ `~/.heimdall/registry.json`, eight tools returning assembled answers rather than raw
22
+ edges.
23
+ - **`heimdall install [claude|codex|all]`** — writes `~/.claude.json`, `./.mcp.json`,
24
+ `~/.codex/config.toml` or `./.codex/config.toml`, merging around your existing
25
+ settings; `--cli` installs the skill instead of the server.
26
+ - **Claude Code plugin**: `/plugin marketplace add stPhoenix/heimdall`.
27
+ - **Benchmark** (`bench/`) against GitNexus and graphify, graded by a CPython `ast`
28
+ oracle.
29
+
30
+ ### Resolution fixes found by the benchmark
31
+
32
+ Each of these was a wrong answer before it was a test:
33
+
34
+ - Imports resolve per scope, so a function with its own `from x import y` is no longer
35
+ matched against the whole file.
36
+ - `pkg/main.py` is reachable as `pkg.main`, not only as `pkg`.
37
+ - `as` renames are followed home — but only for in-repo targets, so
38
+ `from asyncio import run as arun` cannot bind to your own `run`.
39
+ - A decorator is a call by the function it wraps, not by the enclosing class. Worth 26%
40
+ of imported-call recall on Django.
41
+ - Recursion produces an edge.
42
+ - A class name used as a receiver resolves inside that class — including when several
43
+ classes share the name, because the one that defines the member is the one that was
44
+ meant. Took *who calls `Model.check`* from 0% to 94% precision.
@@ -0,0 +1,40 @@
1
+ # Heimdall
2
+
3
+ A code knowledge graph in SQLite. See [CONTRIBUTING.md](CONTRIBUTING.md) for the module
4
+ map, how to add a language, and the release steps — read it before changing anything
5
+ structural.
6
+
7
+ ## Working here
8
+
9
+ ```console
10
+ uv run ruff format . && uv run ruff check . && uv run pytest # the gate, under a second
11
+ uv run python -m heimdall.install # the install self-check alone
12
+ uv run heimdall index . && uv run heimdall context Graph.impact # dogfood
13
+ ```
14
+
15
+ Use Heimdall on itself instead of grepping for callers; if the answer looks wrong, that
16
+ is a bug worth a fixture.
17
+
18
+ ## Constraints that are load-bearing
19
+
20
+ - **Two runtime dependencies** (tree-sitter, mcp) and the standard library. "No embedded
21
+ graph engine, no server, no embeddings" is the pitch — a new dependency needs an
22
+ argument, not a convenience.
23
+ - **Language support is data.** Add rows to the dicts in `parse.py`, never a per-language
24
+ module. If a language will not fit the generic walker, say so rather than special-casing
25
+ it in the walker.
26
+ - **Queries are one SQL statement.** Anything expensive is precomputed in `index.py`.
27
+ - **`graph.query()` is a trust boundary** — read-only, one statement. Don't widen it.
28
+ - **Confidence is the honesty mechanism.** A name-only match is `0.3` and must stay
29
+ labelled as such; never promote a guess to look certain.
30
+ - `install.py` writes user config files: keep writes atomic, keep unparseable files
31
+ reported rather than replaced.
32
+
33
+ ## Claims
34
+
35
+ The README and `bench/` state numbers. Don't add or edit one without rerunning the
36
+ benchmark that produced it (`python bench/compare.py`, `python bench/questions.py`), and
37
+ keep the rows that don't flatter us — the limitations section is deliberate.
38
+
39
+ Every resolution bug gets the smallest fixture that would have caught it, in
40
+ `tests/test_heimdall.py`. One test file, no fixtures directory, no frameworks.
@@ -0,0 +1,70 @@
1
+ # Developing Heimdall
2
+
3
+ ```console
4
+ git clone https://github.com/stPhoenix/heimdall && cd heimdall
5
+ uv sync # Python 3.12+, runtime deps plus pytest and ruff
6
+ uv run pytest # or: uv run python tests/test_heimdall.py
7
+ uv run ruff format . && uv run ruff check . # config lives in pyproject.toml
8
+ uv run heimdall index . # dogfood: the graph of this repo
9
+ ```
10
+
11
+ Ruff owns the formatting, so don't argue with it — 120 columns, its line breaks. What it
12
+ cannot do for you: `from __future__ import annotations`, a docstring saying *why* the
13
+ module exists rather than what it does, and the Apache header on every new file.
14
+
15
+ There is no CI. The gate is `uv run pytest && uv run ruff check .` before you push.
16
+
17
+ ## The map
18
+
19
+ | | |
20
+ |---|---|
21
+ | `heimdall/parse.py` | tree-sitter → symbols, calls, imports, heritage. Language support is **data** (`EXT_LANG`, `DEFS`, `CALL_NODES`, `IMPORT_NODES`, `HERITAGE_*`), walked by one generic function. |
22
+ | `heimdall/index.py` | the four passes: discover → parse (process pool) → resolve → store. Everything a query needs is precomputed here. |
23
+ | `heimdall/graph.py` | schema + reads. Two tables, recursive CTEs, FTS5. `query()` is the read-only SQL gate. |
24
+ | `heimdall/cli.py` | argparse; every command takes `--json` and `-p/--project`. |
25
+ | `heimdall/mcp_server.py` | one server, every registered repo. Tools return assembled answers, not raw edges. |
26
+ | `heimdall/registry.py` | `~/.heimdall/registry.json` (override with `HEIMDALL_HOME`). |
27
+ | `heimdall/install.py` | writes agent configs. Self-checks against a fake `$HOME`: `python -m heimdall.install`. |
28
+ | `skills/heimdall/SKILL.md` | the CLI skill — one copy, force-included into the wheel as `heimdall/SKILL.md`. |
29
+
30
+ ## Adding a language
31
+
32
+ Rows in three dicts in `parse.py` — definition node types, call node types, import node
33
+ types — plus a snippet in `SNIPPETS` in `tests/test_heimdall.py`. No new module. The test
34
+ asserts the snippet still yields symbols *and* call edges, so a grammar renaming a node
35
+ type fails the build instead of quietly emptying the graph.
36
+
37
+ ## Tests
38
+
39
+ One file, `tests/test_heimdall.py`, runnable with or without pytest. Every resolution bug
40
+ found so far is pinned there by a fixture that reproduces it — function-scoped imports,
41
+ `as` renames, class receivers, ambiguous receivers, recursion, decorators. Fix a
42
+ resolution bug, add the smallest fixture that would have caught it.
43
+
44
+ ## Benchmark
45
+
46
+ `bench/` scores Heimdall against GitNexus and graphify on a real repo, graded by a CPython
47
+ `ast` oracle — see [bench/README.md](bench/README.md). It is not part of the test suite
48
+ (it wants Node, npm and a clone of Django), but it is what a change to resolution should
49
+ be measured with: `python bench/compare.py /path/to/django` and `python bench/questions.py`.
50
+
51
+ ## Release
52
+
53
+ Bump `version` in `pyproject.toml`, `__version__` in `heimdall/__init__.py` and `version`
54
+ in `.claude-plugin/plugin.json` together, add the [CHANGELOG](CHANGELOG.md) entry, then:
55
+
56
+ ```console
57
+ git tag v0.1.0 && git push origin v0.1.0
58
+ ```
59
+
60
+ [`.github/workflows/release.yml`](.github/workflows/release.yml) takes it from there —
61
+ lint, tests, build, a smoke test that installs the built wheel and drives it, then upload.
62
+ It refuses to publish if the tag and `pyproject.toml` disagree, because a PyPI version
63
+ cannot be replaced afterwards.
64
+
65
+ Credentials: none. The workflow uses PyPI trusted publishing, which needs a one-time
66
+ publisher registered on PyPI (owner `stPhoenix`, repo `heimdall`, workflow `release.yml`,
67
+ environment `pypi`) and a `pypi` environment in the repository settings. To publish by
68
+ hand instead: `uv build && uv publish --token pypi-...`.
69
+
70
+ The distribution is `heimdall-code`; the command is `heimdall`.
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.