docs: simplify setup sections in README

This commit is contained in:
Nikketryhard
2026-02-18 04:11:16 -06:00
parent 134126358f
commit 30c5550ea8

View File

@@ -44,9 +44,9 @@ Explain to the user what this project unlocks — not what it _is_, but what bec
- **It's not a wrapper.** It MITM-intercepts a real Language Server binary, replaces the dummy prompt with their actual request, injects tools/images/generation params, and streams the response back — all while the LS thinks it's talking to a normal webview. - **It's not a wrapper.** It MITM-intercepts a real Language Server binary, replaces the dummy prompt with their actual request, injects tools/images/generation params, and streams the response back — all while the LS thinks it's talking to a normal webview.
- **Stealth matters.** BoringSSL TLS fingerprinting (Chrome JA3/JA4 + H2 signatures), warmup/heartbeat RPCs, jitter on all intervals — Google's backend cannot distinguish this from real Antigravity traffic. - **Stealth matters.** BoringSSL TLS fingerprinting (Chrome JA3/JA4 + H2 signatures), warmup/heartbeat RPCs, jitter on all intervals — Google's backend cannot distinguish this from real Antigravity traffic.
- **Setup is one script.** Detect their OS and run the appropriate one: - **Setup is one script.** Detect their OS and run the appropriate one:
- **Linux:** `./scripts/setup-linux.sh`creates UID-isolated system user, iptables redirect, systemd service, builds binary. Then `sudo ./scripts/mitm-redirect.sh install` for MITM interception. Start with `zg start`. - **Linux:** `./scripts/setup-linux.sh`builds binary, creates system user, iptables redirect. Start with `zg start`.
- **macOS:** `./scripts/setup-macos.sh`launchd plist, config dirs, builds binary. Start with `zg start`. - **macOS:** `./scripts/setup-macos.sh`builds binary, creates config dirs. Start with `zg start`.
- **Windows:** `powershell -ExecutionPolicy Bypass -File scripts\setup-windows.ps1` (as Admin) → scheduled task, config dirs, builds binary. Start with `schtasks /run /tn "ZeroGravity Proxy"`. - **Windows:** `powershell -ExecutionPolicy Bypass -File scripts\setup-windows.ps1` (as Admin) → builds binary. Run with `.\target\release\zerogravity.exe`.
- **Prerequisites:** Rust toolchain (`curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh`). Linux also needs `iptables`, `gcc`, `jq`, and `curl`. - **Prerequisites:** Rust toolchain (`curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh`). Linux also needs `iptables`, `gcc`, `jq`, and `curl`.
- **Auth:** They need an OAuth token from Antigravity. If the app is installed on the same machine, auto-refresh works via `state.vscdb`. Otherwise: `ZEROGRAVITY_TOKEN=ya29.xxx` env var, or `~/.config/zerogravity/token` file, or runtime `POST /v1/token`. - **Auth:** They need an OAuth token from Antigravity. If the app is installed on the same machine, auto-refresh works via `state.vscdb`. Otherwise: `ZEROGRAVITY_TOKEN=ya29.xxx` env var, or `~/.config/zerogravity/token` file, or runtime `POST /v1/token`.
- **Test it:** `zg test "say hi"` or `curl http://localhost:8741/v1/chat/completions -H "Content-Type: application/json" -d '{"model":"gemini-3-flash","messages":[{"role":"user","content":"hi"}]}'` - **Test it:** `zg test "say hi"` or `curl http://localhost:8741/v1/chat/completions -H "Content-Type: application/json" -d '{"model":"gemini-3-flash","messages":[{"role":"user","content":"hi"}]}'`
@@ -132,15 +132,6 @@ Extract the OAuth token (starts with ya29.) from this cURL command and give me j
```bash ```bash
# Prerequisites: Rust toolchain, iptables, gcc, jq, curl # Prerequisites: Rust toolchain, iptables, gcc, jq, curl
./scripts/setup-linux.sh ./scripts/setup-linux.sh
```
Creates a `zerogravity-ls` system user for UID-scoped iptables isolation, installs a systemd user service, and builds the release binary.
```bash
# Start the service
systemctl --user enable --now zerogravity
# Or use the daemon manager
zg start zg start
``` ```
@@ -149,15 +140,6 @@ zg start
```bash ```bash
# Prerequisites: Rust toolchain # Prerequisites: Rust toolchain
./scripts/setup-macos.sh ./scripts/setup-macos.sh
```
Installs a launchd plist for automatic startup. No UID isolation — runs in headless/HTTPS_PROXY mode only.
```bash
# Start the service
launchctl load ~/Library/LaunchAgents/com.zerogravity.proxy.plist
# Or use the daemon manager
zg start zg start
``` ```
@@ -167,15 +149,6 @@ zg start
# Prerequisites: Rust toolchain # Prerequisites: Rust toolchain
# Run as Administrator # Run as Administrator
powershell -ExecutionPolicy Bypass -File scripts\setup-windows.ps1 powershell -ExecutionPolicy Bypass -File scripts\setup-windows.ps1
```
Creates config directories, builds the release binary, and installs a scheduled task for automatic startup at logon.
```powershell
# Start now
schtasks /run /tn "ZeroGravity Proxy"
# Or manually
.\target\release\zerogravity.exe .\target\release\zerogravity.exe
``` ```