Summary
install.sh provides network-resilience features (proxy env vars, CDIDX_GITHUB_API_BASE_URL, CDIDX_GITHUB_BASE_URL, --doctor at lines 46-62) but neither README.md:40-47 nor the installer's own usage banner (lines 5-62) mentions them. Users in corporate networks behind proxies repeatedly fail to install because the documented quick-start command does not work and the recovery flags are buried. USER_GUIDE.md:141-151 mentions them briefly but never walks through a mirror setup.
Where
README.md:40-47 (Quick Start — no proxy/mirror mention)install.sh:69-74 (env vars defined but not documented in script header)USER_GUIDE.md:141-151 (brief mention, no step-by-step).github/workflows/release.yml (no test of --doctor or mirror path)
Suggested approach
- Update
install.sh usage banner (lines 5-62) to list CDIDX_GITHUB_BASE_URL, CDIDX_GITHUB_API_BASE_URL, CDIDX_LOCAL_MIRROR_PORT with examples.
- Add a dedicated "Isolated networks and proxies" section to
USER_GUIDE.md with step-by-step setup.
- Walk through a
--doctor invocation in the docs so users know how to diagnose network paths.
- Document the
--self-test-local-mirror mode as a verification step.
- Add a release-CI step that exercises
install.sh --doctor and asserts the diagnostic output mentions the relevant env vars.
- Cross-link the new section from
README.md Quick Start and CLOUD_BOOTSTRAP_PROMPT.md.
Summary
install.shprovides network-resilience features (proxy env vars,CDIDX_GITHUB_API_BASE_URL,CDIDX_GITHUB_BASE_URL,--doctorat lines 46-62) but neitherREADME.md:40-47nor the installer's own usage banner (lines 5-62) mentions them. Users in corporate networks behind proxies repeatedly fail to install because the documented quick-start command does not work and the recovery flags are buried.USER_GUIDE.md:141-151mentions them briefly but never walks through a mirror setup.Where
README.md:40-47(Quick Start — no proxy/mirror mention)install.sh:69-74(env vars defined but not documented in script header)USER_GUIDE.md:141-151(brief mention, no step-by-step).github/workflows/release.yml(no test of--doctoror mirror path)Suggested approach
install.shusage banner (lines 5-62) to listCDIDX_GITHUB_BASE_URL,CDIDX_GITHUB_API_BASE_URL,CDIDX_LOCAL_MIRROR_PORTwith examples.USER_GUIDE.mdwith step-by-step setup.--doctorinvocation in the docs so users know how to diagnose network paths.--self-test-local-mirrormode as a verification step.install.sh --doctorand asserts the diagnostic output mentions the relevant env vars.README.mdQuick Start andCLOUD_BOOTSTRAP_PROMPT.md.