veoflow 0.5.1 → 0.5.2
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/README.md +85 -0
- package/bin/veoflow.mjs +11 -1
- package/native/veo-extract.win32-x64-msvc.node +0 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
# veoflow
|
|
2
|
+
|
|
3
|
+
A knowledge graph of your code, for people and AI agents. veoflow reads a codebase and shows every function, what it calls, within and across files, and the line that proves each link. Where it can't tell what a call does, it says so and why, rather than guessing.
|
|
4
|
+
|
|
5
|
+
It runs on your machine: your code is read locally and never uploaded.
|
|
6
|
+
|
|
7
|
+
## Requirements
|
|
8
|
+
|
|
9
|
+
- **Node.js 22.13 or newer.** veoflow stores its graphs in Node's built-in SQLite. Check with `node --version`, and upgrade from [nodejs.org](https://nodejs.org) or with `nvm install 22`.
|
|
10
|
+
- **git**, to analyze git repositories. Plain folders work without it.
|
|
11
|
+
- macOS (Apple silicon or Intel), Linux (x64 or arm64) or Windows (x64).
|
|
12
|
+
|
|
13
|
+
## Install
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npm install -g veoflow
|
|
17
|
+
veoflow --version
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
The command is `veoflow`; `veo` also works.
|
|
21
|
+
|
|
22
|
+
## Try it
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
veoflow add ~/projects/my-app # create a project from a folder and analyze it
|
|
26
|
+
veoflow serve # open the UI at http://127.0.0.1:7420
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
In the UI:
|
|
30
|
+
- **Files** shows each file's functions and calls.
|
|
31
|
+
- **Imports** shows the map of how folders and files call into each other.
|
|
32
|
+
- **Findings** lists what the analysis couldn't resolve, most consequential first.
|
|
33
|
+
- The **Ask** bar at the top answers questions about the code.
|
|
34
|
+
|
|
35
|
+
From the terminal:
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
veoflow ask "who calls checkout" # ask about the code
|
|
39
|
+
veoflow explain src/cart.ts:42 # why each call on that line came out as it did
|
|
40
|
+
veoflow run # analyze again after the code changed
|
|
41
|
+
veoflow projects # list projects
|
|
42
|
+
veoflow delete --project my-app # delete a project's analysis (your folder is kept)
|
|
43
|
+
veoflow help # every command
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Languages
|
|
47
|
+
|
|
48
|
+
veoflow 0.5 analyzes **JavaScript and TypeScript**, including JSX/TSX and Vue, Svelte and Angular component files. It uses the TypeScript checker to follow calls across files. Python, Go and Rust are coming in a later release.
|
|
49
|
+
|
|
50
|
+
## Use it from an AI agent (MCP)
|
|
51
|
+
|
|
52
|
+
veoflow is an MCP server, so coding agents can ask it who calls what, where a path goes, and what is unresolved:
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
claude mcp add veoflow -- veoflow mcp # Claude Code
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
For other MCP clients, run `veoflow mcp` as a stdio server.
|
|
59
|
+
|
|
60
|
+
## Ask anything, with a model
|
|
61
|
+
|
|
62
|
+
Built-in questions ("who calls X", "largest files", "overview", …) work offline. To ask anything else, connect a model through [OpenRouter](https://openrouter.ai/keys) with your own key. In the UI, open **Settings** (the gear icon). Or from the terminal:
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
pbpaste | veoflow config set model.apiKey - # pipe the key in (macOS), so it never shows on screen
|
|
66
|
+
veoflow config test
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
The key is stored only in `~/.veoflow/config.json`, readable by you alone.
|
|
70
|
+
|
|
71
|
+
## Upgrading
|
|
72
|
+
|
|
73
|
+
```bash
|
|
74
|
+
npm install -g veoflow@latest
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
Stop any running `veoflow serve` or `veoflow mcp` first, and start them again afterwards. A project analyzed by an older version says so. Run `veoflow run --project <id>` to bring it up to date.
|
|
78
|
+
|
|
79
|
+
## Where things live
|
|
80
|
+
|
|
81
|
+
Everything veoflow keeps is in `~/.veoflow`: the projects, their graphs and history, and your settings. Set `VEOFLOW_HOME` to use another folder. Deleting a project removes its data there; uninstalling is `npm uninstall -g veoflow` and removing `~/.veoflow`.
|
|
82
|
+
|
|
83
|
+
## License
|
|
84
|
+
|
|
85
|
+
During the beta every feature and language is enabled. `veoflow license show` says which license is in force. The license is checked offline: veoflow never phones home.
|
package/bin/veoflow.mjs
CHANGED
|
@@ -3,11 +3,21 @@ import { dirname, join } from "node:path";
|
|
|
3
3
|
import { createInterface } from "node:readline/promises";
|
|
4
4
|
import { fileURLToPath, pathToFileURL } from "node:url";
|
|
5
5
|
|
|
6
|
+
// veoflow keeps its graphs in Node's built-in SQLite (node:sqlite), which needs Node.js 22.13 or newer.
|
|
7
|
+
const [major, minor] = process.versions.node.split(".").map(Number);
|
|
8
|
+
if (major < 22 || (major === 22 && minor < 13)) {
|
|
9
|
+
process.stderr.write(
|
|
10
|
+
"veoflow needs Node.js 22.13 or newer; this is Node.js " + process.versions.node + ".\n" +
|
|
11
|
+
"Install a newer Node.js (https://nodejs.org, or `nvm install 22`), then run veoflow again.\n",
|
|
12
|
+
);
|
|
13
|
+
process.exit(1);
|
|
14
|
+
}
|
|
15
|
+
|
|
6
16
|
const here = dirname(fileURLToPath(import.meta.url));
|
|
7
17
|
process.env.VEO_CHECKERS_MODULE ??= pathToFileURL(join(here, "../dist/checkers.mjs")).href;
|
|
8
18
|
process.env.VEO_NATIVE_DIR ??= join(here, "../native");
|
|
9
19
|
process.env.VEO_WEB_ROOT ??= join(here, "../web");
|
|
10
|
-
process.env.VEO_VERSION = "0.5.
|
|
20
|
+
process.env.VEO_VERSION = "0.5.2";
|
|
11
21
|
const { main } = await import("../dist/veo.mjs");
|
|
12
22
|
const code = await main(process.argv.slice(2), {
|
|
13
23
|
out: (line) => process.stdout.write(line + "\n"),
|
|
Binary file
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "veoflow",
|
|
3
|
-
"version": "0.5.
|
|
3
|
+
"version": "0.5.2",
|
|
4
4
|
"description": "veoflow: a knowledge graph of your code — every function, what it calls, and the line proving it",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
"type": "git",
|
|
19
19
|
"url": "git+https://github.com/mudit70/veoapp.git"
|
|
20
20
|
},
|
|
21
|
-
"homepage": "https://
|
|
21
|
+
"homepage": "https://www.npmjs.com/package/veoflow",
|
|
22
22
|
"files": [
|
|
23
23
|
"bin",
|
|
24
24
|
"dist",
|