xithead 1.4.0 โ 1.5.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/.actrc +14 -0
- package/.actrc.local.example +15 -0
- package/.changelog.md +2 -0
- package/.claude/agents/academic-anthropologist.md +125 -0
- package/.claude/agents/academic-geographer.md +127 -0
- package/.claude/agents/academic-historian.md +123 -0
- package/.claude/agents/academic-narratologist.md +118 -0
- package/.claude/agents/academic-psychologist.md +118 -0
- package/.claude/agents/academic-statistician.md +144 -0
- package/.claude/agents/accounts-payable-agent.md +205 -0
- package/.claude/agents/agentic-identity-trust.md +394 -0
- package/.claude/agents/agents-orchestrator.md +367 -0
- package/.claude/agents/automation-governance-architect.md +216 -0
- package/.claude/agents/blender-addon-engineer.md +243 -0
- package/.claude/agents/business-strategist.md +488 -0
- package/.claude/agents/change-management-consultant.md +497 -0
- package/.claude/agents/chief-financial-officer.md +388 -0
- package/.claude/agents/corporate-training-designer.md +192 -0
- package/.claude/agents/customer-service.md +398 -0
- package/.claude/agents/customer-success-manager.md +460 -0
- package/.claude/agents/data-consolidation-agent.md +60 -0
- package/.claude/agents/data-privacy-officer.md +412 -0
- package/.claude/agents/design-brand-guardian.md +322 -0
- package/.claude/agents/design-image-prompt-engineer.md +236 -0
- package/.claude/agents/design-inclusive-visuals-specialist.md +73 -0
- package/.claude/agents/design-persona-walkthrough.md +272 -0
- package/.claude/agents/design-ui-designer.md +386 -0
- package/.claude/agents/design-ui-finish-gate-reviewer.md +217 -0
- package/.claude/agents/design-ux-architect.md +482 -0
- package/.claude/agents/design-ux-researcher.md +329 -0
- package/.claude/agents/design-visual-storyteller.md +149 -0
- package/.claude/agents/design-whimsy-injector.md +460 -0
- package/.claude/agents/economy-designer.md +156 -0
- package/.claude/agents/engineering-ai-data-remediation-engineer.md +211 -0
- package/.claude/agents/engineering-ai-engineer.md +146 -0
- package/.claude/agents/engineering-api-platform-engineer.md +181 -0
- package/.claude/agents/engineering-ats-validator-architect.md +383 -0
- package/.claude/agents/engineering-autonomous-optimization-architect.md +121 -0
- package/.claude/agents/engineering-backend-architect.md +255 -0
- package/.claude/agents/engineering-china-network-engineer.md +252 -0
- package/.claude/agents/engineering-cms-developer.md +536 -0
- package/.claude/agents/engineering-code-reviewer.md +76 -0
- package/.claude/agents/engineering-codebase-onboarding-engineer.md +173 -0
- package/.claude/agents/engineering-data-engineer.md +349 -0
- package/.claude/agents/engineering-data-visualization-engineer.md +151 -0
- package/.claude/agents/engineering-database-optimizer.md +188 -0
- package/.claude/agents/engineering-database-reliability-engineer.md +201 -0
- package/.claude/agents/engineering-desktop-app-engineer.md +209 -0
- package/.claude/agents/engineering-developer-tooling-engineer.md +153 -0
- package/.claude/agents/engineering-devops-automator.md +385 -0
- package/.claude/agents/engineering-drupal-performance.md +347 -0
- package/.claude/agents/engineering-drupal-shopping-cart.md +360 -0
- package/.claude/agents/engineering-electrical-engineer.md +575 -0
- package/.claude/agents/engineering-email-intelligence-engineer.md +390 -0
- package/.claude/agents/engineering-embedded-firmware-engineer.md +196 -0
- package/.claude/agents/engineering-feishu-integration-developer.md +606 -0
- package/.claude/agents/engineering-filament-optimization-specialist.md +283 -0
- package/.claude/agents/engineering-finops-engineer.md +164 -0
- package/.claude/agents/engineering-frontend-developer.md +257 -0
- package/.claude/agents/engineering-gaussdb-expert.md +334 -0
- package/.claude/agents/engineering-git-workflow-master.md +98 -0
- package/.claude/agents/engineering-i18n-engineer.md +214 -0
- package/.claude/agents/engineering-identity-access-engineer.md +217 -0
- package/.claude/agents/engineering-incident-response-commander.md +444 -0
- package/.claude/agents/engineering-iot-fleet-engineer.md +148 -0
- package/.claude/agents/engineering-it-service-manager.md +561 -0
- package/.claude/agents/engineering-knowledge-graph-engineer.md +372 -0
- package/.claude/agents/engineering-llm-post-training-engineer.md +166 -0
- package/.claude/agents/engineering-minimal-change-engineer.md +207 -0
- package/.claude/agents/engineering-mobile-app-builder.md +493 -0
- package/.claude/agents/engineering-mobile-release-engineer.md +164 -0
- package/.claude/agents/engineering-multi-agent-systems-architect.md +600 -0
- package/.claude/agents/engineering-network-engineer.md +245 -0
- package/.claude/agents/engineering-orgscript-engineer.md +113 -0
- package/.claude/agents/engineering-payments-billing-engineer.md +228 -0
- package/.claude/agents/engineering-pdf-engine-architect.md +696 -0
- package/.claude/agents/engineering-platform-engineer.md +270 -0
- package/.claude/agents/engineering-privacy-engineer.md +152 -0
- package/.claude/agents/engineering-prompt-engineer.md +209 -0
- package/.claude/agents/engineering-rag-pipeline-engineer.md +450 -0
- package/.claude/agents/engineering-rapid-prototyper.md +466 -0
- package/.claude/agents/engineering-realtime-collaboration-engineer.md +200 -0
- package/.claude/agents/engineering-rust-refactoring-specialist.md +313 -0
- package/.claude/agents/engineering-search-relevance-engineer.md +237 -0
- package/.claude/agents/engineering-section-508-specialist.md +339 -0
- package/.claude/agents/engineering-senior-developer.md +176 -0
- package/.claude/agents/engineering-servicenow-developer-mentor.md +180 -0
- package/.claude/agents/engineering-software-architect.md +112 -0
- package/.claude/agents/engineering-solidity-smart-contract-engineer.md +522 -0
- package/.claude/agents/engineering-sre.md +90 -0
- package/.claude/agents/engineering-technical-writer.md +393 -0
- package/.claude/agents/engineering-universal-document-compiler.md +370 -0
- package/.claude/agents/engineering-uswds-developer.md +340 -0
- package/.claude/agents/engineering-video-streaming-engineer.md +151 -0
- package/.claude/agents/engineering-voice-ai-integration-engineer.md +584 -0
- package/.claude/agents/engineering-webassembly-engineer.md +153 -0
- package/.claude/agents/engineering-wechat-mini-program-developer.md +356 -0
- package/.claude/agents/engineering-wordpress-performance.md +346 -0
- package/.claude/agents/engineering-wordpress-shopping-cart.md +346 -0
- package/.claude/agents/esg-sustainability-officer.md +396 -0
- package/.claude/agents/finance-bookkeeper-controller.md +260 -0
- package/.claude/agents/finance-financial-analyst.md +234 -0
- package/.claude/agents/finance-fpa-analyst.md +263 -0
- package/.claude/agents/finance-investment-researcher.md +272 -0
- package/.claude/agents/finance-tax-strategist.md +239 -0
- package/.claude/agents/game-audio-engineer.md +264 -0
- package/.claude/agents/game-designer.md +167 -0
- package/.claude/agents/gis-3d-scene-developer.md +111 -0
- package/.claude/agents/gis-analyst.md +91 -0
- package/.claude/agents/gis-bim-specialist.md +108 -0
- package/.claude/agents/gis-cartography-designer.md +150 -0
- package/.claude/agents/gis-drone-reality-mapping.md +120 -0
- package/.claude/agents/gis-geoai-ml-engineer.md +105 -0
- package/.claude/agents/gis-geoprocessing-specialist.md +97 -0
- package/.claude/agents/gis-qa-engineer.md +133 -0
- package/.claude/agents/gis-solution-engineer.md +101 -0
- package/.claude/agents/gis-spatial-data-engineer.md +97 -0
- package/.claude/agents/gis-spatial-data-scientist.md +111 -0
- package/.claude/agents/gis-technical-consultant.md +86 -0
- package/.claude/agents/gis-web-gis-developer.md +108 -0
- package/.claude/agents/godot-gameplay-scripter.md +338 -0
- package/.claude/agents/godot-multiplayer-engineer.md +301 -0
- package/.claude/agents/godot-shader-developer.md +267 -0
- package/.claude/agents/government-digital-presales-consultant.md +363 -0
- package/.claude/agents/grant-writer.md +511 -0
- package/.claude/agents/healthcare-aging-parent-care-companion.md +414 -0
- package/.claude/agents/healthcare-clinical-evidence-agent.md +231 -0
- package/.claude/agents/healthcare-customer-service.md +389 -0
- package/.claude/agents/healthcare-innovation-strategist.md +433 -0
- package/.claude/agents/healthcare-marketing-compliance.md +395 -0
- package/.claude/agents/healthcare-sovereign-health-systems-agent.md +312 -0
- package/.claude/agents/hospitality-guest-services.md +603 -0
- package/.claude/agents/hr-onboarding.md +451 -0
- package/.claude/agents/identity-graph-operator.md +303 -0
- package/.claude/agents/language-translator.md +264 -0
- package/.claude/agents/legal-billing-time-tracking.md +569 -0
- package/.claude/agents/legal-client-intake.md +492 -0
- package/.claude/agents/legal-document-review.md +454 -0
- package/.claude/agents/level-designer.md +208 -0
- package/.claude/agents/loan-officer-assistant.md +555 -0
- package/.claude/agents/lsp-index-engineer.md +320 -0
- package/.claude/agents/ma-integration-manager.md +427 -0
- package/.claude/agents/macos-spatial-metal-engineer.md +337 -0
- package/.claude/agents/marketing-aeo-foundations.md +264 -0
- package/.claude/agents/marketing-agentic-search-optimizer.md +279 -0
- package/.claude/agents/marketing-ai-citation-strategist.md +172 -0
- package/.claude/agents/marketing-app-store-optimizer.md +321 -0
- package/.claude/agents/marketing-baidu-seo-specialist.md +226 -0
- package/.claude/agents/marketing-bilibili-content-strategist.md +199 -0
- package/.claude/agents/marketing-book-co-author.md +110 -0
- package/.claude/agents/marketing-carousel-growth-engine.md +204 -0
- package/.claude/agents/marketing-china-ecommerce-operator.md +283 -0
- package/.claude/agents/marketing-china-market-localization-strategist.md +283 -0
- package/.claude/agents/marketing-content-creator.md +54 -0
- package/.claude/agents/marketing-cross-border-ecommerce.md +259 -0
- package/.claude/agents/marketing-developer-community-builder.md +285 -0
- package/.claude/agents/marketing-douyin-strategist.md +149 -0
- package/.claude/agents/marketing-email-strategist.md +249 -0
- package/.claude/agents/marketing-global-podcast-strategist.md +206 -0
- package/.claude/agents/marketing-growth-hacker.md +54 -0
- package/.claude/agents/marketing-instagram-curator.md +113 -0
- package/.claude/agents/marketing-kuaishou-strategist.md +223 -0
- package/.claude/agents/marketing-linkedin-content-creator.md +214 -0
- package/.claude/agents/marketing-livestream-commerce-coach.md +305 -0
- package/.claude/agents/marketing-multi-platform-publisher.md +217 -0
- package/.claude/agents/marketing-podcast-strategist.md +277 -0
- package/.claude/agents/marketing-pr-communications-manager.md +473 -0
- package/.claude/agents/marketing-private-domain-operator.md +308 -0
- package/.claude/agents/marketing-reddit-community-builder.md +123 -0
- package/.claude/agents/marketing-seo-specialist.md +370 -0
- package/.claude/agents/marketing-short-video-editing-coach.md +412 -0
- package/.claude/agents/marketing-social-media-strategist.md +125 -0
- package/.claude/agents/marketing-tiktok-strategist.md +125 -0
- package/.claude/agents/marketing-twitter-engager.md +126 -0
- package/.claude/agents/marketing-video-optimization-specialist.md +119 -0
- package/.claude/agents/marketing-wechat-official-account.md +145 -0
- package/.claude/agents/marketing-weibo-strategist.md +240 -0
- package/.claude/agents/marketing-x-twitter-intelligence-analyst.md +161 -0
- package/.claude/agents/marketing-xiaohongshu-specialist.md +138 -0
- package/.claude/agents/marketing-zhihu-strategist.md +162 -0
- package/.claude/agents/medical-billing-coding-specialist.md +491 -0
- package/.claude/agents/narrative-designer.md +243 -0
- package/.claude/agents/operations-manager.md +399 -0
- package/.claude/agents/organizational-psychologist.md +391 -0
- package/.claude/agents/paid-media-auditor.md +71 -0
- package/.claude/agents/paid-media-creative-strategist.md +71 -0
- package/.claude/agents/paid-media-paid-social-strategist.md +71 -0
- package/.claude/agents/paid-media-ppc-strategist.md +71 -0
- package/.claude/agents/paid-media-programmatic-buyer.md +71 -0
- package/.claude/agents/paid-media-search-query-analyst.md +71 -0
- package/.claude/agents/paid-media-tracking-specialist.md +71 -0
- package/.claude/agents/personal-growth-mentor.md +159 -0
- package/.claude/agents/product-behavioral-nudge-engine.md +83 -0
- package/.claude/agents/product-dx-engineer.md +332 -0
- package/.claude/agents/product-feedback-synthesizer.md +119 -0
- package/.claude/agents/product-manager.md +469 -0
- package/.claude/agents/product-sprint-prioritizer.md +154 -0
- package/.claude/agents/product-trend-researcher.md +159 -0
- package/.claude/agents/project-management-experiment-tracker.md +198 -0
- package/.claude/agents/project-management-jira-workflow-steward.md +233 -0
- package/.claude/agents/project-management-meeting-notes-specialist.md +95 -0
- package/.claude/agents/project-management-project-shepherd.md +194 -0
- package/.claude/agents/project-management-studio-operations.md +200 -0
- package/.claude/agents/project-management-studio-producer.md +203 -0
- package/.claude/agents/project-manager-senior.md +135 -0
- package/.claude/agents/real-estate-buyer-seller.md +596 -0
- package/.claude/agents/recruitment-specialist.md +515 -0
- package/.claude/agents/report-distribution-agent.md +65 -0
- package/.claude/agents/research-synthesist.md +136 -0
- package/.claude/agents/resume-tailor.md +230 -0
- package/.claude/agents/retail-customer-returns.md +566 -0
- package/.claude/agents/roblox-avatar-creator.md +297 -0
- package/.claude/agents/roblox-experience-designer.md +306 -0
- package/.claude/agents/roblox-systems-scripter.md +332 -0
- package/.claude/agents/sales-account-strategist.md +227 -0
- package/.claude/agents/sales-coach.md +271 -0
- package/.claude/agents/sales-data-extraction-agent.md +67 -0
- package/.claude/agents/sales-deal-strategist.md +180 -0
- package/.claude/agents/sales-discovery-coach.md +225 -0
- package/.claude/agents/sales-engineer.md +182 -0
- package/.claude/agents/sales-offer-lead-gen-strategist.md +257 -0
- package/.claude/agents/sales-outbound-strategist.md +201 -0
- package/.claude/agents/sales-outreach.md +425 -0
- package/.claude/agents/sales-pipeline-analyst.md +267 -0
- package/.claude/agents/sales-proposal-strategist.md +217 -0
- package/.claude/agents/security-ai-generated-code-auditor.md +207 -0
- package/.claude/agents/security-appsec-engineer.md +536 -0
- package/.claude/agents/security-architect.md +307 -0
- package/.claude/agents/security-blockchain-security-auditor.md +482 -0
- package/.claude/agents/security-cloud-security-architect.md +576 -0
- package/.claude/agents/security-compliance-auditor.md +158 -0
- package/.claude/agents/security-incident-responder.md +450 -0
- package/.claude/agents/security-penetration-tester.md +399 -0
- package/.claude/agents/security-secrets-credential-engineer.md +189 -0
- package/.claude/agents/security-senior-secops.md +760 -0
- package/.claude/agents/security-threat-detection-engineer.md +553 -0
- package/.claude/agents/security-threat-intelligence-analyst.md +661 -0
- package/.claude/agents/specialized-chief-of-staff.md +279 -0
- package/.claude/agents/specialized-civil-engineer.md +356 -0
- package/.claude/agents/specialized-codebase-archaeologist.md +341 -0
- package/.claude/agents/specialized-cultural-intelligence-strategist.md +88 -0
- package/.claude/agents/specialized-developer-advocate.md +317 -0
- package/.claude/agents/specialized-document-generator.md +55 -0
- package/.claude/agents/specialized-fedramp-rmf-compliance.md +378 -0
- package/.claude/agents/specialized-focus-music-architect.md +175 -0
- package/.claude/agents/specialized-french-consulting-market.md +194 -0
- package/.claude/agents/specialized-korean-business-navigator.md +216 -0
- package/.claude/agents/specialized-master-plan-architect.md +157 -0
- package/.claude/agents/specialized-mcp-builder.md +260 -0
- package/.claude/agents/specialized-model-qa.md +528 -0
- package/.claude/agents/specialized-pricing-analyst.md +243 -0
- package/.claude/agents/specialized-salesforce-architect.md +182 -0
- package/.claude/agents/specialized-strategy-duel-agent.md +130 -0
- package/.claude/agents/specialized-workflow-architect.md +597 -0
- package/.claude/agents/study-abroad-advisor.md +282 -0
- package/.claude/agents/supply-chain-strategist.md +591 -0
- package/.claude/agents/support-analytics-reporter.md +387 -0
- package/.claude/agents/support-executive-summary-generator.md +212 -0
- package/.claude/agents/support-finance-tracker.md +480 -0
- package/.claude/agents/support-infrastructure-maintainer.md +628 -0
- package/.claude/agents/support-legal-compliance-checker.md +591 -0
- package/.claude/agents/support-support-responder.md +607 -0
- package/.claude/agents/technical-artist.md +233 -0
- package/.claude/agents/terminal-integration-specialist.md +70 -0
- package/.claude/agents/testing-accessibility-auditor.md +327 -0
- package/.claude/agents/testing-api-tester.md +334 -0
- package/.claude/agents/testing-evidence-collector.md +210 -0
- package/.claude/agents/testing-performance-benchmarker.md +283 -0
- package/.claude/agents/testing-reality-checker.md +249 -0
- package/.claude/agents/testing-test-automation-engineer.md +196 -0
- package/.claude/agents/testing-test-results-analyzer.md +330 -0
- package/.claude/agents/testing-tool-evaluator.md +416 -0
- package/.claude/agents/testing-workflow-optimizer.md +463 -0
- package/.claude/agents/unity-architect.md +271 -0
- package/.claude/agents/unity-editor-tool-developer.md +310 -0
- package/.claude/agents/unity-multiplayer-engineer.md +323 -0
- package/.claude/agents/unity-shader-graph-artist.md +269 -0
- package/.claude/agents/unreal-multiplayer-architect.md +364 -0
- package/.claude/agents/unreal-systems-engineer.md +322 -0
- package/.claude/agents/unreal-technical-artist.md +256 -0
- package/.claude/agents/unreal-world-builder.md +273 -0
- package/.claude/agents/visionos-spatial-engineer.md +54 -0
- package/.claude/agents/xr-cockpit-interaction-specialist.md +32 -0
- package/.claude/agents/xr-immersive-developer.md +32 -0
- package/.claude/agents/xr-interface-architect.md +32 -0
- package/.claude/agents/zk-steward.md +211 -0
- package/.claude-plugin/marketplace.json +30 -0
- package/.commitlintrc.json +26 -0
- package/.devcontainer/Dockerfile +24 -0
- package/.devcontainer/devcontainer.json +70 -0
- package/.devcontainer/docker-compose.memory.yml +42 -0
- package/.devcontainer/memory-stack/devcontainer.json +84 -0
- package/.devcontainer/post-create.sh +83 -0
- package/.dockerignore +23 -0
- package/.env.act.example +15 -0
- package/.env.example +171 -0
- package/.eslintrc.json +16 -0
- package/.git-blame-ignore-revs +10 -0
- package/.gitattributes +2 -0
- package/.gitguardian.yaml +50 -0
- package/.githooks/pre-commit +6 -0
- package/.pre-commit-config.yaml +30 -0
- package/.release-please-config-xithead.json +22 -0
- package/.release-please-config.json +44 -0
- package/.release-please-manifest-xithead.json +3 -0
- package/.release-please-manifest.json +3 -0
- package/CODE_OF_CONDUCT.md +133 -0
- package/CONTRIBUTING.md +133 -0
- package/Cargo.lock +5557 -0
- package/Cargo.toml +121 -0
- package/Dockerfile +38 -0
- package/Dockerfile.proxy +48 -0
- package/ENTERPRISE.md +5 -0
- package/FEATURES_ADVANCED.md +311 -0
- package/Headroom-2.gif +0 -0
- package/HeadroomDemo-Fast.gif +0 -0
- package/MANIFEST.in +4 -0
- package/MODERNIZATION_GUIDE.md +358 -0
- package/Makefile +140 -0
- package/NOTICE +43 -0
- package/NPM_TOKEN_SETUP.md +81 -0
- package/PR.md +170 -0
- package/PUBLISH.md +77 -0
- package/README.md +108 -72
- package/README_FRONTEND.md +196 -0
- package/REALIGNMENT/00-overview.md +53 -0
- package/REALIGNMENT/01-bug-list.md +421 -0
- package/REALIGNMENT/02-architecture.md +322 -0
- package/REALIGNMENT/03-phase-A-lockdown.md +420 -0
- package/REALIGNMENT/04-phase-B-live-zone.md +470 -0
- package/REALIGNMENT/05-phase-C-rust-proxy.md +329 -0
- package/REALIGNMENT/06-phase-D-bedrock-vertex.md +222 -0
- package/REALIGNMENT/07-phase-E-cache-stabilization.md +338 -0
- package/REALIGNMENT/08-phase-F-auth-mode.md +254 -0
- package/REALIGNMENT/09-phase-G-rtk-observability.md +194 -0
- package/REALIGNMENT/10-phase-H-python-retirement.md +214 -0
- package/REALIGNMENT/11-phase-I-test-infra.md +385 -0
- package/REALIGNMENT/12-decisions-needed.md +196 -0
- package/REALIGNMENT/INDEX.md +82 -0
- package/REFACTORING_CAMPAIGN.md +277 -0
- package/RESTRUCTURE_PLAN.md +100 -0
- package/RUST_DEV.md +361 -0
- package/SECURITY.md +65 -0
- package/SETUP_AUTO_PUBLISH.md +164 -0
- package/TESTING-copilot-subscription.md +153 -0
- package/app/api/config/route.ts +22 -0
- package/app/api/export/route.ts +83 -0
- package/app/api/models/route.ts +12 -0
- package/app/api/stats/route.ts +46 -0
- package/app/dashboard/page.tsx +445 -0
- package/app/globals.css +35 -0
- package/app/installation/page.tsx +293 -0
- package/app/layout.tsx +35 -0
- package/app/master-design-system.css +2076 -0
- package/app/master-design-system.source.css +8 -0
- package/app/page.tsx +187 -0
- package/app/rechtliches/agb/page.tsx +165 -0
- package/app/rechtliches/datenschutz/page.tsx +128 -0
- package/app/rechtliches/impressum/page.tsx +122 -0
- package/app/rechtliches/widerruf/page.tsx +185 -0
- package/bin/xithead.js +264 -0
- package/codecov.yml +34 -0
- package/components/layout/AppShell.tsx +25 -0
- package/components/layout/Footer.tsx +120 -0
- package/components/layout/Header.tsx +145 -0
- package/components/marketing/LegalHighlights.tsx +45 -0
- package/components/marketing/LegalPageShell.tsx +49 -0
- package/components/marketing/LegalPanel.tsx +41 -0
- package/components/marketing/index.ts +3 -0
- package/crates/headroom-core/Cargo.toml +165 -0
- package/crates/headroom-core/benches/auth_mode.rs +74 -0
- package/crates/headroom-core/benches/ccr_store.rs +224 -0
- package/crates/headroom-core/benches/tokenizer.rs +52 -0
- package/crates/headroom-core/config/pipeline.toml +151 -0
- package/crates/headroom-core/proptest-regressions/transforms/tag_protector.txt +9 -0
- package/crates/headroom-core/src/auth_mode.rs +250 -0
- package/crates/headroom-core/src/cache_control.rs +414 -0
- package/crates/headroom-core/src/ccr/backends/in_memory.rs +317 -0
- package/crates/headroom-core/src/ccr/backends/mod.rs +152 -0
- package/crates/headroom-core/src/ccr/backends/redis.rs +146 -0
- package/crates/headroom-core/src/ccr/backends/sqlite.rs +205 -0
- package/crates/headroom-core/src/ccr/mod.rs +119 -0
- package/crates/headroom-core/src/compression_policy.rs +505 -0
- package/crates/headroom-core/src/lib.rs +33 -0
- package/crates/headroom-core/src/relevance/base.rs +139 -0
- package/crates/headroom-core/src/relevance/bm25.rs +385 -0
- package/crates/headroom-core/src/relevance/embedding.rs +354 -0
- package/crates/headroom-core/src/relevance/hybrid.rs +364 -0
- package/crates/headroom-core/src/relevance/mod.rs +64 -0
- package/crates/headroom-core/src/signals/keyword_detector.rs +433 -0
- package/crates/headroom-core/src/signals/line_importance.rs +84 -0
- package/crates/headroom-core/src/signals/mod.rs +61 -0
- package/crates/headroom-core/src/signals/tiered.rs +141 -0
- package/crates/headroom-core/src/tokenizer/estimator.rs +152 -0
- package/crates/headroom-core/src/tokenizer/hf_impl.rs +314 -0
- package/crates/headroom-core/src/tokenizer/mod.rs +56 -0
- package/crates/headroom-core/src/tokenizer/registry.rs +342 -0
- package/crates/headroom-core/src/tokenizer/tiktoken_impl.rs +265 -0
- package/crates/headroom-core/src/transforms/adaptive_sizer.rs +610 -0
- package/crates/headroom-core/src/transforms/anchor_selector.rs +1189 -0
- package/crates/headroom-core/src/transforms/content_detector.rs +769 -0
- package/crates/headroom-core/src/transforms/detection.rs +222 -0
- package/crates/headroom-core/src/transforms/diff_compressor.rs +1685 -0
- package/crates/headroom-core/src/transforms/live_zone.rs +2967 -0
- package/crates/headroom-core/src/transforms/log_compressor.rs +1295 -0
- package/crates/headroom-core/src/transforms/magika_detector.rs +395 -0
- package/crates/headroom-core/src/transforms/mod.rs +64 -0
- package/crates/headroom-core/src/transforms/pipeline/config.rs +331 -0
- package/crates/headroom-core/src/transforms/pipeline/mod.rs +103 -0
- package/crates/headroom-core/src/transforms/pipeline/offloads/diff_noise.rs +524 -0
- package/crates/headroom-core/src/transforms/pipeline/offloads/diff_offload.rs +279 -0
- package/crates/headroom-core/src/transforms/pipeline/offloads/json_offload.rs +400 -0
- package/crates/headroom-core/src/transforms/pipeline/offloads/log_offload.rs +284 -0
- package/crates/headroom-core/src/transforms/pipeline/offloads/mod.rs +34 -0
- package/crates/headroom-core/src/transforms/pipeline/offloads/search_offload.rs +331 -0
- package/crates/headroom-core/src/transforms/pipeline/orchestrator.rs +848 -0
- package/crates/headroom-core/src/transforms/pipeline/reformats/json_minifier.rs +175 -0
- package/crates/headroom-core/src/transforms/pipeline/reformats/log_template.rs +545 -0
- package/crates/headroom-core/src/transforms/pipeline/reformats/mod.rs +12 -0
- package/crates/headroom-core/src/transforms/pipeline/traits.rs +338 -0
- package/crates/headroom-core/src/transforms/recommendations.rs +329 -0
- package/crates/headroom-core/src/transforms/safety.rs +215 -0
- package/crates/headroom-core/src/transforms/search_compressor.rs +902 -0
- package/crates/headroom-core/src/transforms/smart_crusher/analyzer.rs +1262 -0
- package/crates/headroom-core/src/transforms/smart_crusher/anchors.rs +407 -0
- package/crates/headroom-core/src/transforms/smart_crusher/builder.rs +263 -0
- package/crates/headroom-core/src/transforms/smart_crusher/classifier.rs +214 -0
- package/crates/headroom-core/src/transforms/smart_crusher/compaction/classifier.rs +283 -0
- package/crates/headroom-core/src/transforms/smart_crusher/compaction/compactor.rs +733 -0
- package/crates/headroom-core/src/transforms/smart_crusher/compaction/formatter.rs +961 -0
- package/crates/headroom-core/src/transforms/smart_crusher/compaction/ir.rs +252 -0
- package/crates/headroom-core/src/transforms/smart_crusher/compaction/mod.rs +127 -0
- package/crates/headroom-core/src/transforms/smart_crusher/compaction/walker.rs +397 -0
- package/crates/headroom-core/src/transforms/smart_crusher/config.rs +173 -0
- package/crates/headroom-core/src/transforms/smart_crusher/constraints.rs +159 -0
- package/crates/headroom-core/src/transforms/smart_crusher/crusher.rs +1665 -0
- package/crates/headroom-core/src/transforms/smart_crusher/crushers.rs +865 -0
- package/crates/headroom-core/src/transforms/smart_crusher/error_keywords.rs +77 -0
- package/crates/headroom-core/src/transforms/smart_crusher/field_detect.rs +393 -0
- package/crates/headroom-core/src/transforms/smart_crusher/hashing.rs +72 -0
- package/crates/headroom-core/src/transforms/smart_crusher/mod.rs +81 -0
- package/crates/headroom-core/src/transforms/smart_crusher/observer.rs +66 -0
- package/crates/headroom-core/src/transforms/smart_crusher/orchestration.rs +459 -0
- package/crates/headroom-core/src/transforms/smart_crusher/outliers.rs +507 -0
- package/crates/headroom-core/src/transforms/smart_crusher/planning.rs +904 -0
- package/crates/headroom-core/src/transforms/smart_crusher/statistics.rs +510 -0
- package/crates/headroom-core/src/transforms/smart_crusher/stats_math.rs +287 -0
- package/crates/headroom-core/src/transforms/smart_crusher/traits.rs +203 -0
- package/crates/headroom-core/src/transforms/smart_crusher/types.rs +263 -0
- package/crates/headroom-core/src/transforms/tag_protector.rs +1272 -0
- package/crates/headroom-core/src/transforms/unidiff_detector.rs +232 -0
- package/crates/headroom-parity/Cargo.toml +26 -0
- package/crates/headroom-parity/examples/diff_fixture.rs +66 -0
- package/crates/headroom-parity/src/bin/parity_run.rs +78 -0
- package/crates/headroom-parity/src/lib.rs +613 -0
- package/crates/headroom-proxy/Cargo.toml +119 -0
- package/crates/headroom-proxy/data/model_prices_and_context_window.json +39767 -0
- package/crates/headroom-proxy/src/bedrock/auth_mode_layer.rs +192 -0
- package/crates/headroom-proxy/src/bedrock/envelope.rs +239 -0
- package/crates/headroom-proxy/src/bedrock/eventstream.rs +769 -0
- package/crates/headroom-proxy/src/bedrock/eventstream_to_sse.rs +459 -0
- package/crates/headroom-proxy/src/bedrock/invoke.rs +735 -0
- package/crates/headroom-proxy/src/bedrock/invoke_streaming.rs +1098 -0
- package/crates/headroom-proxy/src/bedrock/mod.rs +66 -0
- package/crates/headroom-proxy/src/bedrock/sigv4.rs +324 -0
- package/crates/headroom-proxy/src/bedrock/vendor.rs +82 -0
- package/crates/headroom-proxy/src/cache_stabilization/anthropic_cache_control.rs +698 -0
- package/crates/headroom-proxy/src/cache_stabilization/drift_detector.rs +683 -0
- package/crates/headroom-proxy/src/cache_stabilization/mod.rs +61 -0
- package/crates/headroom-proxy/src/cache_stabilization/openai_cache_key.rs +600 -0
- package/crates/headroom-proxy/src/cache_stabilization/tool_def_normalize.rs +514 -0
- package/crates/headroom-proxy/src/cache_stabilization/volatile_detector.rs +720 -0
- package/crates/headroom-proxy/src/compression/anthropic.rs +92 -0
- package/crates/headroom-proxy/src/compression/live_zone_anthropic.rs +1311 -0
- package/crates/headroom-proxy/src/compression/live_zone_openai.rs +660 -0
- package/crates/headroom-proxy/src/compression/live_zone_responses.rs +678 -0
- package/crates/headroom-proxy/src/compression/mod.rs +127 -0
- package/crates/headroom-proxy/src/compression/model_limits.rs +211 -0
- package/crates/headroom-proxy/src/config.rs +646 -0
- package/crates/headroom-proxy/src/error.rs +69 -0
- package/crates/headroom-proxy/src/handlers/chat_completions.rs +100 -0
- package/crates/headroom-proxy/src/handlers/conversations.rs +241 -0
- package/crates/headroom-proxy/src/handlers/mod.rs +13 -0
- package/crates/headroom-proxy/src/handlers/responses.rs +256 -0
- package/crates/headroom-proxy/src/headers.rs +288 -0
- package/crates/headroom-proxy/src/health.rs +41 -0
- package/crates/headroom-proxy/src/lib.rs +21 -0
- package/crates/headroom-proxy/src/main.rs +141 -0
- package/crates/headroom-proxy/src/observability/cache_hit_rate.rs +340 -0
- package/crates/headroom-proxy/src/observability/compression_ratio.rs +158 -0
- package/crates/headroom-proxy/src/observability/metric_names.rs +174 -0
- package/crates/headroom-proxy/src/observability/mod.rs +68 -0
- package/crates/headroom-proxy/src/observability/prometheus.rs +394 -0
- package/crates/headroom-proxy/src/observability/proxy_metrics.rs +368 -0
- package/crates/headroom-proxy/src/proxy.rs +1619 -0
- package/crates/headroom-proxy/src/responses_items.rs +565 -0
- package/crates/headroom-proxy/src/sse/anthropic.rs +415 -0
- package/crates/headroom-proxy/src/sse/framing.rs +366 -0
- package/crates/headroom-proxy/src/sse/mod.rs +40 -0
- package/crates/headroom-proxy/src/sse/openai_chat.rs +231 -0
- package/crates/headroom-proxy/src/sse/openai_responses.rs +458 -0
- package/crates/headroom-proxy/src/vertex/adc.rs +315 -0
- package/crates/headroom-proxy/src/vertex/envelope.rs +167 -0
- package/crates/headroom-proxy/src/vertex/mod.rs +277 -0
- package/crates/headroom-proxy/src/vertex/raw_predict.rs +490 -0
- package/crates/headroom-proxy/src/vertex/stream_raw_predict.rs +49 -0
- package/crates/headroom-proxy/src/websocket.rs +246 -0
- package/crates/headroom-py/Cargo.toml +37 -0
- package/crates/headroom-py/build.rs +77 -0
- package/crates/headroom-py/glibc_compat.c +170 -0
- package/crates/headroom-py/src/lib.rs +1655 -0
- package/deny.toml +32 -0
- package/design-system/base.css +127 -0
- package/design-system/components.css +1943 -0
- package/design-system/fonts.css +17 -0
- package/design-system/tailwind-preset.js +95 -0
- package/design-system/tokens.css +48 -0
- package/design-system/utilities.css +53 -0
- package/docker/differential-network-capture/Dockerfile.runner +14 -0
- package/docker/differential-network-capture/docker-compose.yml +142 -0
- package/docker/differential-network-capture/run-claude-lane.sh +24 -0
- package/docker/docker-compose.native.yml +44 -0
- package/docker-bake.hcl +88 -0
- package/docker-compose.yml +80 -0
- package/e2e/_lib/make_shim.ps1 +24 -0
- package/e2e/_lib/make_shim.sh +28 -0
- package/e2e/docker-native-install.sh +120 -0
- package/e2e/init/Dockerfile +79 -0
- package/e2e/wrap/Dockerfile +115 -0
- package/examples/07-context-compression.ipynb +279 -0
- package/examples/deployment/macos-launchagent/com.headroom.proxy.plist.template +65 -0
- package/examples/deployment/macos-launchagent/install.sh +227 -0
- package/examples/deployment/macos-launchagent/shell-integration.sh +74 -0
- package/examples/deployment/macos-launchagent/uninstall.sh +145 -0
- package/headroom-savings.png +0 -0
- package/headroom_learn.gif +0 -0
- package/lib/config/index.ts +12 -0
- package/lib/hooks/index.ts +4 -0
- package/lib/hooks/use-mounted.ts +13 -0
- package/lib/hooks/use-session.ts +34 -0
- package/lib/hooks/use-settings.ts +49 -0
- package/lib/utils/index.ts +1 -0
- package/lib/utils/settings.ts +162 -0
- package/lib/utils/utils.ts +6 -0
- package/llms.txt +67 -0
- package/middleware.ts +26 -0
- package/mkdocs.yml +136 -0
- package/next-env.d.ts +7 -0
- package/next.config.ts +12 -0
- package/npm/bin/xithead.js +366 -366
- package/npm/bin/xtream-head.js +366 -0
- package/npm/index.d.ts +57 -57
- package/npm/index.js +139 -139
- package/npm/package.json +55 -54
- package/npm/postinstall.js +43 -43
- package/package.json +58 -36
- package/plugins/headroom-agent-hooks/.claude-plugin/plugin.json +17 -0
- package/plugins/headroom-agent-hooks/hooks/hooks.json +29 -0
- package/plugins/headroom-oauth2/LICENSE +3 -0
- package/plugins/headroom-oauth2/SPEC.md +115 -0
- package/plugins/headroom-oauth2/pyproject.toml +48 -0
- package/plugins/hermes/headroom_retrieve/plugin.yaml +6 -0
- package/plugins/openclaw/hook-shim/HOOK.md +21 -0
- package/plugins/openclaw/hook-shim/handler.js +3 -0
- package/plugins/openclaw/openclaw.plugin.json +98 -0
- package/plugins/openclaw/package-lock.json +2692 -0
- package/plugins/openclaw/package.json +54 -0
- package/plugins/openclaw/prepare-dist.mjs +56 -0
- package/plugins/openclaw/src/convert.ts +418 -0
- package/plugins/openclaw/src/engine.ts +284 -0
- package/plugins/openclaw/src/gateway-config.ts +143 -0
- package/plugins/openclaw/src/index.ts +11 -0
- package/plugins/openclaw/src/plugin/index.ts +98 -0
- package/plugins/openclaw/src/proxy-manager.ts +477 -0
- package/plugins/openclaw/src/tools/headroom-retrieve.ts +76 -0
- package/plugins/openclaw/test/convert.test.ts +96 -0
- package/plugins/openclaw/test/engine-normalization.test.ts +21 -0
- package/plugins/openclaw/test/engine.test.ts +101 -0
- package/plugins/openclaw/test/gateway-config.test.ts +278 -0
- package/plugins/openclaw/test/plugin-runtime-routing.test.ts +141 -0
- package/plugins/openclaw/test/proxy-manager.test.ts +343 -0
- package/plugins/openclaw/tsup.config.ts +9 -0
- package/postcss.config.mjs +7 -0
- package/pyproject.toml +438 -0
- package/rust-toolchain.toml +16 -0
- package/sdk/typescript/examples/basic-compress.ts +64 -0
- package/sdk/typescript/examples/ccr-retrieve.ts +80 -0
- package/sdk/typescript/examples/hooks-custom-compression.ts +117 -0
- package/sdk/typescript/examples/middleware-composition.ts +59 -0
- package/sdk/typescript/examples/multi-provider.ts +53 -0
- package/sdk/typescript/examples/openai-anthropic-adapters.ts +73 -0
- package/sdk/typescript/examples/shared-context-multi-agent.ts +74 -0
- package/sdk/typescript/examples/simulation-dry-run.ts +80 -0
- package/sdk/typescript/examples/streaming-chat.ts +71 -0
- package/sdk/typescript/examples/structured-output.ts +99 -0
- package/sdk/typescript/examples/tool-calling-agent.ts +86 -0
- package/sdk/typescript/examples/with-headroom-vercel.ts +57 -0
- package/sdk/typescript/package-lock.json +3437 -0
- package/sdk/typescript/package.json +108 -0
- package/sdk/typescript/src/adapters/anthropic.ts +218 -0
- package/sdk/typescript/src/adapters/gemini.ts +83 -0
- package/sdk/typescript/src/adapters/openai.ts +77 -0
- package/sdk/typescript/src/adapters/vercel-ai.ts +131 -0
- package/sdk/typescript/src/client.ts +632 -0
- package/sdk/typescript/src/compress.ts +87 -0
- package/sdk/typescript/src/errors.ts +114 -0
- package/sdk/typescript/src/hooks.ts +113 -0
- package/sdk/typescript/src/index.ts +140 -0
- package/sdk/typescript/src/paths.ts +272 -0
- package/sdk/typescript/src/shared-context.ts +188 -0
- package/sdk/typescript/src/simulate.ts +52 -0
- package/sdk/typescript/src/types/config.ts +183 -0
- package/sdk/typescript/src/types/models.ts +314 -0
- package/sdk/typescript/src/types.ts +139 -0
- package/sdk/typescript/src/utils/case.ts +34 -0
- package/sdk/typescript/src/utils/format.ts +480 -0
- package/sdk/typescript/src/utils/stream.ts +50 -0
- package/sdk/typescript/test/adapters/anthropic.test.ts +217 -0
- package/sdk/typescript/test/adapters/gemini.test.ts +131 -0
- package/sdk/typescript/test/adapters/openai.test.ts +174 -0
- package/sdk/typescript/test/adapters/vercel-ai.test.ts +306 -0
- package/sdk/typescript/test/client-expanded.test.ts +333 -0
- package/sdk/typescript/test/client.test.ts +266 -0
- package/sdk/typescript/test/compress.test.ts +118 -0
- package/sdk/typescript/test/config.test.ts +275 -0
- package/sdk/typescript/test/errors.test.ts +169 -0
- package/sdk/typescript/test/format-integration.test.ts +252 -0
- package/sdk/typescript/test/hooks.test.ts +265 -0
- package/sdk/typescript/test/integration.test.ts +249 -0
- package/sdk/typescript/test/mdx-examples.test.ts +253 -0
- package/sdk/typescript/test/models.test.ts +318 -0
- package/sdk/typescript/test/parity.test.ts +337 -0
- package/sdk/typescript/test/paths.test.ts +447 -0
- package/sdk/typescript/test/shared-context.test.ts +245 -0
- package/sdk/typescript/test/simulate.test.ts +84 -0
- package/sdk/typescript/test/types.test.ts +244 -0
- package/sdk/typescript/test/utils/case.test.ts +129 -0
- package/sdk/typescript/test/utils/detect-format.test.ts +133 -0
- package/sdk/typescript/test/utils/format.test.ts +434 -0
- package/sdk/typescript/test/vercel-ai-e2e.test.ts +179 -0
- package/sdk/typescript/tsup.config.ts +17 -0
- package/tailwind.master.config.cjs +47 -0
- package/types/api.ts +12 -0
- package/types/config.ts +9 -0
- package/types/index.ts +2 -0
- package/uv.lock +6951 -0
- package/xithead.egg-info/PKG-INFO +22 -0
- package/xithead.egg-info/SOURCES.txt +16 -0
- package/xithead.egg-info/dependency_links.txt +1 -0
- package/xithead.egg-info/entry_points.txt +2 -0
- package/xithead.egg-info/requires.txt +10 -0
- package/xithead.egg-info/top_level.txt +2 -0
- package/xithead.ps1 +136 -0
- package/xithead.sh +129 -0
- package/xithead_dist/pyproject.toml +39 -0
- package/xithead_dist/xithead.egg-info/PKG-INFO +22 -0
- package/xithead_dist/xithead.egg-info/SOURCES.txt +16 -0
- package/xithead_dist/xithead.egg-info/dependency_links.txt +1 -0
- package/xithead_dist/xithead.egg-info/entry_points.txt +3 -0
- package/xithead_dist/xithead.egg-info/requires.txt +10 -0
- package/xithead_dist/xithead.egg-info/top_level.txt +2 -0
package/.env.example
ADDED
|
@@ -0,0 +1,171 @@
|
|
|
1
|
+
# ============================================================================
|
|
2
|
+
# xtream-head Environment Configuration
|
|
3
|
+
# ============================================================================
|
|
4
|
+
# Copy this file to .env.local and fill in your values:
|
|
5
|
+
# cp .env.example .env.local
|
|
6
|
+
#
|
|
7
|
+
# SECURITY: .env files contain secrets and are automatically ignored by git.
|
|
8
|
+
# Never commit .env to version control.
|
|
9
|
+
|
|
10
|
+
# ============================================================================
|
|
11
|
+
# ENVIRONMENT & SERVER
|
|
12
|
+
# ============================================================================
|
|
13
|
+
|
|
14
|
+
# Node environment: development | production | test
|
|
15
|
+
NODE_ENV=development
|
|
16
|
+
|
|
17
|
+
# Server port (default: 8787)
|
|
18
|
+
PORT=8787
|
|
19
|
+
|
|
20
|
+
# ============================================================================
|
|
21
|
+
# ANTHROPIC API CONFIGURATION
|
|
22
|
+
# ============================================================================
|
|
23
|
+
# REQUIRED: Your Anthropic API key for Claude API access
|
|
24
|
+
ANTHROPIC_API_KEY=sk-ant-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
25
|
+
|
|
26
|
+
# Claude model to use
|
|
27
|
+
# Options: claude-opus-5-5 | claude-sonnet-5-5 | claude-haiku-5-5 | claude-fable-5-1
|
|
28
|
+
XITHEAD_MODEL=claude-sonnet-5-5
|
|
29
|
+
|
|
30
|
+
# Anthropic API endpoint (for proxies or custom deployments)
|
|
31
|
+
XITHEAD_UPSTREAM=https://api.anthropic.com
|
|
32
|
+
|
|
33
|
+
# ============================================================================
|
|
34
|
+
# PUBLIC CONFIG (Visible in browser - NEXT_PUBLIC_*)
|
|
35
|
+
# ============================================================================
|
|
36
|
+
# These values are embedded in the client and visible in the browser
|
|
37
|
+
|
|
38
|
+
# Application base URL
|
|
39
|
+
NEXT_PUBLIC_APP_URL=https://xtream-head.com
|
|
40
|
+
|
|
41
|
+
# Application name (displayed in UI)
|
|
42
|
+
NEXT_PUBLIC_APP_NAME=xtream-head
|
|
43
|
+
|
|
44
|
+
# Company name (displayed in footer)
|
|
45
|
+
NEXT_PUBLIC_COMPANY_NAME=Xtream-ITSolutions UG
|
|
46
|
+
|
|
47
|
+
# Company website
|
|
48
|
+
NEXT_PUBLIC_COMPANY_URL=https://xtream-itsolutions.com
|
|
49
|
+
|
|
50
|
+
# Community & Social Links
|
|
51
|
+
NEXT_PUBLIC_DISCORD_URL=https://discord.gg/xtream-itsolutions
|
|
52
|
+
NEXT_PUBLIC_GITHUB_URL=https://github.com/xtream-itsolutions/xithead
|
|
53
|
+
|
|
54
|
+
# Branding Assets
|
|
55
|
+
NEXT_PUBLIC_LOGO_URL=/logo-transparent.png
|
|
56
|
+
NEXT_PUBLIC_LOGO_SOURCE_URL=https://cdn.xtream-itsolutions.com/r/Pc1hfX
|
|
57
|
+
|
|
58
|
+
# ============================================================================
|
|
59
|
+
# DASHBOARD & STATISTICS
|
|
60
|
+
# ============================================================================
|
|
61
|
+
|
|
62
|
+
# Enable dashboard auto-refresh (milliseconds)
|
|
63
|
+
DASHBOARD_REFRESH_INTERVAL=5000
|
|
64
|
+
|
|
65
|
+
# Max log entries to store in memory
|
|
66
|
+
MAX_LOG_ENTRIES=100
|
|
67
|
+
|
|
68
|
+
# ============================================================================
|
|
69
|
+
# DATABASE (Optional - for persistent storage)
|
|
70
|
+
# ============================================================================
|
|
71
|
+
# Without DATABASE_URL, stats/logs use in-memory storage (resets on restart)
|
|
72
|
+
|
|
73
|
+
# PostgreSQL connection string
|
|
74
|
+
# DATABASE_URL=postgresql://user:password@localhost:5432/xithead
|
|
75
|
+
|
|
76
|
+
# MySQL connection string (alternative)
|
|
77
|
+
# DATABASE_URL=mysql://user:password@localhost:3306/xithead
|
|
78
|
+
|
|
79
|
+
# ============================================================================
|
|
80
|
+
# CACHE & SESSIONS (Optional - Redis)
|
|
81
|
+
# ============================================================================
|
|
82
|
+
# Without REDIS_URL, caching uses in-memory storage
|
|
83
|
+
|
|
84
|
+
# Redis connection string
|
|
85
|
+
# REDIS_URL=redis://localhost:6379
|
|
86
|
+
|
|
87
|
+
# Redis TTL for cache entries (seconds)
|
|
88
|
+
# REDIS_TTL=3600
|
|
89
|
+
|
|
90
|
+
# ============================================================================
|
|
91
|
+
# MONITORING & LOGGING
|
|
92
|
+
# ============================================================================
|
|
93
|
+
|
|
94
|
+
# Enable debug logging (uses 'debug' package)
|
|
95
|
+
# DEBUG=xithead:*
|
|
96
|
+
|
|
97
|
+
# Sentry error tracking (optional)
|
|
98
|
+
# SENTRY_DSN=https://xxxxx@sentry.io/project-id
|
|
99
|
+
|
|
100
|
+
# Log level: error | warn | info | debug | trace
|
|
101
|
+
# LOG_LEVEL=info
|
|
102
|
+
|
|
103
|
+
# ============================================================================
|
|
104
|
+
# AUTHENTICATION (Optional - for API access control)
|
|
105
|
+
# ============================================================================
|
|
106
|
+
|
|
107
|
+
# API Key for dashboard access (if authentication is enabled)
|
|
108
|
+
# XITHEAD_API_KEY=your-secret-api-key-here
|
|
109
|
+
|
|
110
|
+
# JWT Secret for sessions (if using JWT)
|
|
111
|
+
# JWT_SECRET=your-jwt-secret-key-here
|
|
112
|
+
|
|
113
|
+
# ============================================================================
|
|
114
|
+
# GITHUB & CI/CD INTEGRATION
|
|
115
|
+
# ============================================================================
|
|
116
|
+
# These are GitHub Actions Secrets - set them in GitHub Settings โ Secrets
|
|
117
|
+
# Do NOT add them to .env files
|
|
118
|
+
|
|
119
|
+
# GitHub token for Actions workflows
|
|
120
|
+
# GITHUB_TOKEN=ghp_xxxxxxxxxxxxxxxxxxxxx
|
|
121
|
+
|
|
122
|
+
# ============================================================================
|
|
123
|
+
# npm PUBLISHING (GitHub Actions)
|
|
124
|
+
# ============================================================================
|
|
125
|
+
# Set in GitHub Settings โ Secrets, NOT in .env
|
|
126
|
+
|
|
127
|
+
# npm automation token (https://docs.npmjs.com/creating-and-viewing-access-tokens)
|
|
128
|
+
# XITHEAD_NPM_TOKEN=npm_xxxxxxxxxxxxxxxxxxxxx
|
|
129
|
+
|
|
130
|
+
# ============================================================================
|
|
131
|
+
# FEATURE FLAGS (Optional)
|
|
132
|
+
# ============================================================================
|
|
133
|
+
|
|
134
|
+
# Enable/disable features
|
|
135
|
+
# ENABLE_STATISTICS=true
|
|
136
|
+
# ENABLE_ACTIVITY_LOG=true
|
|
137
|
+
# ENABLE_EXPORT=true
|
|
138
|
+
|
|
139
|
+
# ============================================================================
|
|
140
|
+
# CORS & SECURITY (Optional)
|
|
141
|
+
# ============================================================================
|
|
142
|
+
|
|
143
|
+
# Allowed CORS origins (comma-separated)
|
|
144
|
+
# CORS_ORIGINS=https://xtream-head.com,https://localhost:8787
|
|
145
|
+
|
|
146
|
+
# Rate limiting (requests per minute)
|
|
147
|
+
# RATE_LIMIT_REQUESTS=100
|
|
148
|
+
|
|
149
|
+
# Session timeout (seconds)
|
|
150
|
+
# SESSION_TIMEOUT=3600
|
|
151
|
+
|
|
152
|
+
# ============================================================================
|
|
153
|
+
# PERFORMANCE & OPTIMIZATION
|
|
154
|
+
# ============================================================================
|
|
155
|
+
|
|
156
|
+
# Max request timeout (milliseconds)
|
|
157
|
+
# REQUEST_TIMEOUT=30000
|
|
158
|
+
|
|
159
|
+
# Enable response compression
|
|
160
|
+
# COMPRESSION=true
|
|
161
|
+
|
|
162
|
+
# ============================================================================
|
|
163
|
+
# DEVELOPMENT ONLY
|
|
164
|
+
# ============================================================================
|
|
165
|
+
# Only use these in development - never in production
|
|
166
|
+
|
|
167
|
+
# Enable source maps in production builds
|
|
168
|
+
# NEXT_RUNTIME_PRIVATE_SOURCEMAP=true
|
|
169
|
+
|
|
170
|
+
# Fast refresh for development
|
|
171
|
+
# NEXT_PUBLIC_DEV_FAST_REFRESH=true
|
package/.eslintrc.json
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
{
|
|
2
|
+
"extends": ["next/core-web-vitals"],
|
|
3
|
+
"parser": "@typescript-eslint/parser",
|
|
4
|
+
"parserOptions": {
|
|
5
|
+
"ecmaVersion": "latest",
|
|
6
|
+
"sourceType": "module",
|
|
7
|
+
"ecmaFeatures": {
|
|
8
|
+
"jsx": true
|
|
9
|
+
}
|
|
10
|
+
},
|
|
11
|
+
"plugins": ["@typescript-eslint"],
|
|
12
|
+
"ignorePatterns": [".next/", "dist/", "node_modules/", "nextjs/", "sdk/", "plugins/"],
|
|
13
|
+
"rules": {
|
|
14
|
+
"@next/next/no-html-link-for-pages": "off"
|
|
15
|
+
}
|
|
16
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Revisions listed here are skipped by `git blame --ignore-revs-file`
|
|
2
|
+
# and by GitHub's blame UI. Use for mechanical, repo-wide changes that
|
|
3
|
+
# touch every line of a file but don't change semantics (formatter runs,
|
|
4
|
+
# line-ending normalization, bulk renames applied by codemod, etc.).
|
|
5
|
+
#
|
|
6
|
+
# Configure your local git to auto-pick this up:
|
|
7
|
+
# git config blame.ignoreRevsFile .git-blame-ignore-revs
|
|
8
|
+
|
|
9
|
+
# chore: renormalize line endings to LF
|
|
10
|
+
efd2ac1ca4d88d8f5990259c98b673c603902896
|
package/.gitattributes
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# GitGuardian configuration โ secret-detection allowlist
|
|
2
|
+
#
|
|
3
|
+
# Two entries below are test fixtures, NOT real credentials. They live in
|
|
4
|
+
# tests that exercise our own detectors (volatile-content scanner, auth-mode
|
|
5
|
+
# classifier) โ by definition we have to embed plausible-looking tokens to
|
|
6
|
+
# verify the detectors recognise them. The strings are syntactically valid
|
|
7
|
+
# but carry no privilege against any real service.
|
|
8
|
+
#
|
|
9
|
+
# Anything else GitGuardian flags should be treated as a real incident: do
|
|
10
|
+
# NOT extend this allowlist without verifying the secret is unauthenticated
|
|
11
|
+
# fixture data, and rotate any genuine leaks before adding the row.
|
|
12
|
+
|
|
13
|
+
version: 2
|
|
14
|
+
|
|
15
|
+
secret:
|
|
16
|
+
ignored-matches:
|
|
17
|
+
# Canonical fake JWT used across the JS/Python ecosystem to demonstrate
|
|
18
|
+
# JWT-shaped strings. Header `{"alg":"HS256"}`, payload `{"sub":"1"}`.
|
|
19
|
+
# We use it to verify our `detect_volatile_content` recogniser flags JWTs.
|
|
20
|
+
# File: tests/test_cache_aligner_detector_only.py
|
|
21
|
+
- name: "fake JWT in volatile-content detector test"
|
|
22
|
+
match: "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIn0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
|
|
23
|
+
|
|
24
|
+
# Anthropic-shaped strings whose payloads literally contain the word
|
|
25
|
+
# "fixture" โ used in `test_realignment_live_multi_turn` to assert the
|
|
26
|
+
# auth-mode classifier routes PAYG / OAuth / subscription headers
|
|
27
|
+
# correctly. No live API call is ever made with these tokens.
|
|
28
|
+
# File: tests/test_realignment_live_multi_turn.py
|
|
29
|
+
- name: "Anthropic-shaped fixture token (PAYG via x-api-key)"
|
|
30
|
+
match: "sk-ant-api03-payg-fixture"
|
|
31
|
+
- name: "Anthropic-shaped fixture token (OAuth bearer)"
|
|
32
|
+
match: "sk-ant-oat01-oauth-fixture"
|
|
33
|
+
- name: "Anthropic-shaped fixture token (PAYG via bearer)"
|
|
34
|
+
match: "sk-ant-api03-payg-bearer-fixture"
|
|
35
|
+
|
|
36
|
+
# Minimal GitHub-shaped tokens used in tests/test_copilot_auth.py to
|
|
37
|
+
# exercise _token_kind() prefix detection and _is_copilot_api_token().
|
|
38
|
+
# Values are intentionally short/low-entropy โ they carry no privilege.
|
|
39
|
+
- name: "GitHub OAuth token fixture (test_copilot_auth)"
|
|
40
|
+
match: "gho_x"
|
|
41
|
+
- name: "GitHub Apps token fixture (test_copilot_auth)"
|
|
42
|
+
match: "ghs_x"
|
|
43
|
+
- name: "GitHub PAT fixture (test_copilot_auth)"
|
|
44
|
+
match: "ghp_x"
|
|
45
|
+
- name: "GitHub fine-grained PAT fixture (test_copilot_auth)"
|
|
46
|
+
match: "github_pat_x"
|
|
47
|
+
- name: "Copilot session token fixture (test_copilot_auth)"
|
|
48
|
+
match: "tid_x"
|
|
49
|
+
- name: "GitHub OAuth token fixture for exchange_token test"
|
|
50
|
+
match: "gho_test"
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
repos:
|
|
2
|
+
- repo: local
|
|
3
|
+
hooks:
|
|
4
|
+
- id: sync-plugin-versions
|
|
5
|
+
name: Sync plugin versions
|
|
6
|
+
entry: python3 scripts/sync-plugin-versions.py
|
|
7
|
+
language: system
|
|
8
|
+
pass_filenames: false
|
|
9
|
+
always_run: true
|
|
10
|
+
- id: commitlint
|
|
11
|
+
name: Commitlint
|
|
12
|
+
entry: bash -lc 'npx --yes --package=@commitlint/cli --package=@commitlint/config-conventional -- commitlint --edit "$1" --config .commitlintrc.json' --
|
|
13
|
+
language: system
|
|
14
|
+
stages: [commit-msg]
|
|
15
|
+
- repo: https://github.com/astral-sh/ruff-pre-commit
|
|
16
|
+
rev: v0.9.4
|
|
17
|
+
hooks:
|
|
18
|
+
- id: ruff
|
|
19
|
+
args: [--fix]
|
|
20
|
+
exclude: ^experiments/
|
|
21
|
+
- id: ruff-format
|
|
22
|
+
exclude: ^experiments/
|
|
23
|
+
- repo: https://github.com/pre-commit/mirrors-mypy
|
|
24
|
+
rev: v1.14.1
|
|
25
|
+
hooks:
|
|
26
|
+
- id: mypy
|
|
27
|
+
args: [--ignore-missing-imports]
|
|
28
|
+
exclude: ^experiments/
|
|
29
|
+
pass_filenames: false
|
|
30
|
+
entry: mypy headroom
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json",
|
|
3
|
+
"release-type": "simple",
|
|
4
|
+
"packages": {
|
|
5
|
+
".": {
|
|
6
|
+
"release-type": "simple",
|
|
7
|
+
"package-name": "xtream-head",
|
|
8
|
+
"version-file": "xithead/_version.py",
|
|
9
|
+
"changelog-path": "CHANGELOG-xithead.md",
|
|
10
|
+
"tag-prefix": "xtream-head-v",
|
|
11
|
+
"bump-minor-pre-major": true,
|
|
12
|
+
"bump-patch-for-minor-pre-major": true,
|
|
13
|
+
"extra-files": [
|
|
14
|
+
{
|
|
15
|
+
"type": "json",
|
|
16
|
+
"path": "package.json",
|
|
17
|
+
"jsonpath": "$.version"
|
|
18
|
+
}
|
|
19
|
+
]
|
|
20
|
+
}
|
|
21
|
+
}
|
|
22
|
+
}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json",
|
|
3
|
+
"release-type": "python",
|
|
4
|
+
"include-v-in-tag": true,
|
|
5
|
+
"include-component-in-tag": false,
|
|
6
|
+
"bump-minor-pre-major": true,
|
|
7
|
+
"bump-patch-for-minor-pre-major": false,
|
|
8
|
+
"draft": false,
|
|
9
|
+
"prerelease": false,
|
|
10
|
+
"separate-pull-requests": false,
|
|
11
|
+
"pull-request-title-pattern": "chore: release ${version}",
|
|
12
|
+
"packages": {
|
|
13
|
+
".": {
|
|
14
|
+
"package-name": "xtream-head",
|
|
15
|
+
"release-type": "python",
|
|
16
|
+
"extra-files": [
|
|
17
|
+
{
|
|
18
|
+
"type": "json",
|
|
19
|
+
"path": "sdk/typescript/package.json",
|
|
20
|
+
"jsonpath": "$.version"
|
|
21
|
+
},
|
|
22
|
+
{
|
|
23
|
+
"type": "json",
|
|
24
|
+
"path": "plugins/openclaw/package.json",
|
|
25
|
+
"jsonpath": "$.version"
|
|
26
|
+
}
|
|
27
|
+
]
|
|
28
|
+
}
|
|
29
|
+
},
|
|
30
|
+
"changelog-sections": [
|
|
31
|
+
{ "type": "feat", "section": "Features" },
|
|
32
|
+
{ "type": "fix", "section": "Bug Fixes" },
|
|
33
|
+
{ "type": "perf", "section": "Performance Improvements" },
|
|
34
|
+
{ "type": "deps", "section": "Dependencies" },
|
|
35
|
+
{ "type": "revert", "section": "Reverts" },
|
|
36
|
+
{ "type": "refactor", "section": "Code Refactoring" },
|
|
37
|
+
{ "type": "ci", "section": "Continuous Integration", "hidden": true },
|
|
38
|
+
{ "type": "build", "section": "Build System", "hidden": true },
|
|
39
|
+
{ "type": "chore", "section": "Miscellaneous Chores", "hidden": true },
|
|
40
|
+
{ "type": "docs", "section": "Documentation", "hidden": true },
|
|
41
|
+
{ "type": "style", "section": "Styles", "hidden": true },
|
|
42
|
+
{ "type": "test", "section": "Tests", "hidden": true }
|
|
43
|
+
]
|
|
44
|
+
}
|
|
@@ -0,0 +1,133 @@
|
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
|
2
|
+
|
|
3
|
+
## Our Pledge
|
|
4
|
+
|
|
5
|
+
We as members, contributors, and leaders pledge to make participation in our
|
|
6
|
+
community a harassment-free experience for everyone, regardless of age, body
|
|
7
|
+
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
|
8
|
+
identity and expression, level of experience, education, socio-economic status,
|
|
9
|
+
nationality, personal appearance, race, caste, color, religion, or sexual
|
|
10
|
+
identity and orientation.
|
|
11
|
+
|
|
12
|
+
We pledge to act and interact in ways that contribute to an open, welcoming,
|
|
13
|
+
diverse, inclusive, and healthy community.
|
|
14
|
+
|
|
15
|
+
## Our Standards
|
|
16
|
+
|
|
17
|
+
Examples of behavior that contributes to a positive environment for our
|
|
18
|
+
community include:
|
|
19
|
+
|
|
20
|
+
* Demonstrating empathy and kindness toward other people
|
|
21
|
+
* Being respectful of differing opinions, viewpoints, and experiences
|
|
22
|
+
* Giving and gracefully accepting constructive feedback
|
|
23
|
+
* Accepting responsibility and apologizing to those affected by our mistakes,
|
|
24
|
+
and learning from the experience
|
|
25
|
+
* Focusing on what is best not just for us as individuals, but for the overall
|
|
26
|
+
community
|
|
27
|
+
|
|
28
|
+
Examples of unacceptable behavior include:
|
|
29
|
+
|
|
30
|
+
* The use of sexualized language or imagery, and sexual attention or advances of
|
|
31
|
+
any kind
|
|
32
|
+
* Trolling, insulting or derogatory comments, and personal or political attacks
|
|
33
|
+
* Public or private harassment
|
|
34
|
+
* Publishing others' private information, such as a physical or email address,
|
|
35
|
+
without their explicit permission
|
|
36
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
|
37
|
+
professional setting
|
|
38
|
+
|
|
39
|
+
## Enforcement Responsibilities
|
|
40
|
+
|
|
41
|
+
Community leaders are responsible for clarifying and enforcing our standards of
|
|
42
|
+
acceptable behavior and will take appropriate and fair corrective action in
|
|
43
|
+
response to any behavior that they deem inappropriate, threatening, offensive,
|
|
44
|
+
or harmful.
|
|
45
|
+
|
|
46
|
+
Community leaders have the right and responsibility to remove, edit, or reject
|
|
47
|
+
comments, commits, code, wiki edits, issues, and other contributions that are
|
|
48
|
+
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
|
49
|
+
decisions when appropriate.
|
|
50
|
+
|
|
51
|
+
## Scope
|
|
52
|
+
|
|
53
|
+
This Code of Conduct applies within all community spaces, and also applies when
|
|
54
|
+
an individual is officially representing the community in public spaces.
|
|
55
|
+
Examples of representing our community include using an official email address,
|
|
56
|
+
posting via an official social media account, or acting as an appointed
|
|
57
|
+
representative at an online or offline event.
|
|
58
|
+
|
|
59
|
+
## Enforcement
|
|
60
|
+
|
|
61
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
62
|
+
reported to the community leaders responsible for enforcement at
|
|
63
|
+
**conduct@headroom.dev**.
|
|
64
|
+
|
|
65
|
+
All complaints will be reviewed and investigated promptly and fairly.
|
|
66
|
+
|
|
67
|
+
All community leaders are obligated to respect the privacy and security of the
|
|
68
|
+
reporter of any incident.
|
|
69
|
+
|
|
70
|
+
## Enforcement Guidelines
|
|
71
|
+
|
|
72
|
+
Community leaders will follow these Community Impact Guidelines in determining
|
|
73
|
+
the consequences for any action they deem in violation of this Code of Conduct:
|
|
74
|
+
|
|
75
|
+
### 1. Correction
|
|
76
|
+
|
|
77
|
+
**Community Impact**: Use of inappropriate language or other behavior deemed
|
|
78
|
+
unprofessional or unwelcome in the community.
|
|
79
|
+
|
|
80
|
+
**Consequence**: A private, written warning from community leaders, providing
|
|
81
|
+
clarity around the nature of the violation and an explanation of why the
|
|
82
|
+
behavior was inappropriate. A public apology may be requested.
|
|
83
|
+
|
|
84
|
+
### 2. Warning
|
|
85
|
+
|
|
86
|
+
**Community Impact**: A violation through a single incident or series of
|
|
87
|
+
actions.
|
|
88
|
+
|
|
89
|
+
**Consequence**: A warning with consequences for continued behavior. No
|
|
90
|
+
interaction with the people involved, including unsolicited interaction with
|
|
91
|
+
those enforcing the Code of Conduct, for a specified period of time. This
|
|
92
|
+
includes avoiding interactions in community spaces as well as external channels
|
|
93
|
+
like social media. Violating these terms may lead to a temporary or permanent
|
|
94
|
+
ban.
|
|
95
|
+
|
|
96
|
+
### 3. Temporary Ban
|
|
97
|
+
|
|
98
|
+
**Community Impact**: A serious violation of community standards, including
|
|
99
|
+
sustained inappropriate behavior.
|
|
100
|
+
|
|
101
|
+
**Consequence**: A temporary ban from any sort of interaction or public
|
|
102
|
+
communication with the community for a specified period of time. No public or
|
|
103
|
+
private interaction with the people involved, including unsolicited interaction
|
|
104
|
+
with those enforcing the Code of Conduct, is allowed during this period.
|
|
105
|
+
Violating these terms may lead to a permanent ban.
|
|
106
|
+
|
|
107
|
+
### 4. Permanent Ban
|
|
108
|
+
|
|
109
|
+
**Community Impact**: Demonstrating a pattern of violation of community
|
|
110
|
+
standards, including sustained inappropriate behavior, harassment of an
|
|
111
|
+
individual, or aggression toward or disparagement of classes of individuals.
|
|
112
|
+
|
|
113
|
+
**Consequence**: A permanent ban from any sort of public interaction within the
|
|
114
|
+
community.
|
|
115
|
+
|
|
116
|
+
## Attribution
|
|
117
|
+
|
|
118
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
|
119
|
+
version 2.1, available at
|
|
120
|
+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
|
|
121
|
+
|
|
122
|
+
Community Impact Guidelines were inspired by
|
|
123
|
+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
|
|
124
|
+
|
|
125
|
+
For answers to common questions about this code of conduct, see the FAQ at
|
|
126
|
+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
|
|
127
|
+
[https://www.contributor-covenant.org/translations][translations].
|
|
128
|
+
|
|
129
|
+
[homepage]: https://www.contributor-covenant.org
|
|
130
|
+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
|
131
|
+
[Mozilla CoC]: https://github.com/mozilla/diversity
|
|
132
|
+
[FAQ]: https://www.contributor-covenant.org/faq
|
|
133
|
+
[translations]: https://www.contributor-covenant.org/translations
|
package/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,133 @@
|
|
|
1
|
+
# Contributing to Headroom
|
|
2
|
+
|
|
3
|
+
Thanks for contributing! Please skim this before opening a PR : the policies exist because we've been burned skipping them, not because we love paperwork.
|
|
4
|
+
|
|
5
|
+
By participating, you agree to our [Code of Conduct](CODE_OF_CONDUCT.md).
|
|
6
|
+
|
|
7
|
+
## Where does my contribution go?
|
|
8
|
+
|
|
9
|
+
| Type | What to do |
|
|
10
|
+
| --- | --- |
|
|
11
|
+
| ๐ Bug or small fix | **Open a PR** (with repro + test) |
|
|
12
|
+
| โจ New feature / architectural change | **Open an issue or ask in Discord first.** |
|
|
13
|
+
| ๐งน Refactor-only | **Don't.** Only if a maintainer asked, as part of a concrete fix. |
|
|
14
|
+
| ๐งช Test/CI-only PR chasing a known `main` failure | **Don't.** We're tracking it. |
|
|
15
|
+
| ๐ฆ New dep or version bump | **PR with written justification.** |
|
|
16
|
+
| โ Question | **Discord `#help` |
|
|
17
|
+
|
|
18
|
+
**Open PR cap: 10 per author.** Get existing ones merged before opening more.
|
|
19
|
+
|
|
20
|
+
## Guiding principles
|
|
21
|
+
|
|
22
|
+
- **Verification is the author's job, not the reviewer's.**
|
|
23
|
+
- **Supply chain is a real threat.** Dependency changes get human review, every time.
|
|
24
|
+
|
|
25
|
+
## Bug fixes
|
|
26
|
+
|
|
27
|
+
Every bug-fix PR must include:
|
|
28
|
+
|
|
29
|
+
1. **A reproduction** โ minimal code, failing test, or steps.
|
|
30
|
+
2. **A test that fails before your fix and passes after** (unit, integration, or e2e).
|
|
31
|
+
|
|
32
|
+
If you genuinely can't write a test, say so explicitly and explain how you verified.
|
|
33
|
+
|
|
34
|
+
## "Real behavior proof" โ required on every external PR
|
|
35
|
+
|
|
36
|
+
We can't merge what we can't verify. Include a **`Real behavior proof`** section in the PR body covering:
|
|
37
|
+
|
|
38
|
+
- **Setup you tested on** (OS, Python, config, provider/model)
|
|
39
|
+
- **Exact command or steps you ran after the patch**
|
|
40
|
+
- **After-fix evidence** + **observed result**
|
|
41
|
+
- **What you did *not* test**
|
|
42
|
+
|
|
43
|
+
โ
Counts: screenshots, recordings, terminal output, copied live output, linked artifacts, redacted runtime logs.
|
|
44
|
+
โ Does **not** count alone: unit tests, mocks, snapshots, lint, typechecks, green CI. Have them too โ but they prove the test passes, not that the feature works.
|
|
45
|
+
|
|
46
|
+
**PRs missing this may be autoclosed.**
|
|
47
|
+
|
|
48
|
+
## New features
|
|
49
|
+
|
|
50
|
+
Before writing code:
|
|
51
|
+
|
|
52
|
+
1. **Open a feature-request issue** (or raise in Discord).
|
|
53
|
+
2. **Get a ๐ from a core maintainer** before implementing.
|
|
54
|
+
3. **Include a short spec** covering:
|
|
55
|
+
- **API surface** (public functions, config, CLI flags)
|
|
56
|
+
- **Changes to existing behavior**
|
|
57
|
+
- **User stories** โ Given / When / Then, golden path + one edge case
|
|
58
|
+
- **Failure modes**
|
|
59
|
+
- **Recovery / resilience**
|
|
60
|
+
- **Security considerations**
|
|
61
|
+
|
|
62
|
+
Short and concrete beats long.
|
|
63
|
+
|
|
64
|
+
## Dependencies & supply chain
|
|
65
|
+
|
|
66
|
+
A human maintainer reviews every dep change. PRs that add or bump a package must justify:
|
|
67
|
+
|
|
68
|
+
- **Why this package** (vs. doing it ourselves / using existing deps)
|
|
69
|
+
- **Who maintains it** (activity, release cadence, security history)
|
|
70
|
+
- **Install surface** (transitive deps, native code, install/runtime network)
|
|
71
|
+
- **Why this version** โ permitted reasons: **bug fix**, **security patch**, **required new functionality**. Cosmetic bumps will be closed.
|
|
72
|
+
|
|
73
|
+
## PR workflow
|
|
74
|
+
|
|
75
|
+
1. Fork, branch from `main`.
|
|
76
|
+
2. Install **Node 18+** and run `uv sync --extra dev` then `make install-git-hooks` โ installs repo pre-commit checks on every commit, commitlint on every commit message, and ci-precheck on every push.
|
|
77
|
+
3. One logical change per PR.
|
|
78
|
+
4. Add tests.
|
|
79
|
+
5. `uv run pytest` ยท `uv run ruff check .` ยท `uv run ruff format .`
|
|
80
|
+
6. Update `CHANGELOG.md` for user-facing changes.
|
|
81
|
+
7. Open the PR with a clear description + `Real behavior proof` + any spec/justification required, and keep the PR in draft until the `Review Readiness` boxes are complete.
|
|
82
|
+
|
|
83
|
+
**Title format** (conventional commits): `feat:`, `fix:`, `docs:`, `test:`, `refactor:`.
|
|
84
|
+
|
|
85
|
+
**Commit message format** is enforced locally by the repo's `commit-msg` hook and again in CI.
|
|
86
|
+
|
|
87
|
+
**Review:** CI green, one maintainer review, coverage held/improved.
|
|
88
|
+
|
|
89
|
+
## Development setup
|
|
90
|
+
|
|
91
|
+
```bash
|
|
92
|
+
git clone https://github.com/Xtream-ITSolutions/xithead.git
|
|
93
|
+
cd headroom
|
|
94
|
+
python -m venv .venv && source .venv/bin/activate
|
|
95
|
+
node --version # Node 18+ required for commitlint hooks
|
|
96
|
+
python -m pip install --upgrade pip
|
|
97
|
+
python -m pip install -e ".[dev,relevance,proxy]"
|
|
98
|
+
python -m pytest
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
Headroom uses a `pyproject.toml`/`maturin` build backend. Older `pip`
|
|
102
|
+
versions may fail editable installs by looking for `setup.py`; upgrade `pip`
|
|
103
|
+
first or use `uv sync --extra dev`.
|
|
104
|
+
|
|
105
|
+
### Dev Containers
|
|
106
|
+
|
|
107
|
+
Two configs ship for VS Code / Codespaces:
|
|
108
|
+
|
|
109
|
+
- **`.devcontainer/devcontainer.json`** โ Python 3.12, `uv`, Node.js, `gh`.
|
|
110
|
+
- **`.devcontainer/memory-stack/devcontainer.json`** โ adds Qdrant + Neo4j sidecars (use `qdrant:6333`, `neo4j://neo4j:7687`).
|
|
111
|
+
|
|
112
|
+
Inside, use: `uv run ruff check .`, `uv run pytest`, etc.
|
|
113
|
+
|
|
114
|
+
## Optional automated review
|
|
115
|
+
|
|
116
|
+
This repository includes `.github/copilot-instructions.md` so maintainers can opt into GitHub Copilot code review without adding workflow billing noise to every PR.
|
|
117
|
+
|
|
118
|
+
Enable or disable automatic Copilot review in **Settings โ Rules โ Rulesets โ Automatically request Copilot code review**. Keep it off unless maintainers explicitly want the extra review traffic.
|
|
119
|
+
|
|
120
|
+
## Coding standards
|
|
121
|
+
|
|
122
|
+
- [Ruff](https://github.com/astral-sh/ruff) for lint + format, line length 100, PEP 8.
|
|
123
|
+
- Type hints on public functions; Google-style docstrings.
|
|
124
|
+
- Cover new behavior + edge cases; aim >80% coverage on new code.
|
|
125
|
+
- Python 3.10+. Optional features go behind extras.
|
|
126
|
+
|
|
127
|
+
## Architecture principles
|
|
128
|
+
|
|
129
|
+
**Safety first:** never drop user/assistant content, never break tool call/response pairing, malformed content passes through unchanged, prefer false negatives.
|
|
130
|
+
|
|
131
|
+
**Performance:** transforms <50ms at P99, lazy-load optional deps, profile before optimizing.
|
|
132
|
+
|
|
133
|
+
Contributors are credited in `CHANGELOG`, the GitHub contributors page, and release notes. Thanks again. ๐
|