vestigraph 0.2.0__tar.gz

vestigraph-0.2.0/CHANGELOG.md

@@ -0,0 +1,15 @@
+<p align="right">
+  <a href="CHANGELOG.md">English</a> | <a href="CHANGELOG.zh-CN.md">中文</a>
+</p>
+
+# Changelog
+
+## 0.2.0
+
+- Complete KLayout history path uses compatible Klink as a required dependency for the KLayout plugin, HIST entry, companion service, and MCP tool discovery.
+- Complete installation includes `vestigraph-scan-core`; scanning prefers the Rust backend and falls back to Python with diagnostics when a native wheel is unavailable. Supported wheel platforms do not require a local Rust toolchain.
+- Local file history, GDS/OASIS previews, import, recovery, and byte export stay in local user storage.
+- Restarting the existing Klink MCP process discovers Vestigraph tools; no separate Vestigraph MCP server is required.
+- KLayout plugin installation remains the Klink command path (`klink plugin install`) for first install and upgrades.
+- Local skill requests, frozen evidence, revisioned drafts, and exports are available behind an explicit experimental switch.
+- Authenticated loopback calls use structured arguments, revision checks, and scoped validation reports.

vestigraph-0.2.0/CHANGELOG.zh-CN.md

@@ -0,0 +1,15 @@
+<p align="right">
+  <a href="CHANGELOG.md">English</a> | <a href="CHANGELOG.zh-CN.md">中文</a>
+</p>
+
+# 变更记录
+
+## 0.2.0
+
+- 完整 KLayout 历史路径使用兼容 Klink 作为必需依赖，用于 KLayout 插件、HIST 入口、companion 服务和 MCP 工具发现。
+- 完整安装包含 `vestigraph-scan-core`；扫描会优先使用 Rust 后端，并在 native wheel 不可用时带诊断回退到 Python。受支持 wheel 平台不需要本地 Rust 工具链。
+- 本地文件历史、GDS/OASIS 预览、导入、恢复和字节导出均保存在用户本地存储中。
+- 重启现有 Klink MCP 进程即可发现 Vestigraph 工具；不需要单独的 Vestigraph MCP server。
+- KLayout 插件首次安装和升级仍使用 Klink 命令路径（`klink plugin install`）。
+- 本地技能请求、冻结证据、带修订的草稿和导出功能位于显式实验开关之后。
+- 经认证的 loopback 调用使用结构化参数、修订检查和限定范围的验证报告。

vestigraph-0.2.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 klinkdev2026
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

vestigraph-0.2.0/MANIFEST.in

@@ -0,0 +1,8 @@
+include LICENSE THIRD_PARTY_NOTICES.md THIRD_PARTY_NOTICES.zh-CN.md README.md README.zh-CN.md CHANGELOG.md CHANGELOG.zh-CN.md SECURITY.md SECURITY.zh-CN.md
+include docs/README.md docs/README.zh-CN.md docs/INSTALLATION.md docs/INSTALLATION.zh-CN.md docs/HISTORY.md docs/HISTORY.zh-CN.md docs/RECOVERY.md docs/RECOVERY.zh-CN.md docs/CLI.md docs/CLI.zh-CN.md docs/AGENT_LOCAL.md docs/AGENT_LOCAL.zh-CN.md docs/TROUBLESHOOTING.md docs/TROUBLESHOOTING.zh-CN.md docs/PUBLIC_RELEASE.md docs/PUBLIC_RELEASE.zh-CN.md
+include tools/audit_public_artifacts.py tools/check_installed.py tools/check_agent_flow.py
+include native/scan_core/pyproject.toml native/scan_core/Cargo.toml native/scan_core/Cargo.lock native/scan_core/README.md native/scan_core/README.zh-CN.md native/scan_core/THIRD_PARTY.md native/scan_core/THIRD_PARTY.zh-CN.md native/scan_core/LICENSE
+recursive-include native/scan_core/src *.rs
+recursive-include tests *.py
+recursive-include vestigraph/web/static *
+global-exclude *.pyc

vestigraph-0.2.0/PKG-INFO

@@ -0,0 +1,127 @@
+Metadata-Version: 2.4
+Name: vestigraph
+Version: 0.2.0
+Summary: Local file and layout history with KLayout integration
+License: Apache-2.0
+Keywords: klayout,gds,oasis,layout-history,eda
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: THIRD_PARTY_NOTICES.md
+Requires-Dist: fastapi<1,>=0.110
+Requires-Dist: pydantic<3,>=2
+Requires-Dist: uvicorn<1,>=0.27
+Requires-Dist: klayout<0.31,>=0.30
+Requires-Dist: vestigraph-scan-core<0.3,>=0.2
+Requires-Dist: klayout-klink<0.7,>=0.6.0
+Provides-Extra: klink
+Requires-Dist: klayout-klink<0.7,>=0.6.0; extra == "klink"
+Provides-Extra: web
+Requires-Dist: fastapi>=0.110; extra == "web"
+Requires-Dist: uvicorn>=0.27; extra == "web"
+Provides-Extra: preview
+Requires-Dist: klayout>=0.28; extra == "preview"
+Provides-Extra: storage-delta
+Requires-Dist: bsdiff4>=1.2.6; extra == "storage-delta"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: httpx>=0.25; extra == "test"
+Requires-Dist: playwright>=1.50; extra == "test"
+Dynamic: license-file
+
+<p align="right">
+  <a href="./README.md">English</a> | <a href="./README.zh-CN.md">中文</a>
+</p>
+
+# Vestigraph
+
+Vestigraph is local file and layout history for KLayout users. It stores versions on the user's machine, shows a browser timeline, previews GDS/OASIS content, imports older files, and exports saved versions for recovery.
+
+Vestigraph requires Python 3.10 or newer, KLayout desktop 0.30.x, `klayout-klink>=0.6.0,<0.7`, and the `vestigraph-scan-core` scanner package. The normal installation resolves Klink and the scanner as dependencies. Install the Klink KLayout plugin with the Klink command, restart MCP so Vestigraph registers its local companion for the active Python environment, then restart KLayout and open **HIST**.
+
+## What it does
+
+- Saves file checkpoints and history data in local user storage.
+- Runs a loopback-only browser service for browsing, naming, importing, and exporting history.
+- Previews GDS/OASIS versions with the Python `klayout` package.
+- Uses Klink's KLayout plugin and companion-service path to record saved GDS/OASIS documents automatically.
+- Exposes local history and skill-refinement tools through the existing Klink MCP extension registry.
+- Keeps history, evidence, drafts, revisions, exports, login links, and control files on the user's machine.
+
+Vestigraph does not provide cloud sync, remote collaboration, hosted storage, a model service, or automatic chat-client configuration.
+
+## Install
+
+The commands below install published PyPI releases. For a version not yet on PyPI, download the build-only wheel and sdist artifacts from [GitHub Actions](https://github.com/klinkdev2026/vestigraph/actions/workflows/release.yml).
+
+```console
+python -m pip install vestigraph
+klink plugin install
+# restart the MCP client that runs klink-mcp
+# restart KLayout, open a saved GDS/OASIS layout, then click HIST
+python -m vestigraph doctor --integration
+```
+
+`pip install vestigraph` installs the compatible `klayout-klink` and `vestigraph-scan-core` dependencies. `klink plugin install` is still the Klink command that installs or upgrades the KLayout plugin. Restarting the MCP client lets the Klink extension registry discover Vestigraph and register the companion for that Python environment. No separate Vestigraph MCP server is needed. Installing Python packages does not configure arbitrary chat clients.
+
+The scanner prefers the Rust `vestigraph-scan-core` backend when it is importable and falls back to the Python scanner with a diagnostic reason if the native wheel is unavailable. Users on supported wheel platforms do not need a local Rust toolchain.
+
+After KLayout restarts, open a saved GDS/OASIS layout and click **HIST**. The panel opens the local web history UI and shows recording status. Confirm that recording is active before editing.
+
+## Release artifacts before PyPI
+
+Download the Vestigraph artifact archive from the [release workflow](https://github.com/klinkdev2026/vestigraph/actions/workflows/release.yml), extract it, and install the wheel with its matching scanner wheel from that directory:
+
+```console
+python -m pip install --find-links ./wheels "vestigraph-scan-core" ./wheels/vestigraph-0.2.0-py3-none-any.whl
+klink plugin install
+```
+
+Before both projects are on PyPI, put the matching platform wheels in one local directory: the two Klink Rust wheels, the `klayout_klink` core wheel, the `vestigraph_scan_core` wheel, and the Vestigraph wheel. Then install from that directory:
+
+```console
+python -m pip install --find-links ./wheels "klayout-klink>=0.6.0,<0.7" "vestigraph-scan-core" "vestigraph>=0.2,<0.3"
+klink plugin install
+```
+
+Then restart the MCP client, restart KLayout, open a saved layout, and click **HIST**.
+
+## Upgrade
+
+Stop the old Vestigraph service if one is running. Upgrade packages, upgrade the Klink plugin, then restart MCP and KLayout:
+
+```console
+python -m pip install --upgrade "vestigraph>=0.2,<0.3"
+klink plugin install
+python -m vestigraph doctor --integration
+```
+
+The underlying storage CLI can still save and export local file versions, but it is not the main product installation path. Full KLayout history, HIST, and local agent tools require Klink.
+
+## Local skills and agents
+
+Skill refinement is experimental and disabled by default. When enabled, users can select a history range, save a request, freeze evidence, let a chosen local agent submit a draft, review validation feedback, save revisions, and export files. The package does not include private skills and does not call a model by itself.
+
+After installation and MCP restart, use the existing Klink MCP server:
+
+```json
+{"tool":"klink.find_tools","arguments":{"domain":"vestigraph"}}
+```
+
+Then call `vestigraph.guide` and follow `next_action`. See [Local agents and skills](docs/AGENT_LOCAL.md).
+
+## Documentation
+
+- [Installation and upgrades](docs/INSTALLATION.md)
+- [Files and history](docs/HISTORY.md)
+- [Recovery and data locations](docs/RECOVERY.md)
+- [Command line](docs/CLI.md)
+- [Local agents and skills](docs/AGENT_LOCAL.md)
+- [Troubleshooting](docs/TROUBLESHOOTING.md)
+- [Release scope](docs/PUBLIC_RELEASE.md)
+
+Vestigraph is Apache-2.0. See [Security and local access](SECURITY.md), [third-party notices](THIRD_PARTY_NOTICES.md), and [changelog](CHANGELOG.md).

vestigraph-0.2.0/README.md

@@ -0,0 +1,92 @@
+<p align="right">
+  <a href="./README.md">English</a> | <a href="./README.zh-CN.md">中文</a>
+</p>
+
+# Vestigraph
+
+Vestigraph is local file and layout history for KLayout users. It stores versions on the user's machine, shows a browser timeline, previews GDS/OASIS content, imports older files, and exports saved versions for recovery.
+
+Vestigraph requires Python 3.10 or newer, KLayout desktop 0.30.x, `klayout-klink>=0.6.0,<0.7`, and the `vestigraph-scan-core` scanner package. The normal installation resolves Klink and the scanner as dependencies. Install the Klink KLayout plugin with the Klink command, restart MCP so Vestigraph registers its local companion for the active Python environment, then restart KLayout and open **HIST**.
+
+## What it does
+
+- Saves file checkpoints and history data in local user storage.
+- Runs a loopback-only browser service for browsing, naming, importing, and exporting history.
+- Previews GDS/OASIS versions with the Python `klayout` package.
+- Uses Klink's KLayout plugin and companion-service path to record saved GDS/OASIS documents automatically.
+- Exposes local history and skill-refinement tools through the existing Klink MCP extension registry.
+- Keeps history, evidence, drafts, revisions, exports, login links, and control files on the user's machine.
+
+Vestigraph does not provide cloud sync, remote collaboration, hosted storage, a model service, or automatic chat-client configuration.
+
+## Install
+
+The commands below install published PyPI releases. For a version not yet on PyPI, download the build-only wheel and sdist artifacts from [GitHub Actions](https://github.com/klinkdev2026/vestigraph/actions/workflows/release.yml).
+
+```console
+python -m pip install vestigraph
+klink plugin install
+# restart the MCP client that runs klink-mcp
+# restart KLayout, open a saved GDS/OASIS layout, then click HIST
+python -m vestigraph doctor --integration
+```
+
+`pip install vestigraph` installs the compatible `klayout-klink` and `vestigraph-scan-core` dependencies. `klink plugin install` is still the Klink command that installs or upgrades the KLayout plugin. Restarting the MCP client lets the Klink extension registry discover Vestigraph and register the companion for that Python environment. No separate Vestigraph MCP server is needed. Installing Python packages does not configure arbitrary chat clients.
+
+The scanner prefers the Rust `vestigraph-scan-core` backend when it is importable and falls back to the Python scanner with a diagnostic reason if the native wheel is unavailable. Users on supported wheel platforms do not need a local Rust toolchain.
+
+After KLayout restarts, open a saved GDS/OASIS layout and click **HIST**. The panel opens the local web history UI and shows recording status. Confirm that recording is active before editing.
+
+## Release artifacts before PyPI
+
+Download the Vestigraph artifact archive from the [release workflow](https://github.com/klinkdev2026/vestigraph/actions/workflows/release.yml), extract it, and install the wheel with its matching scanner wheel from that directory:
+
+```console
+python -m pip install --find-links ./wheels "vestigraph-scan-core" ./wheels/vestigraph-0.2.0-py3-none-any.whl
+klink plugin install
+```
+
+Before both projects are on PyPI, put the matching platform wheels in one local directory: the two Klink Rust wheels, the `klayout_klink` core wheel, the `vestigraph_scan_core` wheel, and the Vestigraph wheel. Then install from that directory:
+
+```console
+python -m pip install --find-links ./wheels "klayout-klink>=0.6.0,<0.7" "vestigraph-scan-core" "vestigraph>=0.2,<0.3"
+klink plugin install
+```
+
+Then restart the MCP client, restart KLayout, open a saved layout, and click **HIST**.
+
+## Upgrade
+
+Stop the old Vestigraph service if one is running. Upgrade packages, upgrade the Klink plugin, then restart MCP and KLayout:
+
+```console
+python -m pip install --upgrade "vestigraph>=0.2,<0.3"
+klink plugin install
+python -m vestigraph doctor --integration
+```
+
+The underlying storage CLI can still save and export local file versions, but it is not the main product installation path. Full KLayout history, HIST, and local agent tools require Klink.
+
+## Local skills and agents
+
+Skill refinement is experimental and disabled by default. When enabled, users can select a history range, save a request, freeze evidence, let a chosen local agent submit a draft, review validation feedback, save revisions, and export files. The package does not include private skills and does not call a model by itself.
+
+After installation and MCP restart, use the existing Klink MCP server:
+
+```json
+{"tool":"klink.find_tools","arguments":{"domain":"vestigraph"}}
+```
+
+Then call `vestigraph.guide` and follow `next_action`. See [Local agents and skills](docs/AGENT_LOCAL.md).
+
+## Documentation
+
+- [Installation and upgrades](docs/INSTALLATION.md)
+- [Files and history](docs/HISTORY.md)
+- [Recovery and data locations](docs/RECOVERY.md)
+- [Command line](docs/CLI.md)
+- [Local agents and skills](docs/AGENT_LOCAL.md)
+- [Troubleshooting](docs/TROUBLESHOOTING.md)
+- [Release scope](docs/PUBLIC_RELEASE.md)
+
+Vestigraph is Apache-2.0. See [Security and local access](SECURITY.md), [third-party notices](THIRD_PARTY_NOTICES.md), and [changelog](CHANGELOG.md).

vestigraph-0.2.0/README.zh-CN.md

@@ -0,0 +1,92 @@
+<p align="right">
+  <a href="./README.md">English</a> | <a href="./README.zh-CN.md">中文</a>
+</p>
+
+# Vestigraph
+
+Vestigraph 是面向 KLayout 用户的本地文件与版图历史。它把版本保存在用户本机，提供浏览器时间线、GDS/OASIS 预览、旧文件导入，以及已保存版本导出恢复。
+
+Vestigraph 需要 Python 3.10 或更新版本、KLayout 桌面 0.30.x、`klayout-klink>=0.6.0,<0.7`，以及 `vestigraph-scan-core` 扫描器包。正常安装会解析 Klink 和扫描器依赖。使用 Klink 命令安装 KLayout 插件，重启 MCP 使 Vestigraph 为当前 Python 环境自动登记本地 companion，然后重启 KLayout 并打开 **HIST**。
+
+## 功能
+
+- 在本地用户存储中保存文件检查点和历史数据。
+- 运行仅绑定 loopback 的浏览器服务，用于浏览、命名、导入和导出历史。
+- 使用 Python `klayout` 包预览 GDS/OASIS 版本。
+- 使用 Klink 的 KLayout 插件和 companion 服务通路，自动记录已保存的 GDS/OASIS 文档。
+- 通过现有 Klink MCP 扩展注册表暴露本地历史和技能炼化工具。
+- 历史、证据、草稿、修订、导出、登录链接和控制文件均保存在用户本机。
+
+Vestigraph 不提供云同步、远程协作、托管存储、模型服务，也不会自动配置聊天客户端。
+
+## 安装
+
+下面的命令安装已经发布到 PyPI 的版本。对于尚未发布到 PyPI 的版本，请从 [GitHub Actions](https://github.com/klinkdev2026/vestigraph/actions/workflows/release.yml) 下载 build-only wheel 与 sdist artifacts。
+
+```console
+python -m pip install vestigraph
+klink plugin install
+# 重启运行 klink-mcp 的 MCP 客户端
+# 重启 KLayout，打开已保存的 GDS/OASIS，然后点击 HIST
+python -m vestigraph doctor --integration
+```
+
+`pip install vestigraph` 会安装兼容的 `klayout-klink` 和 `vestigraph-scan-core` 依赖。`klink plugin install` 仍是安装或升级 KLayout 插件的 Klink 命令。重启 MCP 客户端后，Klink 扩展注册表会发现 Vestigraph，并为该 Python 环境登记 companion。不需要单独的 Vestigraph MCP server。安装 Python 包不会自动配置任意聊天客户端。
+
+扫描器会在可导入时优先使用 Rust `vestigraph-scan-core` 后端；如果本机 wheel 不可用，则带诊断原因回退到 Python 扫描器。受支持 wheel 平台上的用户通常不需要本地 Rust 工具链。
+
+KLayout 重启后，打开已保存的 GDS/OASIS 并点击 **HIST**。面板会打开本地历史网页并显示记录状态。开始编辑前请确认记录已启用。
+
+## PyPI 发布前的 artifacts
+
+从 [release workflow](https://github.com/klinkdev2026/vestigraph/actions/workflows/release.yml) 下载 Vestigraph artifact 压缩包，解压后从该目录安装 Vestigraph wheel 及其匹配的扫描器 wheel：
+
+```console
+python -m pip install --find-links ./wheels "vestigraph-scan-core" ./wheels/vestigraph-0.2.0-py3-none-any.whl
+klink plugin install
+```
+
+在两个项目都发布到 PyPI 之前，把匹配平台的 wheels 放在同一个本地目录：两个 Klink Rust wheel、`klayout_klink` core wheel、`vestigraph_scan_core` wheel 和 Vestigraph wheel。然后从该目录安装：
+
+```console
+python -m pip install --find-links ./wheels "klayout-klink>=0.6.0,<0.7" "vestigraph-scan-core" "vestigraph>=0.2,<0.3"
+klink plugin install
+```
+
+随后重启 MCP 客户端，重启 KLayout，打开已保存的版图并点击 **HIST**。
+
+## 升级
+
+如果旧 Vestigraph 服务正在运行，先停止它。升级包和 Klink 插件，然后重启 MCP 与 KLayout：
+
+```console
+python -m pip install --upgrade "vestigraph>=0.2,<0.3"
+klink plugin install
+python -m vestigraph doctor --integration
+```
+
+底层存储 CLI 仍可保存和导出本地文件版本，但它不是主要产品安装路径。完整 KLayout 历史、HIST 和本地 agent 工具都需要 Klink。
+
+## 本地技能与 agent
+
+技能炼化是实验功能，默认关闭。启用后，用户可以选择历史区间、保存请求、冻结证据、让选定的本地 agent 提交草稿、查看验证反馈、保存修订并导出文件。安装包不包含私人技能，也不会自行调用模型。
+
+安装并重启 MCP 后，使用现有 Klink MCP server：
+
+```json
+{"tool":"klink.find_tools","arguments":{"domain":"vestigraph"}}
+```
+
+然后调用 `vestigraph.guide` 并按 `next_action` 操作。参见[本地 agent 与技能](docs/AGENT_LOCAL.zh-CN.md)。
+
+## 文档
+
+- [安装与升级](docs/INSTALLATION.zh-CN.md)
+- [文件与历史](docs/HISTORY.zh-CN.md)
+- [恢复与数据位置](docs/RECOVERY.zh-CN.md)
+- [命令行](docs/CLI.zh-CN.md)
+- [本地 agent 与技能](docs/AGENT_LOCAL.zh-CN.md)
+- [故障排查](docs/TROUBLESHOOTING.zh-CN.md)
+- [发布范围](docs/PUBLIC_RELEASE.zh-CN.md)
+
+Vestigraph 使用 Apache-2.0 许可证。另见[安全与本地访问](SECURITY.md)、[第三方声明](THIRD_PARTY_NOTICES.md)和[变更记录](CHANGELOG.md)。

vestigraph-0.2.0/SECURITY.md

@@ -0,0 +1,11 @@
+<p align="right">
+  <a href="SECURITY.md">English</a> | <a href="SECURITY.zh-CN.md">中文</a>
+</p>
+
+# Security and local access
+
+Vestigraph is designed for a trusted local user. The browser service binds to loopback. Do not expose the panel through the public internet, a LAN reverse proxy, or a shared multi-user service. Browser cookies are scoped by host rather than by port, so an untrusted service on the same host can affect session safety.
+
+The product does not call models and does not upload design data automatically. Klink is part of the complete installation path for KLayout plugin, HIST, companion service, and MCP discovery, but installing Python packages still does not configure arbitrary chat clients. Treat one-time login links, control-file secrets, local history repositories, skill drafts, exports, and service state as private user data. Do not attach them to public issues.
+
+For bug reports, share the software version, exact steps, and a synthetic reproduction sample when possible. Do not upload customer layouts, PDKs, history repositories, service links, secrets, or raw real-world logs. The public package does not claim to remove risks from third-party editors, arbitrary user scripts, or untrusted local processes on the same machine.

vestigraph-0.2.0/SECURITY.zh-CN.md

@@ -0,0 +1,11 @@
+<p align="right">
+  <a href="SECURITY.md">English</a> | <a href="SECURITY.zh-CN.md">中文</a>
+</p>
+
+# 安全与本地访问
+
+Vestigraph 面向可信本机用户。浏览器服务绑定 loopback。不要通过公网、局域网反向代理或多人共享服务暴露面板。浏览器 cookie 按主机而不是端口隔离，因此同一主机上的不可信服务可能影响会话安全。
+
+产品不会自行调用模型，也不会自动上传设计数据。完整安装路径需要 Klink，用于 KLayout 插件、HIST、companion 服务和 MCP 发现；但安装 Python 包仍不会自动配置任意聊天客户端。一次性登录链接、控制文件密钥、本地历史库、技能草稿、导出和服务状态都应视为用户私有数据。不要附到公开 issue 中。
+
+提交 bug 时，尽量提供软件版本、具体步骤和合成复现样本。不要上传客户版图、PDK、历史库、服务链接、密钥或未经处理的真实日志。公开包不声称可以消除第三方编辑器、任意用户脚本或同机不可信进程带来的风险。

vestigraph-0.2.0/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,13 @@
+<p align="right">
+  <a href="THIRD_PARTY_NOTICES.md">English</a> | <a href="THIRD_PARTY_NOTICES.zh-CN.md">中文</a>
+</p>
+
+# Third-party notices
+
+Vestigraph source is distributed under Apache-2.0. Its installation resolves separately distributed dependencies including FastAPI, Uvicorn, Pydantic, the KLayout Python package, compatible Klink packages, and the `vestigraph-scan-core` scanner package. Each dependency retains its own copyright notices and license; installing it does not relicense it under Vestigraph's license.
+
+KLayout and its Python bindings have their own distribution and licensing terms. Klink is distributed separately. The scanner package is distributed as a separate native wheel on supported platforms; users normally do not need a local Rust toolchain. If the native scanner is unavailable, Vestigraph reports the reason and falls back to the Python scanner.
+
+Optional delta encoding packages such as `bsdiff4` are resolved only when that feature is requested. Consult the metadata and license files in each installed distribution for its terms. The native scanner dependency list is documented in `native/scan_core/THIRD_PARTY.md` in the public release tree.
+
+The wheel contains Vestigraph's own web assets and requires no CDN or remote asset loading.

vestigraph-0.2.0/THIRD_PARTY_NOTICES.zh-CN.md

@@ -0,0 +1,13 @@
+<p align="right">
+  <a href="THIRD_PARTY_NOTICES.md">English</a> | <a href="THIRD_PARTY_NOTICES.zh-CN.md">中文</a>
+</p>
+
+# 第三方声明
+
+Vestigraph 源码以 Apache-2.0 分发。安装会解析独立分发的依赖，包括 FastAPI、Uvicorn、Pydantic、KLayout Python 包、兼容的 Klink 包，以及 `vestigraph-scan-core` 扫描器包。每个依赖保留其自身版权声明和许可证；安装依赖不会把它重新授权为 Vestigraph 的许可证。
+
+KLayout 及其 Python 绑定有各自的分发和授权条款。Klink 单独分发。扫描器包在受支持平台上以独立 native wheel 分发；用户通常不需要本地 Rust 工具链。如果 native 扫描器不可用，Vestigraph 会报告原因并回退到 Python 扫描器。
+
+`bsdiff4` 等可选 delta 编码包只在请求相关功能时解析。请查看每个已安装发行包的 metadata 和许可证文件以了解其条款。native 扫描器依赖清单记录在公开 release tree 的 `native/scan_core/THIRD_PARTY.md` 中。
+
+Wheel 包含 Vestigraph 自身网页资源，不需要 CDN 或远程资源加载。