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,139 @@
|
|
|
1
|
+
# Contributing to the AI Security Framework
|
|
2
|
+
|
|
3
|
+
> Help make AI automation safer for everyone
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Why Contribute
|
|
8
|
+
|
|
9
|
+
The AI agent security landscape evolves weekly. New attack vectors are discovered, new mitigations are developed, and new tools emerge. No single person or team can keep up alone. This framework improves through community contributions.
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## What We Need
|
|
14
|
+
|
|
15
|
+
### High Priority
|
|
16
|
+
|
|
17
|
+
1. **Real-world incident reports** (anonymized)
|
|
18
|
+
- What happened?
|
|
19
|
+
- How was it detected?
|
|
20
|
+
- What was the resolution?
|
|
21
|
+
|
|
22
|
+
2. **New attack vectors**
|
|
23
|
+
- Prompt injection techniques
|
|
24
|
+
- Credential extraction methods
|
|
25
|
+
- Session hijacking patterns
|
|
26
|
+
|
|
27
|
+
3. **Better mitigations**
|
|
28
|
+
- Configurations that work
|
|
29
|
+
- Tools and scripts
|
|
30
|
+
- Monitoring approaches
|
|
31
|
+
|
|
32
|
+
4. **Tool-specific guidance**
|
|
33
|
+
- Claude in Chrome hardening
|
|
34
|
+
- Other browser agents
|
|
35
|
+
- CLI-based agents
|
|
36
|
+
|
|
37
|
+
### Always Welcome
|
|
38
|
+
|
|
39
|
+
- Typo fixes and clarifications
|
|
40
|
+
- Additional checklist items
|
|
41
|
+
- Better explanations
|
|
42
|
+
- Example configurations
|
|
43
|
+
- Translation to other languages
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
## Contribution Process
|
|
48
|
+
|
|
49
|
+
### For Small Changes (typos, clarifications)
|
|
50
|
+
|
|
51
|
+
1. Fork the repository
|
|
52
|
+
2. Make your change
|
|
53
|
+
3. Submit a pull request with clear description
|
|
54
|
+
|
|
55
|
+
### For New Content
|
|
56
|
+
|
|
57
|
+
1. Open an issue first to discuss
|
|
58
|
+
2. Get feedback on approach
|
|
59
|
+
3. Fork and create your content
|
|
60
|
+
4. Submit PR with:
|
|
61
|
+
- Clear description of addition
|
|
62
|
+
- Why it's valuable
|
|
63
|
+
- Any caveats or limitations
|
|
64
|
+
|
|
65
|
+
### For Security Vulnerabilities
|
|
66
|
+
|
|
67
|
+
If you've found a security issue with this framework itself:
|
|
68
|
+
|
|
69
|
+
1. **Do not** open a public issue
|
|
70
|
+
2. Email: [security contact]
|
|
71
|
+
3. Include:
|
|
72
|
+
- Description of vulnerability
|
|
73
|
+
- Steps to reproduce
|
|
74
|
+
- Potential impact
|
|
75
|
+
- Suggested fix (if any)
|
|
76
|
+
|
|
77
|
+
---
|
|
78
|
+
|
|
79
|
+
## Content Guidelines
|
|
80
|
+
|
|
81
|
+
### Tone
|
|
82
|
+
|
|
83
|
+
- Practical over theoretical
|
|
84
|
+
- Actionable over abstract
|
|
85
|
+
- Clear over clever
|
|
86
|
+
- Honest about limitations
|
|
87
|
+
|
|
88
|
+
### Format
|
|
89
|
+
|
|
90
|
+
- Follow existing document structure
|
|
91
|
+
- Use consistent heading levels
|
|
92
|
+
- Include both explanation AND actionable steps
|
|
93
|
+
- Provide examples where helpful
|
|
94
|
+
|
|
95
|
+
### Quality Bar
|
|
96
|
+
|
|
97
|
+
Before submitting, verify:
|
|
98
|
+
|
|
99
|
+
- [ ] Content is accurate (cite sources for claims)
|
|
100
|
+
- [ ] Examples actually work
|
|
101
|
+
- [ ] No sensitive information included
|
|
102
|
+
- [ ] Consistent with existing framework philosophy
|
|
103
|
+
- [ ] Adds clear value for users
|
|
104
|
+
|
|
105
|
+
---
|
|
106
|
+
|
|
107
|
+
## What We Don't Accept
|
|
108
|
+
|
|
109
|
+
- Promotional content for specific products
|
|
110
|
+
- Unverified security claims
|
|
111
|
+
- Content that could enable attacks
|
|
112
|
+
- Low-effort "me too" additions
|
|
113
|
+
- Content that contradicts core principles without strong justification
|
|
114
|
+
|
|
115
|
+
---
|
|
116
|
+
|
|
117
|
+
## Recognition
|
|
118
|
+
|
|
119
|
+
Contributors will be:
|
|
120
|
+
|
|
121
|
+
- Listed in CONTRIBUTORS.md (if desired)
|
|
122
|
+
- Credited in relevant documents
|
|
123
|
+
- Thanked publicly (if comfortable)
|
|
124
|
+
|
|
125
|
+
---
|
|
126
|
+
|
|
127
|
+
## Questions
|
|
128
|
+
|
|
129
|
+
Open an issue with the "question" label, or reach out to maintainers directly.
|
|
130
|
+
|
|
131
|
+
---
|
|
132
|
+
|
|
133
|
+
## License
|
|
134
|
+
|
|
135
|
+
By contributing, you agree that your contributions will be licensed under the same MIT license as the project.
|
|
136
|
+
|
|
137
|
+
---
|
|
138
|
+
|
|
139
|
+
*Thank you for helping make AI automation safer.*
|
|
@@ -0,0 +1,176 @@
|
|
|
1
|
+
# Glossary
|
|
2
|
+
|
|
3
|
+
> Key terms used in this security framework
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## A
|
|
8
|
+
|
|
9
|
+
### AI Agent
|
|
10
|
+
An AI system that can take autonomous actions in the world—browsing websites, sending emails, writing code, etc. Unlike a chatbot that only responds, agents act on your behalf.
|
|
11
|
+
|
|
12
|
+
### Allowlist
|
|
13
|
+
A list of explicitly permitted resources (sites, APIs, actions). Everything NOT on the list is blocked by default. More secure than blocklist approach.
|
|
14
|
+
|
|
15
|
+
### Audit Log
|
|
16
|
+
A chronological record of all actions taken by an AI agent, including what was done, when, and the outcome. Essential for security review and incident investigation.
|
|
17
|
+
|
|
18
|
+
### Autonomy Level
|
|
19
|
+
The degree of independence granted to an AI agent for a particular type of action. Ranges from "full autonomy" (no human approval needed) to "never allowed" (agent cannot perform).
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
## B
|
|
24
|
+
|
|
25
|
+
### Back Pressure
|
|
26
|
+
In the Ralph methodology, the checks that prevent bad work from accumulating. For security, this includes permission checks, approval gates, and validation before actions execute.
|
|
27
|
+
|
|
28
|
+
### Blast Radius
|
|
29
|
+
The maximum potential damage if something goes wrong with a particular action or capability. A key concept for determining what level of autonomy to grant.
|
|
30
|
+
|
|
31
|
+
### Blocklist
|
|
32
|
+
A list of explicitly prohibited resources. Everything NOT on the list is allowed. Less secure than allowlist approach because new threats aren't automatically blocked.
|
|
33
|
+
|
|
34
|
+
### Bounded Autonomy
|
|
35
|
+
The principle of giving AI freedom to operate within carefully defined limits. AI can act independently within boundaries but cannot exceed them.
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
## C
|
|
40
|
+
|
|
41
|
+
### Circuit Breaker
|
|
42
|
+
An automated mechanism that stops AI agent activity when certain thresholds are exceeded (error rate, spending, unusual patterns). Like an electrical circuit breaker that trips to prevent damage.
|
|
43
|
+
|
|
44
|
+
### Context Isolation
|
|
45
|
+
From the Ralph methodology: starting each AI task with fresh context, without accumulated data from previous tasks. A security feature that prevents sensitive data leakage between operations.
|
|
46
|
+
|
|
47
|
+
### Credential Broker
|
|
48
|
+
An architecture pattern where AI agents don't have direct credential access. Instead, they request access through a broker (human or automated) that provides time-limited, scoped tokens.
|
|
49
|
+
|
|
50
|
+
---
|
|
51
|
+
|
|
52
|
+
## D
|
|
53
|
+
|
|
54
|
+
### Defense in Depth
|
|
55
|
+
Layering multiple security controls so that failure of any single control doesn't result in complete compromise. Each layer provides protection if other layers fail.
|
|
56
|
+
|
|
57
|
+
---
|
|
58
|
+
|
|
59
|
+
## F
|
|
60
|
+
|
|
61
|
+
### Fail-Secure
|
|
62
|
+
When a security control fails, the system becomes MORE restrictive, not less. Example: if the approval system fails, actions are blocked rather than auto-approved.
|
|
63
|
+
|
|
64
|
+
### Fresh Context
|
|
65
|
+
Starting an AI operation without carrying over context from previous operations. Prevents accumulated sensitive data and reduces attack surface.
|
|
66
|
+
|
|
67
|
+
---
|
|
68
|
+
|
|
69
|
+
## G
|
|
70
|
+
|
|
71
|
+
### GREEN Zone
|
|
72
|
+
In this framework: actions that AI can take autonomously without human approval. Low blast radius, easily reversible.
|
|
73
|
+
|
|
74
|
+
---
|
|
75
|
+
|
|
76
|
+
## K
|
|
77
|
+
|
|
78
|
+
### Kill Switch
|
|
79
|
+
An emergency mechanism to immediately stop all AI agent activity. Should be accessible in under 60 seconds and tested regularly.
|
|
80
|
+
|
|
81
|
+
---
|
|
82
|
+
|
|
83
|
+
## L
|
|
84
|
+
|
|
85
|
+
### Least Privilege
|
|
86
|
+
The security principle of giving an entity (user, AI, system) only the minimum access needed to perform its specific task—no more.
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
90
|
+
## M
|
|
91
|
+
|
|
92
|
+
### Machine Identity (NHI - Non-Human Identity)
|
|
93
|
+
Credentials, tokens, or accounts used by automated systems rather than humans. AI agents use machine identities to access services.
|
|
94
|
+
|
|
95
|
+
### Memory Poisoning
|
|
96
|
+
An attack where malicious information is injected into an AI's persistent memory, causing it to behave incorrectly in future sessions.
|
|
97
|
+
|
|
98
|
+
---
|
|
99
|
+
|
|
100
|
+
## P
|
|
101
|
+
|
|
102
|
+
### Prompt Injection
|
|
103
|
+
An attack where malicious instructions are hidden in content the AI processes (websites, documents, emails), causing the AI to take unintended actions.
|
|
104
|
+
|
|
105
|
+
---
|
|
106
|
+
|
|
107
|
+
## R
|
|
108
|
+
|
|
109
|
+
### RED Zone
|
|
110
|
+
In this framework: actions that AI must NEVER take, regardless of instructions. Critical blast radius, potentially catastrophic consequences.
|
|
111
|
+
|
|
112
|
+
### Review Gate
|
|
113
|
+
A checkpoint requiring human approval before AI can proceed with a consequential action. Provides oversight for YELLOW zone actions.
|
|
114
|
+
|
|
115
|
+
---
|
|
116
|
+
|
|
117
|
+
## S
|
|
118
|
+
|
|
119
|
+
### Sandboxing
|
|
120
|
+
Running AI agents in an isolated environment where they cannot affect systems outside the sandbox. Limits blast radius of compromises.
|
|
121
|
+
|
|
122
|
+
### Scoped Token
|
|
123
|
+
A credential with limited permissions, valid only for specific actions or resources. Contrasts with full-access credentials.
|
|
124
|
+
|
|
125
|
+
### Session Termination
|
|
126
|
+
Immediately ending an AI agent's active session, including revoking any temporary access and clearing active state.
|
|
127
|
+
|
|
128
|
+
### System Prompt Extraction
|
|
129
|
+
An attack where adversaries trick AI into revealing its configuration or instructions, exposing security rules and business logic.
|
|
130
|
+
|
|
131
|
+
---
|
|
132
|
+
|
|
133
|
+
## T
|
|
134
|
+
|
|
135
|
+
### Token Rotation
|
|
136
|
+
Regularly replacing credentials/tokens with new ones, even if no compromise is suspected. Limits the window of opportunity if a credential is stolen.
|
|
137
|
+
|
|
138
|
+
---
|
|
139
|
+
|
|
140
|
+
## Y
|
|
141
|
+
|
|
142
|
+
### YELLOW Zone
|
|
143
|
+
In this framework: actions that AI can take but requires notification or review. Moderate blast radius, requires oversight.
|
|
144
|
+
|
|
145
|
+
---
|
|
146
|
+
|
|
147
|
+
## Z
|
|
148
|
+
|
|
149
|
+
### Zero Standing Privileges
|
|
150
|
+
An access model where no entity has permanent access to sensitive resources. Access is granted just-in-time, scoped, and revoked after use.
|
|
151
|
+
|
|
152
|
+
### Zero Trust
|
|
153
|
+
A security model that assumes no implicit trust based on network location, previous authentication, or other contextual factors. Every request must be verified.
|
|
154
|
+
|
|
155
|
+
---
|
|
156
|
+
|
|
157
|
+
## Security Framework Acronyms
|
|
158
|
+
|
|
159
|
+
| Acronym | Meaning |
|
|
160
|
+
|---------|---------|
|
|
161
|
+
| MFA | Multi-Factor Authentication |
|
|
162
|
+
| IAM | Identity and Access Management |
|
|
163
|
+
| RBAC | Role-Based Access Control |
|
|
164
|
+
| PAT | Personal Access Token |
|
|
165
|
+
| SSO | Single Sign-On |
|
|
166
|
+
| OAuth | Open Authorization (delegation protocol) |
|
|
167
|
+
| CSRF | Cross-Site Request Forgery |
|
|
168
|
+
| XSS | Cross-Site Scripting |
|
|
169
|
+
| CVE | Common Vulnerabilities and Exposures |
|
|
170
|
+
| OWASP | Open Web Application Security Project |
|
|
171
|
+
| NIST | National Institute of Standards and Technology |
|
|
172
|
+
| SOC 2 | Service Organization Control Type 2 |
|
|
173
|
+
|
|
174
|
+
---
|
|
175
|
+
|
|
176
|
+
*Can't find a term? It might be in the [Core Principles](docs/01-core-principles.md) or [Threat Landscape](docs/02-threat-landscape.md) docs.*
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 Corey Epstein
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,172 @@
|
|
|
1
|
+
# Quick Start Guide
|
|
2
|
+
|
|
3
|
+
> Get secure in 30 minutes
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Who This Is For
|
|
8
|
+
|
|
9
|
+
You're about to give AI agents (Claude in Chrome, Claude Code, or similar) access to your systems. You have credentials, accounts, and data you need to protect. This guide gets you to a baseline secure state fast.
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## The 30-Minute Path
|
|
14
|
+
|
|
15
|
+
### Minute 0-5: Create Isolation
|
|
16
|
+
|
|
17
|
+
**Create a separate browser profile for AI:**
|
|
18
|
+
|
|
19
|
+
1. Chrome → Profile icon → Add
|
|
20
|
+
2. Name it "AI-Agent"
|
|
21
|
+
3. Don't sign into Chrome
|
|
22
|
+
4. Don't sync anything
|
|
23
|
+
|
|
24
|
+
**Verify isolation:**
|
|
25
|
+
- No saved passwords in new profile
|
|
26
|
+
- No payment methods
|
|
27
|
+
- No autofill data
|
|
28
|
+
|
|
29
|
+
### Minute 5-15: Block Critical Sites
|
|
30
|
+
|
|
31
|
+
**Add these to your blocklist:**
|
|
32
|
+
|
|
33
|
+
Your banks:
|
|
34
|
+
```
|
|
35
|
+
bankofamerica.com
|
|
36
|
+
chase.com
|
|
37
|
+
[your banks here]
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Investment sites:
|
|
41
|
+
```
|
|
42
|
+
fidelity.com
|
|
43
|
+
vanguard.com
|
|
44
|
+
[your investment sites]
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Password managers (web):
|
|
48
|
+
```
|
|
49
|
+
1password.com
|
|
50
|
+
lastpass.com
|
|
51
|
+
bitwarden.com
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
**Method:** Use a site blocker extension, or add to hosts file:
|
|
55
|
+
```
|
|
56
|
+
# /etc/hosts
|
|
57
|
+
127.0.0.1 bankofamerica.com
|
|
58
|
+
127.0.0.1 chase.com
|
|
59
|
+
# etc.
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### Minute 15-20: Know Your Kill Switch
|
|
63
|
+
|
|
64
|
+
**Practice these now:**
|
|
65
|
+
|
|
66
|
+
Close all tabs fast:
|
|
67
|
+
- Mac: `Cmd + Shift + W`
|
|
68
|
+
- Windows: `Ctrl + Shift + W`
|
|
69
|
+
|
|
70
|
+
Kill browser process:
|
|
71
|
+
- Mac: `Cmd + Option + Esc` → Force Quit
|
|
72
|
+
- Chrome: `Shift + Esc` → End Process
|
|
73
|
+
|
|
74
|
+
Write down: "If AI goes rogue, I will: ________________"
|
|
75
|
+
|
|
76
|
+
### Minute 20-25: Set Basic Rules
|
|
77
|
+
|
|
78
|
+
**Add to your agents.md or equivalent:**
|
|
79
|
+
|
|
80
|
+
```markdown
|
|
81
|
+
## Security Rules
|
|
82
|
+
|
|
83
|
+
NEVER access:
|
|
84
|
+
- Banking or financial sites
|
|
85
|
+
- Password managers
|
|
86
|
+
- Healthcare portals
|
|
87
|
+
|
|
88
|
+
ALWAYS ask before:
|
|
89
|
+
- Sending any external communication
|
|
90
|
+
- Making any purchase
|
|
91
|
+
- Deleting any file
|
|
92
|
+
- Accessing any site not on approved list
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
### Minute 25-30: Verify It Works
|
|
96
|
+
|
|
97
|
+
**Test your blocks:**
|
|
98
|
+
1. In AI profile, try navigating to your bank
|
|
99
|
+
2. Should be blocked
|
|
100
|
+
3. If not, fix your blocklist
|
|
101
|
+
|
|
102
|
+
**Test your kill switch:**
|
|
103
|
+
1. Open several tabs
|
|
104
|
+
2. Practice closing them all (<10 seconds)
|
|
105
|
+
3. Practice force quit
|
|
106
|
+
|
|
107
|
+
---
|
|
108
|
+
|
|
109
|
+
## You're Now Baseline Secure
|
|
110
|
+
|
|
111
|
+
This gives you:
|
|
112
|
+
- ✅ Credential isolation (separate profile)
|
|
113
|
+
- ✅ Critical site blocking (financial, etc.)
|
|
114
|
+
- ✅ Emergency stop capability (kill switches)
|
|
115
|
+
- ✅ Basic rules documented
|
|
116
|
+
|
|
117
|
+
---
|
|
118
|
+
|
|
119
|
+
## Next Steps (When You Have Time)
|
|
120
|
+
|
|
121
|
+
### This Week
|
|
122
|
+
- Complete [Pre-Flight Checklist](checklists/pre-flight.md) fully
|
|
123
|
+
- Set up basic logging
|
|
124
|
+
- Review your token permissions
|
|
125
|
+
|
|
126
|
+
### This Month
|
|
127
|
+
- Read [Core Principles](docs/01-core-principles.md)
|
|
128
|
+
- Implement [Audit Logging](configs/audit-logging.md)
|
|
129
|
+
- Create scoped tokens for AI access
|
|
130
|
+
|
|
131
|
+
### Ongoing
|
|
132
|
+
- [Weekly Audit](checklists/weekly-audit.md) every Friday
|
|
133
|
+
- Rotate credentials monthly
|
|
134
|
+
- Stay current on AI security news
|
|
135
|
+
|
|
136
|
+
---
|
|
137
|
+
|
|
138
|
+
## If Something Goes Wrong
|
|
139
|
+
|
|
140
|
+
1. **Stop** - Use your kill switch
|
|
141
|
+
2. **Assess** - What did AI access?
|
|
142
|
+
3. **Revoke** - Kill any compromised tokens
|
|
143
|
+
4. **Rotate** - Change passwords if needed
|
|
144
|
+
5. **Learn** - Update your rules
|
|
145
|
+
|
|
146
|
+
---
|
|
147
|
+
|
|
148
|
+
## Quick Reference
|
|
149
|
+
|
|
150
|
+
```
|
|
151
|
+
KILL SWITCHES
|
|
152
|
+
─────────────
|
|
153
|
+
Close tabs: Cmd/Ctrl + Shift + W
|
|
154
|
+
Kill browser: Cmd + Option + Esc (Mac)
|
|
155
|
+
Ctrl + Shift + Esc (Windows)
|
|
156
|
+
|
|
157
|
+
NEVER LET AI
|
|
158
|
+
────────────
|
|
159
|
+
• Access banking sites
|
|
160
|
+
• Use password manager
|
|
161
|
+
• Send without approval
|
|
162
|
+
|
|
163
|
+
ALWAYS HAVE
|
|
164
|
+
───────────
|
|
165
|
+
• Separate browser profile
|
|
166
|
+
• Blocked critical sites
|
|
167
|
+
• Way to stop in <60s
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
---
|
|
171
|
+
|
|
172
|
+
*For comprehensive security, see [README](README.md)*
|