canopy-engine 0.1.5 → 0.1.8

package/LICENSE

@@ -1,24 +1,30 @@
-Canopy Beta License
-
-Copyright (c) 2026 Spill It Labs Private Limited. All rights reserved.
-
-Permission is granted, free of charge, to use this software
-("Canopy") for personal, educational, evaluation and
-non-commercial purposes, on your own computer, subject to these
-terms:
-
-1. No redistribution. You may not copy, publish, sublicense, sell
-   or otherwise distribute Canopy or any part of it.
-2. No reverse engineering. You may not decompile, disassemble or
-   attempt to extract the source code of Canopy, except where
-   applicable law forbids this restriction.
-3. Commercial use. Use inside a company or for paid work needs a
-   separate written agreement. Contact: canopy.spillitlabs@gmail.com.
-4. Your code stays yours. Canopy runs locally and does not send
-   your source code anywhere. The only network feature is the
-   optional update check (canopy update).
-5. No warranty. Canopy is provided "as is", without warranty of
-   any kind. The author is not liable for any damages arising from
-   its use.
-6. Ending. This license ends automatically if you break these
-   terms. The author may change the license for future versions.
+Canopy Beta License
+
+Copyright (c) 2026 Spill It Labs Private Limited. All rights reserved.
+
+Permission is granted, free of charge, to use this software
+("Canopy") for personal, educational, evaluation and
+non-commercial purposes, on your own computer, subject to these
+terms:
+
+1. No redistribution. You may not copy, publish, sublicense, sell
+   or otherwise distribute Canopy or any part of it.
+2. No reverse engineering. You may not decompile, disassemble or
+   attempt to extract the source code of Canopy, except where
+   applicable law forbids this restriction.
+3. Commercial use. Use inside a company or for paid work needs a
+   separate written agreement. Contact: canopy.spillitlabs@gmail.com.
+4. Your code stays yours. Canopy itself runs locally and does not
+   send your source code anywhere. Its only network features are
+   the update check (shown in the viewer, or run `canopy update`;
+   turn it off with CANOPY_NO_UPDATE_CHECK=1) and optional, opt-in
+   anonymous usage statistics described in PRIVACY.md. If you use
+   the Ask AI panel, Canopy starts your own Claude Code on your
+   computer, and parts of your code that Canopy's tools return may
+   be processed by Anthropic under your own account and terms.
+   Canopy never sees your credentials.
+5. No warranty. Canopy is provided "as is", without warranty of
+   any kind. The author is not liable for any damages arising from
+   its use.
+6. Ending. This license ends automatically if you break these
+   terms. The author may change the license for future versions.

package/PRIVACY.md

@@ -0,0 +1,72 @@
+# Privacy
+
+Short version: Canopy runs on your computer. Your code is never sent anywhere by Canopy. There is one optional network check (the update notice) and one optional, opt-in feature (anonymous usage counts) that is **off until you say yes**.
+
+## What Canopy does locally
+
+- It reads your project's JavaScript / TypeScript files on your computer and builds a map. The map, the search index, the history and your choices are stored in a `.canopy/` folder inside your project (kept out of git automatically). Nothing in it is uploaded.
+- It serves the viewer on `127.0.0.1` (your own computer only), protected by a random per-session key.
+- **Ask AI** starts the Claude Code program that is already installed on your computer (for example the one inside the VS Code extension), with your own login and plan. Canopy never calls an AI service itself, never sees or stores your credentials, and never reads Claude's login or session files. What Claude Code does with your question, and what it sends to Anthropic, is governed by Anthropic's terms and your own account, not by Canopy. The questions and answers are not kept by Canopy; only the id of the Claude conversation is remembered in `.canopy/ai-session.json` so follow-up questions work, and the path of the Claude Code program you allowed is saved in `.canopy/prefs.json`.
+- **Send feedback** and the hint at the end of `canopy sync` are `mailto:` links. They open your own mail program with the subject filled in and an empty message. Canopy sends nothing itself.
+
+## The update check
+
+The viewer can ask `https://registry.npmjs.org/canopy-engine/latest` once when it loads, to tell you if a newer version exists, and `canopy update` uses npm. The request carries no cookies, no identifiers and no information about you or your project. Turn the viewer's check off with `CANOPY_NO_UPDATE_CHECK=1`.
+
+## Optional anonymous usage counts
+
+**Off by default. Opt-in only.** The first time you run Canopy in an interactive terminal, it asks once:
+
+> Help improve Canopy? Share anonymous usage counts (no code, no file or project names, no questions). You can change this any time with `canopy telemetry off`. [y/N]
+
+Pressing Enter means **No**. Commands, scripts, CI, `--quiet` runs and the commit hook never ask and never send. `DO_NOT_TRACK=1`, `CANOPY_TELEMETRY=0` or a `CI` environment variable switch it off no matter what was chosen earlier.
+
+Control it any time: `canopy telemetry status`, `on`, `off` (which also deletes your random id), and `show` (prints exactly what would be sent). The choice and the random id live in your user config folder (Windows `%APPDATA%\canopy\config.json`, otherwise `~/.config/canopy/config.json`), not inside any project.
+
+### Exactly what can be sent
+
+Every event carries: the event name, a random install id (a UUID made only after you say yes, not linked to you), a UTC timestamp, the Canopy version, the operating system family (`win32`, `darwin` or `linux`), the CPU architecture, the Node major version, and the editor you started Canopy from if known (`vscode`, `cursor`, `other`, `none`).
+
+Events and their only extra fields (each a fixed word or a whole number):
+
+| event | extra fields |
+|---|---|
+| `first_run` | none |
+| `sync_completed` | duration bucket (`<5s`, `5-30s`, `30s-2m`, `2-10m`, `10m+`), number-of-files bucket (`<500`, `500-2k`, `2k-10k`, `10k+`), number-of-services bucket (`1`, `2-3`, `4-10`, `10+`), `ok` / `error`, an error code from a fixed list |
+| `viewer_opened` | none |
+| `search_used` | a count |
+| `workflow_opened` | a count |
+| `ask_ai_used` | a count, result (`ok`, `error`, `cancelled`), where Claude Code was found (`vscode`, `path`, `env`), answer-time bucket (`<10s`, `10-30s`, `30-90s`, `90s+`) |
+| `feedback_link_clicked` | a count |
+| `update_toast_shown` | a count |
+| `error` | an error code from a fixed list (never a message) |
+
+A single function in the code (`src/telemetry/events.js`) enforces this list: any other field is dropped, and a value that is not one of the listed words or a whole number is dropped too.
+
+### What is never collected
+
+Your code; file paths; repository, project, function, node or workflow names; search text; your questions to Ask AI or the answers; error messages; environment variables or their values; user names, computer names or host names; your country. Requests ask the server not to store an IP address, and no person profile is created.
+
+### How it is sent
+
+Counters are kept in memory and sent as one HTTPS request when Canopy exits and every 5 minutes while the viewer runs. The request has a 2-second limit, is never retried, and nothing is queued on disk. If it fails, nothing happens and Canopy carries on. Nothing is sent unless this build of Canopy has a statistics address configured (it is empty in development builds).
+
+### Where it goes
+
+To a PostHog project in the EU region (`eu.i.posthog.com`) run by the maker of Canopy. Processor: PostHog (EU cloud region).
+
+### How long it is kept
+
+*[Founder to state before launch: the retention period, for example "26 months, then deleted".]*
+
+### Your rights
+
+Because the counts are anonymous and carry only a random id, they cannot be tied to you. If you want the data for your install id removed, run `canopy telemetry status`, note the choice file, and email the id from that file to the contact below. After `canopy telemetry off` the id is deleted from your computer and no new data is sent.
+
+## Contact
+
+canopy.spillitlabs@gmail.com
+
+---
+
+*This document describes how Canopy behaves. It has not yet been reviewed by a lawyer; do that before a public launch.*