Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 18 additions & 30 deletions BETA_TESTING.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
# First developer beta testing guide
# PatchWRK Scanner — developer onboarding and optional testing

Preparation for an initial round of **10 consenting external developers**. Nobody
is enrolled or contacted by this document. Participation and feedback are voluntary;
stop or skip a scenario at any time. Do not submit feedback until the founder opens
the round and you choose to participate. No signup, telemetry or automatic upload.
PatchWRK Scanner is available now. No enrollment or PatchWRK account is required
to install or run it. Feedback is voluntary; never send credentials, private source
or sensitive reports. This guide does not contact or enroll anyone.

## What you are testing

PatchWRK Scanner is free, MIT-licensed and experimental. It runs locally with
PatchWRK Scanner is a free API Compatibility Scanner. Its engine is open source under MIT. It runs locally with
**offline, read-only static analysis** of JavaScript/TypeScript. Supported SDK
identities are Stripe, OpenAI, Anthropic, Shopify and Twilio. Only Stripe/OpenAI
have curated compatibility changes: four narrow historical records. There is no
continuous monitoring, automatic repair or available PatchWRK Cloud service.
continuous monitoring, automatic repair or available PatchWRK Pro service.

Scanning does not execute target code, install target dependencies or contact API
providers. Downloading the archive requires network access; scanning does not. Optional
Expand All @@ -21,9 +20,17 @@ sandbox against hostile concurrent changes. Read [SECURITY.md](SECURITY.md).

## Install and first scan

Use **Node.js 24** and the published [v0.1.0 experimental prerelease](https://github.com/patchwrk-dev/patchwrk-scanner/releases/tag/v0.1.0).
For supported macOS Apple Silicon hosts, [Install for VS Code](https://marketplace.visualstudio.com/items?itemName=PatchWRK.patchwrk-scanner-local)
is the primary path. Confirm publisher **PatchWRK** and ID **PatchWRK.patchwrk-scanner-local**.
Requires VS Code **1.137.0+** with embedded **Node 24**; other platforms and Cursor
are unverified, and remote/virtual/web workspaces are unsupported. No separate
Node installation, source build or npm installation is needed for a compatible host.
Open an authorized stable project → PatchWRK sidebar → Run Scan → Reports Only.
See the [extension guide](docs/VSCODE_EXTENSION.md) for explicit history setup and comparison.

For the standalone CLI, use **Node.js 24** and the published [v0.1.0 CLI prerelease](https://github.com/patchwrk-dev/patchwrk-scanner/releases/tag/v0.1.0).
The [README download/verification steps](README.md#download-prebuilt-scanner) are the
primary installation route: download the named archive/checksum, verify, extract into
standalone CLI installation route: download the named archive/checksum, verify, extract into
a new directory and run with Node. No cloning, npm install, pnpm or compilation is
required. macOS/Ubuntu have CLI test coverage; Windows security is unverified.

Expand Down Expand Up @@ -91,9 +98,9 @@ unsupported pnpm/Yarn/Bun lock resolution, incomplete provider catalogs and boun
traversal/analysis. No production-health, comprehensive security or accuracy guarantee.
See [README limitations](README.md#known-limitations).

## Optional feedback after the round opens
## Optional sanitized feedback

Use the seven-question [feedback template](FEEDBACK.md#beta-testing-feedback-template).
Optionally use the existing [feedback template](FEEDBACK.md#beta-testing-feedback-template).
[Issues](https://github.com/patchwrk-dev/patchwrk-scanner/issues/new/choose) are for
reproducible installation/detection/version/compatibility bugs, provider requests
and scoped features. Existing [Discussions](https://github.com/patchwrk-dev/patchwrk-scanner/discussions)
Expand All @@ -106,22 +113,3 @@ relative paths; never provide API keys, credentials, environment dumps, private
customer data or raw sensitive reports. Do not name a private repository. Each answer
is optional; no names, emails, company or repository access is requested. Security
findings go through [SECURITY.md](SECURITY.md), never public Issues/Discussions.

## Invitation draft — not sent

> Would you like to try PatchWRK Scanner in our first small developer testing round?
> It's free and open source, an experimental beta for finding supported API SDK
> evidence and reviewing limited historical compatibility guidance. It scans locally,
> offline and read-only, without executing target code, telemetry or uploads; initial
> obtaining the prebuilt archive needs a download and Node 24, with no source build. Test only stable repositories you're
> authorized to inspect, or start with the synthetic demo. There is no continuous
> monitoring or automatic repair. Participation and sanitized feedback are voluntary;
> you can decline, skip questions or stop at any time. Please read the
> [testing guide](https://github.com/patchwrk-dev/patchwrk-scanner/blob/main/BETA_TESTING.md)
> and [security policy](https://github.com/patchwrk-dev/patchwrk-scanner/blob/main/SECURITY.md)
> before deciding. No API keys or private source are requested.

Before any outreach or collection, the founder must review this invitation, open
the round, obtain consent to participation, assign feedback/security responders and
confirm handling/retention expectations. Do not create a public tester roster or
claim testers/results exist. Do not promise removal of public posts or their copies.
54 changes: 36 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,39 @@
# PatchWRK Scanner

**Free API Compatibility Scanner — available now.**
Find third-party API/SDK integration evidence in JavaScript and TypeScript projects.
Review evidence-backed historical assessments, visual reports and saved scan differences.

**Free, MIT-licensed experimental beta.** Offline, read-only and manually initiated.
The **Scanner engine is open source under MIT**. Scans are offline, read-only and manually initiated.
No account, API credentials, source upload, target code execution or automatic repair.

**Get PatchWRK → Run Scan → View Results → Review History → Compare Scans**

## Install for VS Code — recommended

[**Install for VS Code**](https://marketplace.visualstudio.com/items?itemName=PatchWRK.patchwrk-scanner-local)

The current public extension is **PatchWRK: API Compatibility Scanner v0.2.5**,
published by **PatchWRK**, extension ID `PatchWRK.patchwrk-scanner-local`.
It uses the normal release channel with no Marketplace Preview designation.
Supported package: **macOS Apple Silicon (`darwin-arm64`)**. Requires VS Code
**1.137.0+** with embedded **Node 24**. Other platforms and Cursor are unverified;
remote, virtual and web workspaces are unsupported.

Choose Install on the Marketplace page, open an authorized stable local project,
then click the PatchWRK icon → **Run Scan** → **Reports Only** for a first report.
No clone, npm/pnpm, compilation, separate Scanner or separate Node installation is
needed for a compatible extension host. Enable optional history only after reviewing
and confirming its private directory outside all open projects. Two saved scans are
needed to compare; reports-only scans are not saved retroactively.

[Extension guide and privacy limits](docs/VSCODE_EXTENSION.md).
This repository publishes the Scanner engine; a public source location for the
VS Code extension adapter has not been verified. MIT licensing alone does not
establish that all extension source is publicly hosted.
The verified standalone CLI remains available below; its version is independent of
the extension version. PatchWRK Pro is an upcoming paid API maintenance platform, not yet available.

## Download prebuilt Scanner

**Requires Node.js 24 (`>=24 <25`)** — the archive includes compiled JavaScript and
Expand All @@ -17,12 +43,11 @@ below use a macOS/Linux POSIX shell with `curl` and `tar`.

[Download Scanner v0.1.0](https://github.com/patchwrk-dev/patchwrk-scanner/releases/download/v0.1.0/patchwrk-scanner-0.1.0.tgz) ·
[Download checksum](https://github.com/patchwrk-dev/patchwrk-scanner/releases/download/v0.1.0/patchwrk-scanner-0.1.0.tgz.sha256) ·
[Experimental prerelease notes](https://github.com/patchwrk-dev/patchwrk-scanner/releases/tag/v0.1.0)
[CLI v0.1.0 prerelease notes](https://github.com/patchwrk-dev/patchwrk-scanner/releases/tag/v0.1.0)

Use the named `.tgz` release asset, **not** GitHub's automatic “Source code” archives.
No cloning, npm install, pnpm or TypeScript compilation is required. This is a
manual download/extraction workflow, not one-click installation. npm/Marketplace
installation is not offered by this project.
manual download/extraction workflow, not one-click installation. npm installation is not offered. VS Code users can use the Marketplace link above.

In a new directory, download both assets (or save them using the links above):

Expand Down Expand Up @@ -151,7 +176,7 @@ migration recommendation may itself be outdated.
## Security and privacy

- Offline, read-only target scanning: no provider calls, source execution, dependency
installation, telemetry or uploads. Network is needed to download the archive only.
installation, telemetry or uploads. Downloads and editor/Marketplace services have their own network behavior.
- Use stable checkouts/private output locations. Symlinks/hardlinks and credential
paths are excluded; portable path checks are not a hostile-filesystem sandbox.
- HTML/history omit absolute target paths, raw arguments and source snippets, but
Expand All @@ -162,7 +187,7 @@ migration recommendation may itself be outdated.

MIT © 2026 Jovan Simon; [LICENSE](LICENSE) and [ownership provenance](PUBLIC_PROVENANCE.md)
remain intact. The archive includes third-party licenses/notices. For confidential
vulnerabilities use [SECURITY.md](SECURITY.md), not public issues. Best-effort beta
vulnerabilities use [SECURITY.md](SECURITY.md), not public issues. Best-effort
support, no SLA. [Issues](https://github.com/patchwrk-dev/patchwrk-scanner/issues/new/choose),
[questions](https://github.com/patchwrk-dev/patchwrk-scanner/discussions) and
[sanitized feedback](FEEDBACK.md) use existing GitHub channels; no automatic collection.
Expand All @@ -176,22 +201,15 @@ entries establish recorded resolution; pnpm/Yarn/Bun locks remain unsupported.
Traversal/AST budgets may yield partial results and are not hard parser CPU/heap
isolation. Empty or unknown results are not compatibility passes. Read the
[detailed discovery/assessment limits](docs/SCANNER_REPORTS.md#detection-and-compatibility-limits)
and [beta testing guide](BETA_TESTING.md).
and [developer onboarding guide](BETA_TESTING.md).

Free Scanner offers manual discovery, historical assessments, terminal/JSON/HTML,
opt-in local history and manual comparison. **PatchWRK Cloud is planned and unavailable.**
opt-in local history and manual comparison. **PatchWRK Pro is an upcoming paid API maintenance platform, not yet available.**
Official provider monitoring, impact analysis, AI-assisted repairs, scoped testing and
developer-approved pull requests are planned.
There is no continuous monitoring, automatic provider-change intelligence, AI repair,
automated migration verification, automatic GitHub PRs or Cloud-hosted dashboards.

## VS Code extension — upcoming, not publicly available

Planned public installation experience: search **PatchWRK Scanner** in VS Code
Extensions → Install → open a project → click the PatchWRK icon → Run Scan → review
reports, history and comparisons. This is **not a current installation method**.
Use the verified GitHub archive above until an extension is published and verified.
No Marketplace badge or install link is provided. [Required genuine screenshot assets](docs/SCANNER_REPORTS.md#screenshot-assets--pending-approval)
are documented; no approved captures are available in this update.

## Build from reviewed public source

**Contributors only; not required to use the prebuilt Scanner.** Install Git,
Expand All @@ -210,4 +228,4 @@ node dist/index.js --help
Source setup may download build dependencies. Do not run these commands in the
scan target or enable lifecycle scripts indiscriminately. The ordinary npm dry-run
package is not the self-contained GitHub bundle. Package privacy, license, security
and experimental limitations remain unchanged. See [CONTRIBUTING.md](CONTRIBUTING.md).
and technical limitations remain unchanged. See [CONTRIBUTING.md](CONTRIBUTING.md).
4 changes: 2 additions & 2 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Security policy — PatchWRK Scanner experimental beta
# Security policy — PatchWRK Scanner

Current v0.x experimental versions have best-effort support only. No guaranteed
Current Scanner releases have best-effort support only. No guaranteed
backports, response times or remediation dates. No third-party audit/certification
or production compatibility guarantee is claimed.

Expand Down
Loading
Loading