crabbox/docs/features
2026-05-01 09:41:43 +01:00
..
actions-hydration.md docs: document lease slugs and idle timeout 2026-05-01 08:01:00 +01:00
auth-admin.md docs: document lease slugs and idle timeout 2026-05-01 08:01:00 +01:00
broker-auth-routing.md docs: add pages documentation site 2026-05-01 02:44:43 +01:00
cache.md docs: document lease slugs and idle timeout 2026-05-01 08:01:00 +01:00
coordinator.md docs: back crabbox documentation with source map 2026-05-01 09:41:43 +01:00
cost-usage.md docs: add pages documentation site 2026-05-01 02:44:43 +01:00
history-logs.md feat: add broker auth and run history 2026-05-01 03:35:11 +01:00
lifecycle-cleanup.md docs: document lease slugs and idle timeout 2026-05-01 08:01:00 +01:00
providers.md docs: add pages documentation site 2026-05-01 02:44:43 +01:00
README.md docs: back crabbox documentation with source map 2026-05-01 09:41:43 +01:00
repository-onboarding.md docs: document actions hydration workflow 2026-05-01 03:04:51 +01:00
runner-bootstrap.md fix: stabilize slug idle leases 2026-05-01 09:06:20 +01:00
ssh-keys.md docs: add pages documentation site 2026-05-01 02:44:43 +01:00
sync.md feat: improve crabbox run diagnostics 2026-05-01 06:43:25 +01:00
test-results.md fix: harden cache and result handling 2026-05-01 06:13:33 +01:00

Features

Feature docs explain what Crabbox can do and how the pieces fit together. Command syntax lives in ../commands/README.md.

Read when:

  • you want a capability overview;
  • you are deciding where a behavior belongs;
  • you need the feature-level contract before changing code.

Core features:

  • Coordinator: brokered leases through Cloudflare Workers and Durable Objects.
  • Broker auth and routing: bearer tokens, Cloudflare Access identity, and Worker routes.
  • Providers: Hetzner and AWS EC2 Spot provisioning, classes, and fallback.
  • Runner bootstrap: cloud-init, installed tools, SSH port, and readiness.
  • Sync: Git file-list manifests, rsync, fingerprints, excludes, guardrails, and sanity checks.
  • Actions hydration: let GitHub Actions prepare a runner, then sync local work into that workspace.
  • SSH keys: per-lease keys, provider key cleanup, and local storage.
  • Cost and usage: guardrails, provider-backed pricing, and reporting.
  • History and logs: coordinator run records and retained remote output tails.
  • Test results: JUnit summaries attached to recorded runs.
  • Cache controls: inspect, purge, and warm remote package/build caches.
  • Auth and admin: login/logout/whoami and trusted operator controls.
  • Lifecycle cleanup: release, expiry, keep mode, and direct cleanup.
  • Repository onboarding: crabbox init, repo config, workflow stub, and agent skill.
  • Source map: implementation files behind documented behavior.

Command docs: