diff --git a/.claude-plugin/plugin.json b/.claude-plugin/plugin.json index 33f00d8d..36e3a832 100644 --- a/.claude-plugin/plugin.json +++ b/.claude-plugin/plugin.json @@ -8,5 +8,6 @@ "homepage": "https://github.com/chains-project/yul", "repository": "https://github.com/chains-project/yul", "supportUrl": "https://github.com/chains-project/yul/issues", + "privacyPolicyUrl": "https://github.com/chains-project/yul/blob/main/PRIVACY.md", "license": "MIT" } diff --git a/PRIVACY.md b/PRIVACY.md new file mode 100644 index 00000000..4f7f56f4 --- /dev/null +++ b/PRIVACY.md @@ -0,0 +1,13 @@ +# Privacy + +yul runs on your machine. It has no telemetry and sends nothing to the chains-project maintainers. + +To check a dependency, yul asks its public registry for the latest version. The request carries the package name. It does not carry file contents, file paths, or source code. The registries are Maven Central ([repo1.maven.org](https://repo1.maven.org)), PyPI ([pypi.org](https://pypi.org)), npm ([registry.npmjs.org](https://registry.npmjs.org)), the Go module proxy ([proxy.golang.org](https://proxy.golang.org)), crates.io ([crates.io](https://crates.io)), and the GitHub API for Actions ([api.github.com](https://api.github.com)). Some lookups go to [packages.ecosyste.ms](https://packages.ecosyste.ms) instead. yul does not skip private packages, so an internal package name in a manifest is looked up like any other. Each of these services handles requests under its own privacy policy. + +For GitHub Actions, yul uses a GitHub token if one is available in `GITHUB_TOKEN`, `GH_TOKEN`, or `gh auth token`. It sends the token only to api.github.com, to raise the rate limit. + +The Claude Code plugin also contacts GitHub at session start. It downloads the pinned yul release and checks whether a newer one exists. + +yul stores its binary and its scan results under `~/.cache/yul/` (or `$XDG_CACHE_HOME/yul/`). Scan results list outdated dependencies per project. Deleting the directory removes them. + +Questions go to https://github.com/chains-project/yul/issues.