Guide
From first launch to public GitHub release.
Use this when you want the entire path in one place: setup, recovery, validation, packaging, and Pages deployment.
Quick start
Choose one supported entry point.
Windows-first
./scripts/00_windows_launcher.ps1 -Yes
Use this if you start in PowerShell and want the handoff into WSL handled for you.
Remote-WSL direct
bash scripts/00_run_full_setup.sh --yes
Use this if you are already in VS Code Remote - WSL and want the shortest supported path.
Guided model selection only
bash scripts/00_run_full_setup.sh --dry-run-prompt --restart
This is useful for testing the recommendation and prompt experience without triggering preflight, hardening, or gateway startup.
Setup phases
The flow is ordered to keep failures visible and exposure controlled.
- Detect hardware and write the recommendation artifact.
- Run preflight checks for WSL, systemd, sudo, and baseline readiness.
- Force CPU-first runtime defaults for beginner safety.
- Verify Ollama health and pull the selected model if needed.
- Install and onboard OpenClaw.
- Harden OpenClaw and run the gateway security gate.
- Start the gateway only after the gate passes.
Verification
Check the setup without guessing.
bash scripts/99_verify_setup.sh
The report is written to .security/setup-validation-report.json by default.
CI-safe smoke commands
bash scripts/00_run_full_setup.sh --dry-run-prompt --yes --no-model-prompt --restart --skip-detect
bash scripts/98_smoke_model_picker_advanced.sh
Recovery
Interrupted setup does not mean start from zero.
bash scripts/00_run_full_setup.sh --yes
bash scripts/00_run_full_setup.sh --restart --yes
bash scripts/99_rollback.sh
Resume uses state stored under .security/setup-state/. Restart resets the phase index but keeps the repo structure intact.
Support routing
Ask in Discussions first when the problem is exploratory or conversational.
- Q&A: setup help, troubleshooting, and validation questions
- Ideas: early feature thoughts before they become concrete requests
- General: broader usage discussion and showcase posts
- Issues: reproducible bugs and specific, actionable feature requests
Release
Package locally, then publish by tag.
bash scripts/97_package_release.sh --version v0.2.1 --require-zip --install-zip-if-missing
That command produces a versioned release directory, a tarball, a zip when available, and a checksum manifest in dist/.
git tag v0.2.1
git push origin v0.2.1
The release workflow validates, packages, uploads, and creates the GitHub Release automatically.
Pages deployment
Your public project front door is already included.
The repository contains a Pages workflow that deploys the site/ directory. After the repo exists on GitHub:
- Push the repository to GitHub.
- Open repository settings and confirm GitHub Pages is set to use GitHub Actions.
- Push to
mainormasterand let the Pages workflow deploy.