create-hq 5.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/deps.d.ts +4 -0
- package/dist/deps.d.ts.map +1 -0
- package/dist/deps.js +65 -0
- package/dist/deps.js.map +1 -0
- package/dist/git.d.ts +3 -0
- package/dist/git.d.ts.map +1 -0
- package/dist/git.js +19 -0
- package/dist/git.js.map +1 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +23 -0
- package/dist/index.js.map +1 -0
- package/dist/scaffold.d.ts +8 -0
- package/dist/scaffold.d.ts.map +1 -0
- package/dist/scaffold.js +130 -0
- package/dist/scaffold.js.map +1 -0
- package/dist/ui.d.ts +7 -0
- package/dist/ui.d.ts.map +1 -0
- package/dist/ui.js +36 -0
- package/dist/ui.js.map +1 -0
- package/package.json +41 -0
- package/template/.claude/CLAUDE.md +202 -0
- package/template/.claude/commands/checkpoint.md +127 -0
- package/template/.claude/commands/cleanup.md +307 -0
- package/template/.claude/commands/execute-task.md +440 -0
- package/template/.claude/commands/exit-plan.md +41 -0
- package/template/.claude/commands/handoff.md +97 -0
- package/template/.claude/commands/learn.md +218 -0
- package/template/.claude/commands/metrics.md +118 -0
- package/template/.claude/commands/newworker.md +162 -0
- package/template/.claude/commands/nexttask.md +67 -0
- package/template/.claude/commands/prd.md +238 -0
- package/template/.claude/commands/reanchor.md +51 -0
- package/template/.claude/commands/remember.md +126 -0
- package/template/.claude/commands/run-project.md +348 -0
- package/template/.claude/commands/run.md +110 -0
- package/template/.claude/commands/search-reindex.md +62 -0
- package/template/.claude/commands/search.md +100 -0
- package/template/.claude/commands/setup.md +381 -0
- package/template/.claude/scripts/pure-ralph-loop.ps1 +312 -0
- package/template/.claude/scripts/pure-ralph-loop.sh +859 -0
- package/template/CHANGELOG.md +220 -0
- package/template/LICENSE +21 -0
- package/template/MIGRATION.md +259 -0
- package/template/README.md +368 -0
- package/template/data/journal/.gitkeep +0 -0
- package/template/docs/images/ascii-banner-options.md +122 -0
- package/template/docs/images/hq-banner.svg +105 -0
- package/template/knowledge/Ralph/01-overview.md +71 -0
- package/template/knowledge/Ralph/02-core-concepts.md +114 -0
- package/template/knowledge/Ralph/03-how-ralph-works.md +184 -0
- package/template/knowledge/Ralph/04-back-pressure.md +222 -0
- package/template/knowledge/Ralph/05-specifications.md +210 -0
- package/template/knowledge/Ralph/06-agents-md.md +222 -0
- package/template/knowledge/Ralph/07-implementation.md +316 -0
- package/template/knowledge/Ralph/08-economics.md +182 -0
- package/template/knowledge/Ralph/09-resources.md +145 -0
- package/template/knowledge/Ralph/10-claude-code-workflow.md +212 -0
- package/template/knowledge/Ralph/11-team-training-guide.md +383 -0
- package/template/knowledge/Ralph/README.md +40 -0
- package/template/knowledge/ai-security-framework/CONTRIBUTING.md +139 -0
- package/template/knowledge/ai-security-framework/GLOSSARY.md +176 -0
- package/template/knowledge/ai-security-framework/LICENSE +21 -0
- package/template/knowledge/ai-security-framework/QUICK-START.md +172 -0
- package/template/knowledge/ai-security-framework/README.md +232 -0
- package/template/knowledge/ai-security-framework/checklists/browser-security.md +301 -0
- package/template/knowledge/ai-security-framework/checklists/credential-isolation.md +322 -0
- package/template/knowledge/ai-security-framework/checklists/incident-response.md +288 -0
- package/template/knowledge/ai-security-framework/checklists/pre-flight.md +249 -0
- package/template/knowledge/ai-security-framework/checklists/weekly-audit.md +159 -0
- package/template/knowledge/ai-security-framework/configs/audit-logging.md +372 -0
- package/template/knowledge/ai-security-framework/configs/kill-switches.md +354 -0
- package/template/knowledge/ai-security-framework/docs/01-core-principles.md +256 -0
- package/template/knowledge/ai-security-framework/docs/02-threat-landscape.md +326 -0
- package/template/knowledge/ai-security-framework/docs/03-security-posture.md +250 -0
- package/template/knowledge/ai-security-framework/templates/agents-security.md +233 -0
- package/template/knowledge/design-styles/README.md +42 -0
- package/template/knowledge/design-styles/american-industrial.md +136 -0
- package/template/knowledge/design-styles/ethereal-abstract.md +133 -0
- package/template/knowledge/design-styles/liminal-portal.md +111 -0
- package/template/knowledge/design-styles/swipes/american-industrial/G-3m4YPW0AADdu2.jpeg +0 -0
- package/template/knowledge/design-styles/swipes/american-industrial/G-JJlt5WwAABK3K.png +0 -0
- package/template/knowledge/design-styles/swipes/american-industrial/G-JJmj5W0AEbJ-7.png +0 -0
- package/template/knowledge/design-styles/swipes/american-industrial/G59fgNuXkAAKLJQ (1).jpeg +0 -0
- package/template/knowledge/design-styles/swipes/american-industrial/G59fgNuXkAAKLJQ.jpeg +0 -0
- package/template/knowledge/design-styles/swipes/american-industrial/G7fVkn3WEAAM-ST.jpeg +0 -0
- package/template/knowledge/design-styles/swipes/american-industrial/G8ECO5JWEAIksyn.png +0 -0
- package/template/knowledge/design-styles/swipes/american-industrial/G9-3GQSWoAA8eqZ.png +0 -0
- package/template/knowledge/design-styles/swipes/american-industrial/G9xEOqrXkAEZRcs.png +0 -0
- package/template/knowledge/design-styles/swipes/american-industrial/G_MVeJrXQAA8sx4.jpeg +0 -0
- package/template/knowledge/design-styles/swipes/american-industrial/G_RSkmGXkAAgAVZ.png +0 -0
- package/template/knowledge/design-styles/swipes/american-industrial/README.md +31 -0
- package/template/knowledge/design-styles/swipes/american-industrial/qyqtg7Dq.png +0 -0
- package/template/knowledge/dev-team/README.md +35 -0
- package/template/knowledge/dev-team/patterns/README.md +34 -0
- package/template/knowledge/dev-team/patterns/frontend/react-best-practices.md +178 -0
- package/template/knowledge/dev-team/troubleshooting/README.md +31 -0
- package/template/knowledge/dev-team/workflows/README.md +49 -0
- package/template/knowledge/hq/checkpoint-schema.json +51 -0
- package/template/knowledge/hq/index-md-spec.md +74 -0
- package/template/knowledge/hq/thread-schema.md +153 -0
- package/template/knowledge/hq-core/checkpoint-schema.json +51 -0
- package/template/knowledge/hq-core/index-md-spec.md +74 -0
- package/template/knowledge/hq-core/thread-schema.md +153 -0
- package/template/knowledge/loom/README.md +51 -0
- package/template/knowledge/loom/architecture.md +125 -0
- package/template/knowledge/loom/code-style.md +169 -0
- package/template/knowledge/loom/llm-proxy.md +132 -0
- package/template/knowledge/loom/state-machine.md +131 -0
- package/template/knowledge/loom/thread-system.md +117 -0
- package/template/knowledge/loom/tools.md +94 -0
- package/template/knowledge/loom/weaver.md +96 -0
- package/template/knowledge/loom/web-frontend.md +131 -0
- package/template/knowledge/projects/README.md +72 -0
- package/template/knowledge/projects/templates/README.template.md +28 -0
- package/template/knowledge/workers/README.md +195 -0
- package/template/knowledge/workers/ralph-loop-pattern.md +157 -0
- package/template/knowledge/workers/skill-schema.md +182 -0
- package/template/knowledge/workers/state-machine.md +102 -0
- package/template/knowledge/workers/templates/base-worker.yaml +73 -0
- package/template/knowledge/workers/templates/code-worker.yaml +85 -0
- package/template/knowledge/workers/templates/skill.yaml +49 -0
- package/template/knowledge/workers/templates/social-worker.yaml +70 -0
- package/template/modules/examples/full-manifest.yaml +92 -0
- package/template/modules/examples/minimal.yaml +14 -0
- package/template/modules/modules.yaml +59 -0
- package/template/projects/.gitkeep +0 -0
- package/template/projects/incorporate-workers-into-pure-ralph/prd.json +88 -0
- package/template/projects/pure-ralph-branch-isolation/README.md +114 -0
- package/template/projects/pure-ralph-branch-isolation/prd.json +123 -0
- package/template/projects/purist-ralph-loop/README.md +148 -0
- package/template/projects/purist-ralph-loop/prd.json +135 -0
- package/template/projects/ralph-test/prd.json +50 -0
- package/template/prompts/pure-ralph-base.md +551 -0
- package/template/settings/.gitkeep +0 -0
- package/template/settings/pure-ralph.json +42 -0
- package/template/social-content/drafts/INDEX.md +21 -0
- package/template/social-content/drafts/linkedin/.gitkeep +1 -0
- package/template/social-content/drafts/x/.gitkeep +1 -0
- package/template/social-content/images/.gitkeep +1 -0
- package/template/starter-projects/code-worker/README.md +97 -0
- package/template/starter-projects/code-worker/prd.json +45 -0
- package/template/starter-projects/personal-assistant/README.md +42 -0
- package/template/starter-projects/personal-assistant/prd.json +43 -0
- package/template/starter-projects/social-media/README.md +60 -0
- package/template/starter-projects/social-media/prd.json +43 -0
- package/template/workers/content-brand/README.md +59 -0
- package/template/workers/content-brand/skills/messaging-alignment.md +91 -0
- package/template/workers/content-brand/skills/tone-check.md +76 -0
- package/template/workers/content-brand/skills/voice-analysis.md +68 -0
- package/template/workers/content-brand/worker.yaml +81 -0
- package/template/workers/content-legal/README.md +80 -0
- package/template/workers/content-legal/skills/claim-substantiation.md +150 -0
- package/template/workers/content-legal/skills/compliance-scan.md +123 -0
- package/template/workers/content-legal/skills/disclaimer-check.md +146 -0
- package/template/workers/content-legal/worker.yaml +118 -0
- package/template/workers/content-product/README.md +77 -0
- package/template/workers/content-product/skills/claim-verification.md +96 -0
- package/template/workers/content-product/skills/feature-accuracy.md +117 -0
- package/template/workers/content-product/skills/stats-check.md +128 -0
- package/template/workers/content-product/worker.yaml +97 -0
- package/template/workers/content-sales/README.md +70 -0
- package/template/workers/content-sales/skills/conversion-analysis.md +96 -0
- package/template/workers/content-sales/skills/cta-audit.md +107 -0
- package/template/workers/content-sales/skills/value-prop-check.md +114 -0
- package/template/workers/content-sales/worker.yaml +93 -0
- package/template/workers/content-shared/cli.ts +242 -0
- package/template/workers/content-shared/index.ts +234 -0
- package/template/workers/content-shared/lib/accuracy-analyzer.ts +661 -0
- package/template/workers/content-shared/lib/analyze.ts +370 -0
- package/template/workers/content-shared/lib/brand-analyzer.ts +526 -0
- package/template/workers/content-shared/lib/cms-integration.ts +446 -0
- package/template/workers/content-shared/lib/compliance-analyzer.ts +655 -0
- package/template/workers/content-shared/lib/conversion-analyzer.ts +555 -0
- package/template/workers/content-shared/lib/github-integration.ts +582 -0
- package/template/workers/content-shared/lib/output.ts +373 -0
- package/template/workers/content-shared/lib/parser.ts +771 -0
- package/template/workers/content-shared/lib/priority.ts +439 -0
- package/template/workers/content-shared/lib/recommendations.ts +512 -0
- package/template/workers/content-shared/lib/reporter.ts +749 -0
- package/template/workers/content-shared/lib/restructure.ts +664 -0
- package/template/workers/content-shared/lib/scorer.ts +140 -0
- package/template/workers/content-shared/lib/types.ts +227 -0
- package/template/workers/content-shared/lib/variants.ts +595 -0
- package/template/workers/content-shared/package.json +51 -0
- package/template/workers/content-shared/pnpm-lock.yaml +39 -0
- package/template/workers/content-shared/test/sample-page.json +115 -0
- package/template/workers/content-shared/tsconfig.json +20 -0
- package/template/workers/dev-team/README.md +166 -0
- package/template/workers/dev-team/_template.yaml +70 -0
- package/template/workers/dev-team/architect/package.json +27 -0
- package/template/workers/dev-team/architect/skills/api-design.md +89 -0
- package/template/workers/dev-team/architect/skills/refactor-plan.md +96 -0
- package/template/workers/dev-team/architect/skills/system-design.md +100 -0
- package/template/workers/dev-team/architect/src/index.ts +49 -0
- package/template/workers/dev-team/architect/src/mcp-server.ts +122 -0
- package/template/workers/dev-team/architect/src/skills/api-design.ts +316 -0
- package/template/workers/dev-team/architect/src/skills/refactor-plan.ts +264 -0
- package/template/workers/dev-team/architect/src/skills/system-design.ts +212 -0
- package/template/workers/dev-team/architect/tsconfig.json +19 -0
- package/template/workers/dev-team/architect/worker.yaml +128 -0
- package/template/workers/dev-team/backend-dev/package-lock.json +1252 -0
- package/template/workers/dev-team/backend-dev/package.json +27 -0
- package/template/workers/dev-team/backend-dev/skills/implement-endpoint.md +70 -0
- package/template/workers/dev-team/backend-dev/skills/implement-service.md +62 -0
- package/template/workers/dev-team/backend-dev/src/index.ts +51 -0
- package/template/workers/dev-team/backend-dev/src/mcp-server.ts +109 -0
- package/template/workers/dev-team/backend-dev/src/skills/implement-endpoint.ts +122 -0
- package/template/workers/dev-team/backend-dev/src/skills/implement-service.ts +126 -0
- package/template/workers/dev-team/backend-dev/tsconfig.json +19 -0
- package/template/workers/dev-team/backend-dev/worker.yaml +128 -0
- package/template/workers/dev-team/code-reviewer/package-lock.json +1080 -0
- package/template/workers/dev-team/code-reviewer/package.json +24 -0
- package/template/workers/dev-team/code-reviewer/skills/merge-to-production.md +61 -0
- package/template/workers/dev-team/code-reviewer/skills/merge-to-staging.md +54 -0
- package/template/workers/dev-team/code-reviewer/skills/request-changes.md +63 -0
- package/template/workers/dev-team/code-reviewer/skills/review-pr.md +77 -0
- package/template/workers/dev-team/code-reviewer/src/index.ts +56 -0
- package/template/workers/dev-team/code-reviewer/src/mcp-server.ts +101 -0
- package/template/workers/dev-team/code-reviewer/tsconfig.json +19 -0
- package/template/workers/dev-team/code-reviewer/worker.yaml +90 -0
- package/template/workers/dev-team/database-dev/package.json +22 -0
- package/template/workers/dev-team/database-dev/skills/create-schema.md +48 -0
- package/template/workers/dev-team/database-dev/src/index.ts +50 -0
- package/template/workers/dev-team/database-dev/src/mcp-server.ts +76 -0
- package/template/workers/dev-team/database-dev/tsconfig.json +18 -0
- package/template/workers/dev-team/database-dev/worker.yaml +90 -0
- package/template/workers/dev-team/frontend-dev/package.json +22 -0
- package/template/workers/dev-team/frontend-dev/skills/create-component.md +26 -0
- package/template/workers/dev-team/frontend-dev/src/index.ts +50 -0
- package/template/workers/dev-team/frontend-dev/src/mcp-server.ts +77 -0
- package/template/workers/dev-team/frontend-dev/tsconfig.json +18 -0
- package/template/workers/dev-team/frontend-dev/worker.yaml +132 -0
- package/template/workers/dev-team/infra-dev/package.json +24 -0
- package/template/workers/dev-team/infra-dev/skills/add-monitoring.md +73 -0
- package/template/workers/dev-team/infra-dev/skills/configure-deployment.md +80 -0
- package/template/workers/dev-team/infra-dev/skills/create-dockerfile.md +62 -0
- package/template/workers/dev-team/infra-dev/skills/setup-cicd.md +63 -0
- package/template/workers/dev-team/infra-dev/src/index.ts +55 -0
- package/template/workers/dev-team/infra-dev/src/mcp-server.ts +82 -0
- package/template/workers/dev-team/infra-dev/tsconfig.json +19 -0
- package/template/workers/dev-team/infra-dev/worker.yaml +92 -0
- package/template/workers/dev-team/knowledge-curator/package.json +24 -0
- package/template/workers/dev-team/knowledge-curator/skills/curate-troubleshooting.md +63 -0
- package/template/workers/dev-team/knowledge-curator/skills/process-learnings.md +61 -0
- package/template/workers/dev-team/knowledge-curator/skills/sync-documentation.md +76 -0
- package/template/workers/dev-team/knowledge-curator/skills/update-patterns.md +63 -0
- package/template/workers/dev-team/knowledge-curator/src/index.ts +53 -0
- package/template/workers/dev-team/knowledge-curator/src/mcp-server.ts +92 -0
- package/template/workers/dev-team/knowledge-curator/tsconfig.json +19 -0
- package/template/workers/dev-team/knowledge-curator/worker.yaml +80 -0
- package/template/workers/dev-team/motion-designer/package.json +22 -0
- package/template/workers/dev-team/motion-designer/skills/add-animation.md +25 -0
- package/template/workers/dev-team/motion-designer/skills/generate-image.md +36 -0
- package/template/workers/dev-team/motion-designer/src/index.ts +63 -0
- package/template/workers/dev-team/motion-designer/src/mcp-server.ts +79 -0
- package/template/workers/dev-team/motion-designer/tsconfig.json +18 -0
- package/template/workers/dev-team/motion-designer/worker.yaml +84 -0
- package/template/workers/dev-team/product-planner/queue.json +4 -0
- package/template/workers/dev-team/product-planner/worker.yaml +220 -0
- package/template/workers/dev-team/project-manager/package-lock.json +1252 -0
- package/template/workers/dev-team/project-manager/package.json +27 -0
- package/template/workers/dev-team/project-manager/skills/create-prd.md +66 -0
- package/template/workers/dev-team/project-manager/skills/next-issue.md +51 -0
- package/template/workers/dev-team/project-manager/skills/project-status.md +59 -0
- package/template/workers/dev-team/project-manager/skills/update-learnings.md +65 -0
- package/template/workers/dev-team/project-manager/src/index.ts +54 -0
- package/template/workers/dev-team/project-manager/src/mcp-server.ts +207 -0
- package/template/workers/dev-team/project-manager/src/skills/create-prd.ts +86 -0
- package/template/workers/dev-team/project-manager/src/skills/next-issue.ts +137 -0
- package/template/workers/dev-team/project-manager/src/skills/project-status.ts +131 -0
- package/template/workers/dev-team/project-manager/src/skills/update-learnings.ts +94 -0
- package/template/workers/dev-team/project-manager/tsconfig.json +19 -0
- package/template/workers/dev-team/project-manager/worker.yaml +96 -0
- package/template/workers/dev-team/qa-tester/package.json +24 -0
- package/template/workers/dev-team/qa-tester/skills/create-demo-account.md +36 -0
- package/template/workers/dev-team/qa-tester/skills/run-tests.md +36 -0
- package/template/workers/dev-team/qa-tester/skills/write-test.md +27 -0
- package/template/workers/dev-team/qa-tester/src/index.ts +61 -0
- package/template/workers/dev-team/qa-tester/src/mcp-server.ts +88 -0
- package/template/workers/dev-team/qa-tester/tsconfig.json +18 -0
- package/template/workers/dev-team/qa-tester/worker.yaml +116 -0
- package/template/workers/dev-team/task-executor/package-lock.json +1252 -0
- package/template/workers/dev-team/task-executor/package.json +27 -0
- package/template/workers/dev-team/task-executor/skills/analyze-issue.md +101 -0
- package/template/workers/dev-team/task-executor/skills/execute.md +133 -0
- package/template/workers/dev-team/task-executor/skills/report-learnings.md +106 -0
- package/template/workers/dev-team/task-executor/skills/validate-completion.md +121 -0
- package/template/workers/dev-team/task-executor/src/index.ts +54 -0
- package/template/workers/dev-team/task-executor/src/mcp-server.ts +139 -0
- package/template/workers/dev-team/task-executor/src/skills/analyze-issue.ts +219 -0
- package/template/workers/dev-team/task-executor/src/skills/execute.ts +132 -0
- package/template/workers/dev-team/task-executor/src/skills/report-learnings.ts +119 -0
- package/template/workers/dev-team/task-executor/src/skills/validate-completion.ts +142 -0
- package/template/workers/dev-team/task-executor/tsconfig.json +19 -0
- package/template/workers/dev-team/task-executor/worker.yaml +110 -0
- package/template/workers/registry.yaml +171 -0
- package/template/workers/security-scanner/README.md +73 -0
- package/template/workers/security-scanner/skills/pre-deploy-check.md +205 -0
- package/template/workers/security-scanner/worker.yaml +26 -0
- package/template/workspace/checkpoints/.gitkeep +0 -0
- package/template/workspace/content-ideas/inbox.jsonl +0 -0
- package/template/workspace/drafts/.gitkeep +0 -0
- package/template/workspace/learnings/.gitkeep +3 -0
- package/template/workspace/orchestrator/.gitkeep +0 -0
- package/template/workspace/ralph-test/COMPLETE.md +18 -0
- package/template/workspace/ralph-test/hello.txt +2 -0
- package/template/workspace/reports/.gitkeep +0 -0
- package/template/workspace/scratch/.gitkeep +0 -0
- package/template/workspace/threads/.gitkeep +3 -0
|
@@ -0,0 +1,368 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="docs/images/hq-banner.svg" alt="HQ - Your Personal Operating System" width="600">
|
|
3
|
+
</p>
|
|
4
|
+
|
|
5
|
+
<h1 align="center">HQ - Personal OS for AI Workers</h1>
|
|
6
|
+
|
|
7
|
+
<p align="center">
|
|
8
|
+
<strong>Build your AI team. Ship projects autonomously. Never lose context.</strong>
|
|
9
|
+
</p>
|
|
10
|
+
|
|
11
|
+
<p align="center">
|
|
12
|
+
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License: MIT"></a>
|
|
13
|
+
<a href="https://github.com/coreyepstein/hq-cli"><img src="https://img.shields.io/badge/CLI-hq--cli-green.svg" alt="HQ CLI"></a>
|
|
14
|
+
</p>
|
|
15
|
+
|
|
16
|
+
<p align="center">
|
|
17
|
+
<a href="#quick-start">Quick Start</a> •
|
|
18
|
+
<a href="#whats-new-in-v20">What's New</a> •
|
|
19
|
+
<a href="#core-concepts">Core Concepts</a> •
|
|
20
|
+
<a href="#commands">Commands</a> •
|
|
21
|
+
<a href="#workers">Workers</a>
|
|
22
|
+
</p>
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
## What is HQ?
|
|
27
|
+
|
|
28
|
+
HQ is infrastructure for orchestrating **AI workers** - autonomous agents that code, write content, research, and automate tasks.
|
|
29
|
+
|
|
30
|
+
Not just files. Active systems that:
|
|
31
|
+
- **Execute** - Workers do real work autonomously
|
|
32
|
+
- **Learn** - Knowledge bases grow smarter over time
|
|
33
|
+
- **Scale** - Add workers for new domains
|
|
34
|
+
- **Survive** - Checkpoints persist across sessions
|
|
35
|
+
|
|
36
|
+
```
|
|
37
|
+
┌─────────────────────────────────────────────────────────────────┐
|
|
38
|
+
│ YOUR HQ │
|
|
39
|
+
├─────────────────────────────────────────────────────────────────┤
|
|
40
|
+
│ │
|
|
41
|
+
│ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐ │
|
|
42
|
+
│ │ WORKERS │ │ KNOWLEDGE │ │ COMMANDS │ │
|
|
43
|
+
│ │ Do things │ │ Learn & │ │ Orchestrate │ │
|
|
44
|
+
│ │ autonomously│ │ remember │ │ workflows │ │
|
|
45
|
+
│ └─────────────┘ └─────────────┘ └─────────────┘ │
|
|
46
|
+
│ │ │ │ │
|
|
47
|
+
│ └──────────────────┼──────────────────┘ │
|
|
48
|
+
│ ▼ │
|
|
49
|
+
│ ┌─────────────┐ │
|
|
50
|
+
│ │ CHECKPOINTS │ │
|
|
51
|
+
│ │ Survive │ │
|
|
52
|
+
│ │ sessions │ │
|
|
53
|
+
│ └─────────────┘ │
|
|
54
|
+
│ │
|
|
55
|
+
└─────────────────────────────────────────────────────────────────┘
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## Quick Start
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
# 1. Clone
|
|
62
|
+
git clone https://github.com/coreyepstein/hq-starter-kit.git my-hq
|
|
63
|
+
cd my-hq
|
|
64
|
+
|
|
65
|
+
# 2. Open in Claude Code
|
|
66
|
+
claude
|
|
67
|
+
|
|
68
|
+
# 3. Run setup wizard
|
|
69
|
+
/setup
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
That's it. You now have a personal OS with 18 workers ready to deploy.
|
|
73
|
+
|
|
74
|
+
## What's New in v2.0
|
|
75
|
+
|
|
76
|
+
### Project Orchestration
|
|
77
|
+
Execute entire projects autonomously with the Ralph loop:
|
|
78
|
+
```bash
|
|
79
|
+
/prd "Build a dashboard" # Create PRD through discovery
|
|
80
|
+
/run-project my-dashboard # Execute all tasks via workers
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
### Content Pipeline
|
|
84
|
+
Full content workflow from idea to publish:
|
|
85
|
+
```bash
|
|
86
|
+
/contentidea "AI agents" # Build out idea → drafts
|
|
87
|
+
/suggestposts # Research-driven suggestions
|
|
88
|
+
/scheduleposts # Smart timing for posting
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
### Dev Team (13 Workers)
|
|
92
|
+
Complete development team for autonomous coding:
|
|
93
|
+
- `project-manager` - PRD lifecycle
|
|
94
|
+
- `task-executor` - Route tasks to workers
|
|
95
|
+
- `architect` - System design
|
|
96
|
+
- `backend-dev` / `frontend-dev` / `database-dev`
|
|
97
|
+
- `qa-tester` - Testing & validation
|
|
98
|
+
- `code-reviewer` - PR management
|
|
99
|
+
- And more...
|
|
100
|
+
|
|
101
|
+
### Auto-Checkpoint
|
|
102
|
+
Never lose work. Sessions auto-save to `workspace/threads/`.
|
|
103
|
+
|
|
104
|
+
### Design Iteration
|
|
105
|
+
A/B test designs with git branches:
|
|
106
|
+
```bash
|
|
107
|
+
/design-iterate hero-section # Create variations
|
|
108
|
+
# Review, compare, choose winner
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
---
|
|
112
|
+
|
|
113
|
+
## Core Concepts
|
|
114
|
+
|
|
115
|
+
### Workers
|
|
116
|
+
Autonomous agents with defined skills. They *do things*.
|
|
117
|
+
|
|
118
|
+
| Type | Purpose | Examples |
|
|
119
|
+
|------|---------|----------|
|
|
120
|
+
| **CodeWorker** | Implement features, fix bugs | frontend-dev, backend-dev |
|
|
121
|
+
| **ContentWorker** | Draft content, maintain voice | content-brand, content-sales |
|
|
122
|
+
| **SocialWorker** | Post to platforms | x-worker, linkedin-worker |
|
|
123
|
+
| **ResearchWorker** | Analyze data, markets | analyst, researcher |
|
|
124
|
+
| **OpsWorker** | Reports, automation | cfo-worker, cmo-worker |
|
|
125
|
+
|
|
126
|
+
### Knowledge Bases
|
|
127
|
+
Workers learn from and contribute to shared knowledge:
|
|
128
|
+
|
|
129
|
+
- `knowledge/Ralph/` - Autonomous coding methodology
|
|
130
|
+
- `knowledge/workers/` - Worker patterns & templates
|
|
131
|
+
- `knowledge/ai-security-framework/` - Security best practices
|
|
132
|
+
- `knowledge/dev-team/` - Development patterns
|
|
133
|
+
- `knowledge/design-styles/` - Design guidelines
|
|
134
|
+
|
|
135
|
+
### Commands
|
|
136
|
+
Slash commands orchestrate everything:
|
|
137
|
+
|
|
138
|
+
```bash
|
|
139
|
+
/run worker-name skill # Execute a worker skill
|
|
140
|
+
/checkpoint my-work # Save session state
|
|
141
|
+
/handoff # Prepare for fresh session
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
### Checkpoints
|
|
145
|
+
Work survives context limits:
|
|
146
|
+
|
|
147
|
+
```bash
|
|
148
|
+
/checkpoint feature-x # Save state
|
|
149
|
+
# ... context fills up ...
|
|
150
|
+
/nexttask # Finds checkpoint, continues work
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
---
|
|
154
|
+
|
|
155
|
+
## Commands
|
|
156
|
+
|
|
157
|
+
### Session Management
|
|
158
|
+
| Command | What it does |
|
|
159
|
+
|---------|--------------|
|
|
160
|
+
| `/checkpoint` | Save progress, survive context limits |
|
|
161
|
+
| `/handoff` | Prepare handoff for fresh session |
|
|
162
|
+
| `/reanchor` | Pause, show state, realign |
|
|
163
|
+
| `/nexttask` | Find next thing to work on |
|
|
164
|
+
|
|
165
|
+
### Workers
|
|
166
|
+
| Command | What it does |
|
|
167
|
+
|---------|--------------|
|
|
168
|
+
| `/run` | List all workers |
|
|
169
|
+
| `/run {worker}` | Show worker's skills |
|
|
170
|
+
| `/run {worker} {skill}` | Execute a skill |
|
|
171
|
+
| `/newworker` | Create a new worker |
|
|
172
|
+
| `/metrics` | View worker execution metrics |
|
|
173
|
+
|
|
174
|
+
### Projects
|
|
175
|
+
| Command | What it does |
|
|
176
|
+
|---------|--------------|
|
|
177
|
+
| `/prd` | Generate PRD through discovery |
|
|
178
|
+
| `/run-project` | Execute project via Ralph loop |
|
|
179
|
+
| `/pure-ralph` | External terminal loop (fully autonomous) |
|
|
180
|
+
| `/execute-task` | Run single task with workers |
|
|
181
|
+
|
|
182
|
+
### Content
|
|
183
|
+
| Command | What it does |
|
|
184
|
+
|---------|--------------|
|
|
185
|
+
| `/contentidea` | Build idea into full content suite |
|
|
186
|
+
| `/suggestposts` | Research-driven post suggestions |
|
|
187
|
+
| `/scheduleposts` | Choose what to post now |
|
|
188
|
+
|
|
189
|
+
### System
|
|
190
|
+
| Command | What it does |
|
|
191
|
+
|---------|--------------|
|
|
192
|
+
| `/search` | Full-text search across HQ |
|
|
193
|
+
| `/hq-sync` | Sync modules from manifest |
|
|
194
|
+
| `/cleanup` | Audit and clean HQ |
|
|
195
|
+
| `/design-iterate` | Manage design A/B tests |
|
|
196
|
+
|
|
197
|
+
---
|
|
198
|
+
|
|
199
|
+
## Workers
|
|
200
|
+
|
|
201
|
+
### Dev Team (13 workers)
|
|
202
|
+
Full development team for autonomous project execution:
|
|
203
|
+
|
|
204
|
+
```yaml
|
|
205
|
+
project-manager → PRD lifecycle, task selection
|
|
206
|
+
task-executor → Analyze & route to workers
|
|
207
|
+
architect → System design, API design
|
|
208
|
+
backend-dev → API endpoints, business logic
|
|
209
|
+
frontend-dev → React/Next components
|
|
210
|
+
database-dev → Schema, migrations
|
|
211
|
+
qa-tester → Testing, validation
|
|
212
|
+
motion-designer → Animations, polish
|
|
213
|
+
infra-dev → CI/CD, deployment
|
|
214
|
+
code-reviewer → PR review, quality gates
|
|
215
|
+
knowledge-curator → Update knowledge bases
|
|
216
|
+
product-planner → Technical specs
|
|
217
|
+
```
|
|
218
|
+
|
|
219
|
+
### Content Team (5 workers)
|
|
220
|
+
Specialized content analysis:
|
|
221
|
+
|
|
222
|
+
```yaml
|
|
223
|
+
content-brand → Voice, messaging, tone
|
|
224
|
+
content-sales → Conversion copy, CTAs
|
|
225
|
+
content-product → Technical accuracy
|
|
226
|
+
content-legal → Compliance, claims
|
|
227
|
+
content-shared → Shared utilities (library)
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
### Creating Your Own
|
|
231
|
+
|
|
232
|
+
```bash
|
|
233
|
+
/newworker # Interactive scaffold
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
Or manually create `workers/my-worker/worker.yaml`:
|
|
237
|
+
|
|
238
|
+
```yaml
|
|
239
|
+
worker:
|
|
240
|
+
id: my-worker
|
|
241
|
+
name: "My Worker"
|
|
242
|
+
type: OpsWorker
|
|
243
|
+
|
|
244
|
+
skills:
|
|
245
|
+
- name: do-thing
|
|
246
|
+
description: "Does the thing"
|
|
247
|
+
execution:
|
|
248
|
+
steps:
|
|
249
|
+
- "Step 1"
|
|
250
|
+
- "Step 2"
|
|
251
|
+
```
|
|
252
|
+
|
|
253
|
+
---
|
|
254
|
+
|
|
255
|
+
## Project Execution
|
|
256
|
+
|
|
257
|
+
HQ uses the **Ralph Methodology** for autonomous coding.
|
|
258
|
+
|
|
259
|
+
### The Loop
|
|
260
|
+
|
|
261
|
+
```
|
|
262
|
+
1. Pick task from PRD (passes: false)
|
|
263
|
+
2. Execute in fresh context
|
|
264
|
+
3. Run back pressure (tests, lint, typecheck)
|
|
265
|
+
4. If passing → commit, mark complete
|
|
266
|
+
5. Repeat until done
|
|
267
|
+
```
|
|
268
|
+
|
|
269
|
+
### Why It Works
|
|
270
|
+
|
|
271
|
+
- **Fresh context per task** - No accumulated confusion
|
|
272
|
+
- **Back pressure validates** - Code that doesn't pass isn't done
|
|
273
|
+
- **Atomic commits** - One task = one commit
|
|
274
|
+
- **PRD is truth** - Simple JSON, easy to inspect
|
|
275
|
+
|
|
276
|
+
### Running a Project
|
|
277
|
+
|
|
278
|
+
```bash
|
|
279
|
+
# 1. Create PRD
|
|
280
|
+
/prd "Build user authentication"
|
|
281
|
+
|
|
282
|
+
# 2. Execute via Ralph loop
|
|
283
|
+
/run-project auth-system
|
|
284
|
+
|
|
285
|
+
# 3. Monitor progress
|
|
286
|
+
/run-project auth-system --status
|
|
287
|
+
```
|
|
288
|
+
|
|
289
|
+
### Pure Ralph Mode
|
|
290
|
+
|
|
291
|
+
For fully autonomous execution, use `/pure-ralph` to spawn an external terminal that runs the loop independently:
|
|
292
|
+
|
|
293
|
+
```bash
|
|
294
|
+
# Auto mode (default) - fully autonomous, no intervention needed
|
|
295
|
+
/pure-ralph my-project
|
|
296
|
+
|
|
297
|
+
# Manual mode - see chain of thought, close windows between tasks
|
|
298
|
+
/pure-ralph my-project -m
|
|
299
|
+
```
|
|
300
|
+
|
|
301
|
+
**Why Pure Ralph?**
|
|
302
|
+
- **Fresh context every task** - Each task runs in a new Claude session, preventing context rot
|
|
303
|
+
- **External orchestrator** - Loop runs outside Claude, immune to context compression
|
|
304
|
+
- **Self-improving** - Claude can update its own prompt as it learns
|
|
305
|
+
- **Watchable** - See progress in a visible terminal window
|
|
306
|
+
|
|
307
|
+
---
|
|
308
|
+
|
|
309
|
+
## Directory Structure
|
|
310
|
+
|
|
311
|
+
```
|
|
312
|
+
my-hq/
|
|
313
|
+
├── .claude/
|
|
314
|
+
│ ├── CLAUDE.md # Session protocol
|
|
315
|
+
│ └── commands/ # 22 slash commands
|
|
316
|
+
├── knowledge/
|
|
317
|
+
│ ├── Ralph/ # Coding methodology
|
|
318
|
+
│ ├── workers/ # Worker framework + templates
|
|
319
|
+
│ ├── ai-security-framework/ # Security practices
|
|
320
|
+
│ ├── dev-team/ # Development patterns
|
|
321
|
+
│ ├── design-styles/ # Design guidelines
|
|
322
|
+
│ └── loom/ # Agent patterns
|
|
323
|
+
├── workers/
|
|
324
|
+
│ ├── registry.yaml # Worker index
|
|
325
|
+
│ ├── dev-team/ # 13 dev workers
|
|
326
|
+
│ └── content-*/ # Content workers
|
|
327
|
+
├── projects/ # Your PRDs
|
|
328
|
+
├── social-content/
|
|
329
|
+
│ └── drafts/ # Content drafts (x/, linkedin/)
|
|
330
|
+
├── workspace/
|
|
331
|
+
│ ├── checkpoints/ # Manual saves
|
|
332
|
+
│ ├── threads/ # Auto-saved sessions
|
|
333
|
+
│ ├── orchestrator/ # Project state
|
|
334
|
+
│ └── learnings/ # Captured insights
|
|
335
|
+
└── companies/ # Multi-company setup
|
|
336
|
+
```
|
|
337
|
+
|
|
338
|
+
---
|
|
339
|
+
|
|
340
|
+
## Part of the HQ Framework
|
|
341
|
+
|
|
342
|
+
| Component | Purpose |
|
|
343
|
+
|-----------|---------|
|
|
344
|
+
| **hq-starter-kit** | This repo - personal OS template |
|
|
345
|
+
| **[hq-cli](https://github.com/coreyepstein/hq-cli)** | Module management CLI |
|
|
346
|
+
|
|
347
|
+
---
|
|
348
|
+
|
|
349
|
+
## Customization
|
|
350
|
+
|
|
351
|
+
This is a **template**. Make it yours:
|
|
352
|
+
|
|
353
|
+
- Add workers for your workflows
|
|
354
|
+
- Build knowledge bases for your domains
|
|
355
|
+
- Create commands for your patterns
|
|
356
|
+
- Connect tools via MCP
|
|
357
|
+
|
|
358
|
+
---
|
|
359
|
+
|
|
360
|
+
## Credits
|
|
361
|
+
|
|
362
|
+
- **Ralph Methodology** by [Geoffrey Huntley](https://ghuntley.com/ralph/)
|
|
363
|
+
- **Loom Agent Architecture** by [Geoffrey Huntley](https://github.com/ghuntley/loom) - Thread system, state machine, and agent patterns
|
|
364
|
+
- Inspired by personal knowledge systems and AI workflow patterns
|
|
365
|
+
|
|
366
|
+
## License
|
|
367
|
+
|
|
368
|
+
MIT - Do whatever you want with it.
|
|
File without changes
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
# ASCII Banner Options for HQ Starter Kit
|
|
2
|
+
|
|
3
|
+
## Option 1: Command Center
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
╔═══════════════════════════════════════════════════════════╗
|
|
7
|
+
║ ║
|
|
8
|
+
██╗ ██╗ ██████╗ ║ WORKERS ────────┬─────── KNOWLEDGE ────────┬───────── ║
|
|
9
|
+
██║ ██║██╔═══██╗║ │ │ │ │ ║
|
|
10
|
+
███████║██║ ██║║ ▼ ▼ ▼ ▼ ║
|
|
11
|
+
██╔══██║██║▄▄ ██║║ [CODE] [CONTENT] [RALPH] [SECURITY] ║
|
|
12
|
+
██║ ██║╚██████╔╝║ │ │ │ │ ║
|
|
13
|
+
╚═╝ ╚═╝ ╚══▀▀═╝ ║ └────────────┴────────────┴──────────────┘ ║
|
|
14
|
+
║ │ ║
|
|
15
|
+
║ ORCHESTRATE ║
|
|
16
|
+
║ │ ║
|
|
17
|
+
║ ┌──────────┴──────────┐ ║
|
|
18
|
+
║ ▼ ▼ ║
|
|
19
|
+
║ /run-project /checkpoint ║
|
|
20
|
+
╚═══════════════════════════════════════════════════════════╝
|
|
21
|
+
Personal OS for AI Workers
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Option 2: Clean System Flow
|
|
25
|
+
|
|
26
|
+
```
|
|
27
|
+
┌─────────────────────────────────────────────────────────────────────────────────┐
|
|
28
|
+
│ │
|
|
29
|
+
│ ██╗ ██╗ ██████╗ ───────────────────────────────────────────────── │
|
|
30
|
+
│ ██║ ██║██╔═══██╗ P E R S O N A L O S F O R A I W O R K E R S │
|
|
31
|
+
│ ███████║██║ ██║ ───────────────────────────────────────────────── │
|
|
32
|
+
│ ██╔══██║██║▄▄ ██║ │
|
|
33
|
+
│ ██║ ██║╚██████╔╝ ┌────────────────────┐ │
|
|
34
|
+
│ ╚═╝ ╚═╝ ╚══▀▀═╝ │ YOU │ │
|
|
35
|
+
│ └─────────┬──────────┘ │
|
|
36
|
+
│ │ │
|
|
37
|
+
│ ┌───────────────────────────────────┼───────────────────────────────┐ │
|
|
38
|
+
│ │ │ │ │
|
|
39
|
+
│ ▼ ▼ ▼ │
|
|
40
|
+
│ ┌──────────┐ ┌──────────┐ ┌──────────┐
|
|
41
|
+
│ │ WORKERS │ │ PROJECTS │ │KNOWLEDGE │
|
|
42
|
+
│ │ 18 AI │◄──── orchestrate ─────►│ PRDs │◄───── learn ─────►│ Ralph │
|
|
43
|
+
│ │ agents │ │ Tasks │ │ Bases │
|
|
44
|
+
│ └──────────┘ └──────────┘ └──────────┘
|
|
45
|
+
│ │ │ │ │
|
|
46
|
+
│ └───────────────────────────────────┼───────────────────────────────┘ │
|
|
47
|
+
│ │ │
|
|
48
|
+
│ ┌─────────┴─────────┐ │
|
|
49
|
+
│ │ CHECKPOINTS │ │
|
|
50
|
+
│ │ Never lose work │ │
|
|
51
|
+
│ └───────────────────┘ │
|
|
52
|
+
│ │
|
|
53
|
+
└─────────────────────────────────────────────────────────────────────────────────┘
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
## Option 3: Minimal Bold
|
|
57
|
+
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
██╗ ██╗ ██████╗ ███████╗████████╗ █████╗ ██████╗ ████████╗███████╗██████╗
|
|
61
|
+
██║ ██║██╔═══██╗ ██╔════╝╚══██╔══╝██╔══██╗██╔══██╗╚══██╔══╝██╔════╝██╔══██╗
|
|
62
|
+
███████║██║ ██║ ███████╗ ██║ ███████║██████╔╝ ██║ █████╗ ██████╔╝
|
|
63
|
+
██╔══██║██║▄▄ ██║ ╚════██║ ██║ ██╔══██║██╔══██╗ ██║ ██╔══╝ ██╔══██╗
|
|
64
|
+
██║ ██║╚██████╔╝ ███████║ ██║ ██║ ██║██║ ██║ ██║ ███████╗██║ ██║
|
|
65
|
+
╚═╝ ╚═╝ ╚══▀▀═╝ ╚══════╝ ╚═╝ ╚═╝ ╚═╝╚═╝ ╚═╝ ╚═╝ ╚══════╝╚═╝ ╚═╝
|
|
66
|
+
|
|
67
|
+
╦╔═╦╔╦╗
|
|
68
|
+
╠╩╗║ ║ Build your AI team. Ship projects autonomously. Never lose context.
|
|
69
|
+
╩ ╩╩ ╩
|
|
70
|
+
|
|
71
|
+
[WORKERS]────────[KNOWLEDGE]────────[COMMANDS]────────[CHECKPOINTS]
|
|
72
|
+
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
## Option 4: Retro Terminal
|
|
76
|
+
|
|
77
|
+
```
|
|
78
|
+
╔════════════════════════════════════════════════════════════════════════════════════╗
|
|
79
|
+
║ ┌──────────────────────────────────────────────────────────────────────────────┐ ║
|
|
80
|
+
║ │ █ HQ STARTER KIT v2.0 [_][□][X] │ ║
|
|
81
|
+
║ ├──────────────────────────────────────────────────────────────────────────────┤ ║
|
|
82
|
+
║ │ │ ║
|
|
83
|
+
║ │ > SYSTEM ONLINE │ ║
|
|
84
|
+
║ │ > LOADING MODULES... │ ║
|
|
85
|
+
║ │ │ ║
|
|
86
|
+
║ │ ╦ ╦╔═╗ ┌─────────────────────────────────────────────────────────────┐ │ ║
|
|
87
|
+
║ │ ╠═╣║═╬╗ │ WORKERS: 18 active │ KNOWLEDGE: 5 bases │ │ ║
|
|
88
|
+
║ │ ╩ ╩╚═╝╚ │ COMMANDS: 22 loaded │ CHECKPOINTS: ready │ │ ║
|
|
89
|
+
║ │ └─────────────────────────────────────────────────────────────┘ │ ║
|
|
90
|
+
║ │ │ ║
|
|
91
|
+
║ │ > Personal OS for AI Workers │ ║
|
|
92
|
+
║ │ > Type /setup to begin │ ║
|
|
93
|
+
║ │ │ ║
|
|
94
|
+
║ │ $ _ │ ║
|
|
95
|
+
║ │ │ ║
|
|
96
|
+
║ └──────────────────────────────────────────────────────────────────────────────┘ ║
|
|
97
|
+
╚════════════════════════════════════════════════════════════════════════════════════╝
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
## Option 5: Circuit Board
|
|
101
|
+
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
●━━━━━━━━━━━━━━━━━━━━━━━━━━━━●━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━●━━━━━━━━━━━━━━━●
|
|
105
|
+
┃ ┃ ┃ ┃
|
|
106
|
+
┃ ██╗ ██╗ ██████╗ ┃ ┏━━━━━━━━━━━━━━━━━━━━━┓ ┃ ┃
|
|
107
|
+
┃ ██║ ██║██╔═══██╗ ┃ ┃ STARTER KIT v2.0 ┃ ┃ ┃
|
|
108
|
+
┃ ███████║██║ ██║━━━━━━━━┫ ┗━━━━━━━━━┳━━━━━━━━━━━┛ ┃ ┃
|
|
109
|
+
┃ ██╔══██║██║▄▄ ██║ ┃ ┃ ┃ ┃
|
|
110
|
+
┃ ██║ ██║╚██████╔╝ ┃ ━━━━━━━━━━╋━━━━━━━━━━━━ ┃ ┃
|
|
111
|
+
┃ ╚═╝ ╚═╝ ╚══▀▀═╝ ┃ ┃ ┃ ┃
|
|
112
|
+
┃ ┃ ┃ ┃ ┃
|
|
113
|
+
●━━━━┳━━━━━━━━━━━━━━━━━━━━━━━●━━━━━━━━━━━━━━╋━━━━━━━━━━━━━━━━●━━━━━━━━┳━━━━━●
|
|
114
|
+
┃ ┃ ┃
|
|
115
|
+
┃ ┌─────────┐ ┌─────────┐ ┌───────┴───────┐ ┌─────────┐ ┃
|
|
116
|
+
┗━━━━┥ WORKERS ├──┤KNOWLEDGE├──┤ COMMANDS ├──┤CHECKPTS ├━━━┛
|
|
117
|
+
└─────────┘ └─────────┘ └───────────────┘ └─────────┘
|
|
118
|
+
|
|
119
|
+
Personal OS for AI Workers ━━ Build your team. Ship autonomously.
|
|
120
|
+
|
|
121
|
+
```
|
|
122
|
+
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
<svg width="900" height="320" viewBox="0 0 900 320" xmlns="http://www.w3.org/2000/svg">
|
|
2
|
+
<defs>
|
|
3
|
+
<style>
|
|
4
|
+
@import url('https://fonts.googleapis.com/css2?family=Inter:wght@400;700;900&family=JetBrains+Mono:wght@400;500&display=swap');
|
|
5
|
+
.title { font-family: 'Inter', system-ui, sans-serif; font-weight: 900; }
|
|
6
|
+
.subtitle { font-family: 'Inter', system-ui, sans-serif; font-weight: 700; }
|
|
7
|
+
.body { font-family: 'Inter', system-ui, sans-serif; font-weight: 400; }
|
|
8
|
+
.mono { font-family: 'JetBrains Mono', monospace; font-weight: 500; }
|
|
9
|
+
</style>
|
|
10
|
+
</defs>
|
|
11
|
+
|
|
12
|
+
<!-- Background -->
|
|
13
|
+
<rect width="900" height="320" fill="#0A0A0A"/>
|
|
14
|
+
|
|
15
|
+
<!-- Corner Brackets -->
|
|
16
|
+
<g stroke="#F0F0F0" stroke-width="2" fill="none">
|
|
17
|
+
<!-- Top Left -->
|
|
18
|
+
<path d="M 30 30 L 30 60" />
|
|
19
|
+
<path d="M 30 30 L 60 30" />
|
|
20
|
+
<!-- Top Right -->
|
|
21
|
+
<path d="M 870 30 L 870 60" />
|
|
22
|
+
<path d="M 870 30 L 840 30" />
|
|
23
|
+
<!-- Bottom Left -->
|
|
24
|
+
<path d="M 30 290 L 30 260" />
|
|
25
|
+
<path d="M 30 290 L 60 290" />
|
|
26
|
+
<!-- Bottom Right -->
|
|
27
|
+
<path d="M 870 290 L 870 260" />
|
|
28
|
+
<path d="M 870 290 L 840 290" />
|
|
29
|
+
</g>
|
|
30
|
+
|
|
31
|
+
<!-- Orbital Glyph - Node Network -->
|
|
32
|
+
<g transform="translate(160, 160)">
|
|
33
|
+
<!-- Outer orbit -->
|
|
34
|
+
<ellipse cx="0" cy="0" rx="90" ry="50" fill="none" stroke="#333333" stroke-width="1" transform="rotate(-20)"/>
|
|
35
|
+
<!-- Middle orbit -->
|
|
36
|
+
<ellipse cx="0" cy="0" rx="70" ry="35" fill="none" stroke="#444444" stroke-width="1" transform="rotate(25)"/>
|
|
37
|
+
<!-- Inner orbit -->
|
|
38
|
+
<circle cx="0" cy="0" r="40" fill="none" stroke="#555555" stroke-width="1" stroke-dasharray="4 4"/>
|
|
39
|
+
|
|
40
|
+
<!-- Crosshair -->
|
|
41
|
+
<line x1="-100" y1="0" x2="100" y2="0" stroke="#333333" stroke-width="1"/>
|
|
42
|
+
<line x1="0" y1="-70" x2="0" y2="70" stroke="#333333" stroke-width="1"/>
|
|
43
|
+
|
|
44
|
+
<!-- Central node -->
|
|
45
|
+
<circle cx="0" cy="0" r="8" fill="#F0F0F0"/>
|
|
46
|
+
|
|
47
|
+
<!-- Orbiting nodes (workers) -->
|
|
48
|
+
<circle cx="65" cy="-30" r="5" fill="#F0F0F0"/>
|
|
49
|
+
<circle cx="-70" cy="20" r="5" fill="#F0F0F0"/>
|
|
50
|
+
<circle cx="20" cy="45" r="5" fill="#F0F0F0"/>
|
|
51
|
+
<circle cx="-40" cy="-40" r="5" fill="#666666"/>
|
|
52
|
+
<circle cx="50" cy="35" r="4" fill="#666666"/>
|
|
53
|
+
|
|
54
|
+
<!-- Connection lines -->
|
|
55
|
+
<line x1="0" y1="0" x2="65" y2="-30" stroke="#F0F0F0" stroke-width="1" opacity="0.5"/>
|
|
56
|
+
<line x1="0" y1="0" x2="-70" y2="20" stroke="#F0F0F0" stroke-width="1" opacity="0.5"/>
|
|
57
|
+
<line x1="0" y1="0" x2="20" y2="45" stroke="#F0F0F0" stroke-width="1" opacity="0.5"/>
|
|
58
|
+
</g>
|
|
59
|
+
|
|
60
|
+
<!-- Title Block -->
|
|
61
|
+
<g transform="translate(320, 100)">
|
|
62
|
+
<!-- HQ -->
|
|
63
|
+
<text x="0" y="0" class="title" fill="#F0F0F0" font-size="72" letter-spacing="-2">HQ</text>
|
|
64
|
+
<!-- Registered symbol -->
|
|
65
|
+
<circle cx="155" cy="-45" r="14" fill="none" stroke="#F0F0F0" stroke-width="2"/>
|
|
66
|
+
<text x="155" y="-38" class="body" fill="#F0F0F0" font-size="18" text-anchor="middle">R</text>
|
|
67
|
+
|
|
68
|
+
<!-- STARTER KIT -->
|
|
69
|
+
<text x="0" y="35" class="subtitle" fill="#F0F0F0" font-size="28" letter-spacing="8">STARTER KIT</text>
|
|
70
|
+
|
|
71
|
+
<!-- Divider line -->
|
|
72
|
+
<line x1="0" y1="55" x2="280" y2="55" stroke="#333333" stroke-width="2"/>
|
|
73
|
+
|
|
74
|
+
<!-- Tagline -->
|
|
75
|
+
<text x="0" y="85" class="body" fill="#666666" font-size="14" letter-spacing="2">PERSONAL OS FOR AI WORKERS</text>
|
|
76
|
+
</g>
|
|
77
|
+
|
|
78
|
+
<!-- Status Bar -->
|
|
79
|
+
<g transform="translate(320, 240)">
|
|
80
|
+
<text class="mono" fill="#666666" font-size="12" letter-spacing="1">
|
|
81
|
+
<tspan x="0">STATUS</tspan>
|
|
82
|
+
<tspan x="55" fill="#F0F0F0">DEPLOYED</tspan>
|
|
83
|
+
<tspan x="150" fill="#333333">/</tspan>
|
|
84
|
+
<tspan x="170">WORKERS</tspan>
|
|
85
|
+
<tspan x="245" fill="#F0F0F0">18</tspan>
|
|
86
|
+
<tspan x="280" fill="#333333">/</tspan>
|
|
87
|
+
<tspan x="300">COMMANDS</tspan>
|
|
88
|
+
<tspan x="395" fill="#F0F0F0">22</tspan>
|
|
89
|
+
<tspan x="430" fill="#333333">/</tspan>
|
|
90
|
+
<tspan x="450">KNOWLEDGE</tspan>
|
|
91
|
+
<tspan x="555" fill="#F0F0F0">5</tspan>
|
|
92
|
+
</text>
|
|
93
|
+
</g>
|
|
94
|
+
|
|
95
|
+
<!-- Unit ID (bottom right) -->
|
|
96
|
+
<text x="830" y="280" class="mono" fill="#333333" font-size="10" text-anchor="end" letter-spacing="1">HQ-SK-V2.0</text>
|
|
97
|
+
|
|
98
|
+
<!-- Small decorative elements -->
|
|
99
|
+
<!-- Top status indicator -->
|
|
100
|
+
<g transform="translate(750, 50)">
|
|
101
|
+
<circle cx="0" cy="0" r="4" fill="#F0F0F0"/>
|
|
102
|
+
<text x="12" y="4" class="mono" fill="#666666" font-size="10" letter-spacing="1">ACTIVE</text>
|
|
103
|
+
</g>
|
|
104
|
+
|
|
105
|
+
</svg>
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
# Overview: What is Ralph?
|
|
2
|
+
|
|
3
|
+
## Definition
|
|
4
|
+
|
|
5
|
+
**Ralph** (formally known as the "Ralph Wiggum Loop") is an orchestrator pattern for autonomous AI coding that manages the context window in a way that avoids compaction and context rot. It's a methodology for running AI coding agents that allows you to ship working code while you sleep.
|
|
6
|
+
|
|
7
|
+
> "Ralph is really just a mallocing orchestrator that avoids context rot and compaction."
|
|
8
|
+
> — Geoffrey Huntley
|
|
9
|
+
|
|
10
|
+
## The Core Insight
|
|
11
|
+
|
|
12
|
+
The breakthrough of Ralph is its simplicity. While the AI industry has been building increasingly complex agent swarms, meshes, and orchestrators, Ralph achieves better results with just a **for loop**.
|
|
13
|
+
|
|
14
|
+
> "What if I told you that the way to get this to work is with a for loop?"
|
|
15
|
+
> — Matt Pocock
|
|
16
|
+
|
|
17
|
+
## Why "Ralph Wiggum"?
|
|
18
|
+
|
|
19
|
+
The name comes from the Simpsons character Ralph Wiggum, known for his comedic simplicity and the famous "I'm in danger!" meme. The name reflects the approach's deceptive simplicity - it looks almost too simple to work, but it does.
|
|
20
|
+
|
|
21
|
+
## The Problem Ralph Solves
|
|
22
|
+
|
|
23
|
+
Traditional AI coding approaches suffer from:
|
|
24
|
+
|
|
25
|
+
1. **Context Rot** - As conversations grow longer, the AI loses track of earlier context
|
|
26
|
+
2. **Compaction** - The context window gets filled with irrelevant information
|
|
27
|
+
3. **Complexity** - Orchestrators and agent swarms add layers of abstraction that introduce failure points
|
|
28
|
+
4. **Human Dependencies** - Many workflows require human intervention, breaking the autonomous loop
|
|
29
|
+
|
|
30
|
+
Ralph solves these by:
|
|
31
|
+
- Starting fresh for each task (avoiding context rot)
|
|
32
|
+
- Using specifications to focus the context (avoiding compaction)
|
|
33
|
+
- Using a simple loop instead of complex orchestration
|
|
34
|
+
- Removing humans from the loop entirely
|
|
35
|
+
|
|
36
|
+
## The Vision
|
|
37
|
+
|
|
38
|
+
> "One of the dreams of coding agents is that you can wake up in the morning to working code that your coding agent has worked through your backlog and has just spit out a whole bunch of code for you to review and it works."
|
|
39
|
+
> — Matt Pocock
|
|
40
|
+
|
|
41
|
+
Ralph makes this dream a reality by mimicking how real engineers work:
|
|
42
|
+
1. Pick a task
|
|
43
|
+
2. Complete it
|
|
44
|
+
3. Commit it
|
|
45
|
+
4. Repeat
|
|
46
|
+
|
|
47
|
+
## Economic Impact
|
|
48
|
+
|
|
49
|
+
Ralph fundamentally changes the economics of software development:
|
|
50
|
+
|
|
51
|
+
> "Software development now costs $10.42 US an hour. It's less than you would pay a fast food retail worker. It's cheap. And not only is it cheap, you can do it autonomously."
|
|
52
|
+
> — Geoffrey Huntley
|
|
53
|
+
|
|
54
|
+
> "The new world is you run a Ralph loop and then you chill on a beach in Bali."
|
|
55
|
+
> — Geoffrey Huntley
|
|
56
|
+
|
|
57
|
+
## Key Differentiator
|
|
58
|
+
|
|
59
|
+
Ralph works in **both directions**:
|
|
60
|
+
|
|
61
|
+
1. **Forward** - Build software from specifications
|
|
62
|
+
2. **Reverse** - Generate clean room specifications from existing code
|
|
63
|
+
|
|
64
|
+
> "A lot of people right now are missing the point that Ralph goes forward, meaning you can use it to build software. No, run Ralph in reverse to create a clean room specification."
|
|
65
|
+
> — Geoffrey Huntley
|
|
66
|
+
|
|
67
|
+
This bidirectional capability enables:
|
|
68
|
+
- New product development (forward)
|
|
69
|
+
- Product cloning/clean room design (reverse)
|
|
70
|
+
- Documentation generation (reverse)
|
|
71
|
+
- Specification refinement (iterative)
|