Skip to content

docs: add troubleshooting for proxy/TLS, timeouts, and Homebrew fallback - #2

Open
wtzmx wants to merge 1 commit into
aloth:mainfrom
wtzmx:main
Open

docs: add troubleshooting for proxy/TLS, timeouts, and Homebrew fallback#2
wtzmx wants to merge 1 commit into
aloth:mainfrom
wtzmx:main

Conversation

@wtzmx

@wtzmx wtzmx commented Jul 28, 2026

Copy link
Copy Markdown

Summary

Added practical troubleshooting docs based on real-world usage testing.

Changes

SKILL.md:

  • --timeout tip added to the Tips section (default 10s is too short for large projects)
  • Troubleshooting section: TLS/proxy error with VPN apps (Shadowrocket/Clash/Surge)
  • Homebrew npm cache failure workaround
  • CLI verification commands

README.md:

  • Added timeout hint to Quick Start example
  • Troubleshooting section with proxy fix and Homebrew fallback

Motivation

Testing on macOS with common proxy setups (Shadowrocket TUN mode) revealed two pain points:

  1. Node.js https.request() ignores system proxy → TLS connection reset with cryptic error
  2. Default 10s timeout causes pull/pdf/output to fail on normal-sized projects

These docs save future users the debugging time.

- Add timeout tips for pull/pdf/compile/output commands
- Document TLS/proxy issue with VPN apps (Shadowrocket, Clash, Surge)
- Add Homebrew failure workaround (npm install -g)
- Add connectivity verification tip (curl check)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant