mirror of
https://github.com/OpenRouterTeam/spawn.git
synced 2026-04-28 11:59:29 +00:00
- soak.sh: SOAK_CLOUD env var makes cloud configurable (default: sprite) - qa.sh: load TELEGRAM_BOT_TOKEN, TELEGRAM_TEST_CHAT_ID, SOAK_CLOUD from /etc/spawn-qa-auth.env in soak mode - qa.yml: add weekly Monday 3am UTC scheduled soak trigger - fix: bun eval → bun -e across soak.sh, key-request.sh, github-auth.sh (bun eval is not a valid subcommand in bun 1.3.9) - fix: export _TOKEN via env prefix so process.env._TOKEN works in bun -e - docs: update shell-scripts.md rule to say bun -e (not bun eval) Verified: 3/4 Telegram tests pass in smoke test on DigitalOcean (120s wait) getMe ✓ sendMessage ✓ getWebhookInfo ✓; cron test needs full 55-min window. Co-authored-by: spawn-qa-bot <qa@openrouter.ai> Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
2.7 KiB
2.7 KiB
Shell Script Rules
These rules are non-negotiable — violating them breaks remote execution for all users.
curl|bash Compatibility
Every script MUST work when executed via bash <(curl -fsSL URL):
- NEVER use relative paths for sourcing (
source ./lib/...,source ../shared/...) - NEVER rely on
$0,dirname $0, orBASH_SOURCEresolving to a real filesystem path
macOS bash 3.x Compatibility
macOS ships bash 3.2. All scripts MUST work on it:
- NO
echo -e— useprintffor escape sequences - NO
source <(cmd)insidebash <(curl ...)— useeval "$(cmd)"instead - NO
((var++))withset -e— usevar=$((var + 1))(avoids falsy-zero exit) - NO
localkeyword inside( ... ) &subshells — not function scope - NO
set -u(nounset) — use${VAR:-}for optional env var checks instead
Conventions
#!/bin/bash+set -eo pipefail(nouflag)- Use
${VAR:-}for all optional env var checks (OPENROUTER_API_KEY, cloud tokens, etc.) - Primary script URL:
https://openrouter.ai/labs/spawn/{path}(CDN proxy, maps to reposh/, e.g.,{cloud}/{agent}.sh) - Fallback script URL:
https://raw.githubusercontent.com/OpenRouterTeam/spawn/main/sh/{path} - Version check URL:
https://github.com/OpenRouterTeam/spawn/releases/download/cli-latest/version(GitHub release artifact) - All env vars documented in the cloud's
sh/{cloud}/README.md
Use Bun + TypeScript for Inline Scripting — NEVER python/python3
When shell scripts need JSON processing, HTTP calls, crypto, or any non-trivial logic:
- ALWAYS use
bun -e '...'or write a temp.tsfile andbun runit - NEVER use
python3 -corpython -cfor inline scripting — python is not a project dependency - Prefer
jqfor simple JSON extraction; fall back tobun -ewhen jq is unavailable - Pass data to bun via environment variables (e.g.,
_DATA="${var}" bun -e "...") or temp files — never interpolate untrusted values into JS strings - For complex operations (SigV4 signing, API calls with retries), write a heredoc
.tsfile andbun runit
ESM Only — NEVER use require() or CommonJS
All TypeScript code in packages/cli/src/ MUST use ESM (import/export):
- NEVER use
require()— always useimport(static or dynamicawait import()) - NEVER use
module.exports— always useexport/export default - NEVER use
createRequire— it's a CJS compatibility hack that triggers Bun bugs - The project is
"type": "module"inpackage.json— CJS is not supported - For Node.js built-ins:
import fs from "fs",import path from "path", etc. - For dynamic imports:
const mod = await import("./module.ts")