@qmahyar/cf-scanner
v0.13.0
Published
Find working Cloudflare endpoints on restricted networks
Maintainers
Readme
@qmahyar/cf-scanner
Find working Cloudflare endpoints on restricted networks.
This package downloads a prebuilt binary from GitHub Releases during npm install.
Install
npm install -g @qmahyar/cf-scannerUsage
# CDN/proxy scan
cf-scanner scan --mode cdn --preset quick
# WARP scan
cf-scanner scan --mode warp --count 100
# Export results (csv, json, base64, raw, singbox, clash)
cf-scanner scan --mode cdn --preset quick --export results.csvSupported Platforms
| OS | Arch | Status | |----|------|--------| | Linux | x64 | ✅ Supported | | Linux | arm64 | ✅ Supported | | Windows | x64 | ✅ Supported | | macOS | any | ❌ Not supported (unsigned binaries) |
How it works
On npm install, the postinstall script detects your OS and architecture, then downloads the correct prebuilt archive from the GitHub release for the current version and unpacks the binary (plus its bundled xray helper) into bin/. npm links the bin/cf-scanner.js wrapper (a small Node launcher that spawns the platform binary — cf-scanner.exe on Windows) into node_modules/.bin/, which npm adds to your PATH when you install globally.
The npm version and the GitHub release tag can differ: install.js pins the download tag separately (RELEASE_TAG), so the wrapper can be patched without a new binary release.
Manual Installation
If the automatic download fails, you can install manually from the Releases page.
Skip Binary Download
Set CF_SCANNER_SKIP_INSTALL=1 to skip the binary download during install.
License
MIT
