@bynlk/codeomnivis 0.0.0-bootstrap.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,77 @@
1
+ # PolyForm Noncommercial License 1.0.0
2
+
3
+ <https://polyformproject.org/licenses/noncommercial/1.0.0>
4
+
5
+ ## Acceptance
6
+
7
+ In order to get any license under these terms, you must agree
8
+ to them as both strict obligations and conditions to all
9
+ your licenses.
10
+
11
+ ## Copyright License
12
+
13
+ The licensor grants you a copyright license for the
14
+ software to do everything you might do with the software
15
+ that would otherwise infringe the licensor's copyright in
16
+ it for any purpose permitted below in **Noncommercial
17
+ Purposes**. When you do so, all copies must include this
18
+ license and the copyright notice below.
19
+
20
+ ## Noncommercial Purposes
21
+
22
+ **Noncommercial Purposes** means any purpose that is not
23
+ primarily intended for or directed towards commercial
24
+ advantage or monetary compensation. Noncommercial Purposes
25
+ include:
26
+
27
+ - personal uses
28
+ - hobbyist uses
29
+ - research uses
30
+ - uses by nonprofit organizations
31
+ - uses by educational institutions
32
+ - uses for testing or evaluation
33
+
34
+ Commercial purposes include:
35
+
36
+ - selling the software or services based on the software
37
+ - using the software in a product or service that you sell
38
+ - using the software to provide a service to paying clients
39
+ - using the software in an advertising-supported product
40
+
41
+ ## Notices
42
+
43
+ You must ensure that anyone who gets a copy of any part of
44
+ the software from you also gets a copy of these terms or the
45
+ URL for them above, as well as a copy of the copyright
46
+ notice above.
47
+
48
+ ## Excuse
49
+
50
+ If anyone notifies you in writing that you have not
51
+ complied with [Notices](#notices), you can keep your
52
+ license by taking all practical steps to comply within 30
53
+ days after the notice. If you do not do so, your license
54
+ ends immediately.
55
+
56
+ ## Patent License
57
+
58
+ The licensor grants you a patent license for the software
59
+ that covers patent claims the licensor can license, or
60
+ becomes able to license, that you would infringe by using
61
+ the software, for any purpose permitted below in
62
+ **Noncommercial Purposes**.
63
+
64
+ ## No Other Rights
65
+
66
+ These terms do not allow you to sublicense or transfer any
67
+ of your licenses to anyone else, or prevent anyone else from
68
+ having their own licenses to the software. These terms do
69
+ not imply any other licenses.
70
+
71
+ ## No Liability
72
+
73
+ **The software comes as is, with no warranties or
74
+ conditions of any kind. The licensor will not be liable
75
+ to you for any damages arising out of these terms or the
76
+ use or nature of the software, under any kind of legal
77
+ claim.**
package/README.md ADDED
@@ -0,0 +1,62 @@
1
+ # @bynlk/codeomnivis
2
+
3
+ CodeOmniVis is a zero-config TypeScript full-stack architecture visualizer. One analyzer-owned `ProjectSnapshot` is projected through the CLI, the local Web/REST workbench, and MCP so humans and AI coding agents refer to the same node IDs, edge IDs, and `snapshotDigest`.
4
+
5
+ ## Quick start
6
+
7
+ Run this at the root of a TypeScript or mixed TypeScript/Kotlin repository:
8
+
9
+ ```bash
10
+ npx @bynlk/codeomnivis serve
11
+ ```
12
+
13
+ Or point it at another local project:
14
+
15
+ ```bash
16
+ npx @bynlk/codeomnivis serve --project /absolute/path/to/repository
17
+ ```
18
+
19
+ ## Public command contract
20
+
21
+ The following fenced block is verified against the CLI command registry:
22
+
23
+ ```codeomnivis-cli-contract
24
+ analyze
25
+ check
26
+ init
27
+ mcp
28
+ serve
29
+ test-import
30
+ test-run
31
+ ```
32
+
33
+ | Command | Purpose |
34
+ | --- | --- |
35
+ | `serve --project <path> [--port <port>] [--host <host>] [--no-open]` | Analyze, open the local workbench, watch source files, and publish updates |
36
+ | `analyze --project <path> [--output <file>] [--json]` | Write a graph or versioned snapshot envelope |
37
+ | `check` | Print parser diagnostics and deterministic findings for the current directory |
38
+ | `mcp --project <path>` | Start the protocol-only stdio MCP server |
39
+ | `test-import --project <path> --junit <file-or-glob>` | Import bounded JUnit XML without executing tests |
40
+ | `test-run --project <path> --runner <name> [--timeout <ms>]` | Explicitly execute an enumerated, shell-free test runner |
41
+ | `init` | Generate a starter `.codeomnivis.json` file |
42
+
43
+ Static analysis commands never execute target tests. Only `test-run` can do so, with validated paths, an argument array, `shell: false`, a 1-second to 30-minute timeout, and a 10 MiB output cap.
44
+
45
+ ## Local and remote access
46
+
47
+ Loopback `serve` is zero-config. Binding to a non-loopback host requires `--token`; protected REST and WebSocket requests use a bearer token or a short-lived HttpOnly browser session. Keep the workbench local unless remote access is intentional.
48
+
49
+ ## Documentation
50
+
51
+ - [GitHub repository](https://github.com/Bynlk/CodeOmniVis)
52
+ - [English README](https://github.com/Bynlk/CodeOmniVis#readme)
53
+ - [中文 README](https://github.com/Bynlk/CodeOmniVis/blob/master/README.zh-CN.md)
54
+ - [Test intelligence](https://github.com/Bynlk/CodeOmniVis/blob/master/docs/guides/test-intelligence.md)
55
+ - [MCP tools](https://github.com/Bynlk/CodeOmniVis/blob/master/docs/api/mcp-tools.md)
56
+ - [REST API](https://github.com/Bynlk/CodeOmniVis/blob/master/docs/api/rest-api.md)
57
+
58
+ CodeOmniVis analyzes source locally. Static analysis can miss runtime dependency injection, generated code, dynamic imports, reflective test registration, and metaprogramming; inspect confidence and source locations before making high-risk changes.
59
+
60
+ ## License
61
+
62
+ PolyForm Noncommercial License 1.0.0. Commercial use requires separate permission.
@@ -0,0 +1,19 @@
1
+ #!/usr/bin/env node
2
+
3
+ /**
4
+ * CodeOmniVis CLI 入口
5
+ *
6
+ * 这个文件是 npm bin 的入口点。
7
+ * 它会加载编译后的 CLI 代码。
8
+ */
9
+
10
+ import('../dist/index.js')
11
+ .then((module) => {
12
+ // Development tests may intentionally execute against an older dist build,
13
+ // whose import side effect already starts the CLI and has no runCli export.
14
+ if (typeof module.runCli === 'function') return module.runCli()
15
+ })
16
+ .catch((err) => {
17
+ console.error('Failed to load CodeOmniVis CLI:', err)
18
+ process.exit(1)
19
+ })