@xand0dev/traceflow 0.0.0-stage → 0.2.0

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.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 xand0dev
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,3 +1,59 @@
1
- # Temporary Holding Version
1
+ <p align="center">
2
+ <img src="https://raw.githubusercontent.com/xand0dev/TraceFlow/main/docs/images/hero.svg" width="100%" alt="TraceFlow — see what your AI is building" />
3
+ </p>
2
4
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
5
+ You build with Claude Code, Codex or Cursor. The agent writes fifty files and says "done". TraceFlow shows what it actually built: a live map of your app (pages → endpoints → models → database), everything the agent added or changed lit up as files are saved, and real requests moving through it. The same map is available to the agent over MCP.
6
+
7
+ <p align="center">
8
+ <img src="https://raw.githubusercontent.com/xand0dev/TraceFlow/main/docs/images/demo.gif" width="100%" alt="An agent adds payments: new parts light up red and requests flow through the map" />
9
+ </p>
10
+
11
+ ## Run it
12
+
13
+ Needs Node 20+ and Python 3.9+. Inside a Django and/or React project:
14
+
15
+ ```bash
16
+ npx @xand0dev/traceflow
17
+ ```
18
+
19
+ The map opens at `http://localhost:4317` and follows your saves.
20
+
21
+ ## Connect your agent
22
+
23
+ Claude Code, inside your project:
24
+
25
+ ```bash
26
+ claude mcp add traceflow -- npx -y @xand0dev/traceflow mcp
27
+ ```
28
+
29
+ Codex, in `~/.codex/config.toml`:
30
+
31
+ ```toml
32
+ [mcp_servers.traceflow]
33
+ command = "npx"
34
+ args = ["-y", "@xand0dev/traceflow", "mcp", "/absolute/path/to/your/project"]
35
+ ```
36
+
37
+ Claude Desktop or Cursor:
38
+
39
+ ```json
40
+ { "mcpServers": { "traceflow": { "command": "npx", "args": ["-y", "@xand0dev/traceflow", "mcp", "/absolute/path/to/your/project"] } } }
41
+ ```
42
+
43
+ Tools: `architecture`, `trace`, `changes`, `traffic`, `open_map`, `reset_changes`. The MCP server also serves the map.
44
+
45
+ ## Commands
46
+
47
+ Install globally with `npm i -g @xand0dev/traceflow` to get the `traceflow` command.
48
+
49
+ ```
50
+ traceflow [dir] Open the live map (default: current folder)
51
+ traceflow mcp [dir] MCP server for Claude, Codex or Cursor (also serves the map)
52
+ traceflow scan [dir] Print the architecture as text (--json for raw data)
53
+ traceflow simulate [url] Send demo traffic to a running map
54
+ traceflow setup Print agent config snippets
55
+ ```
56
+
57
+ Live traffic needs one small file in your app (Django middleware or a fetch wrapper), or a `POST` to `/api/ingest`. See the [full README](https://github.com/xand0dev/TraceFlow#live-traffic).
58
+
59
+ Read-only, local only, no accounts and no AI calls of its own. MIT.