xithead 1.5.0 → 1.5.1
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/design-system/README.md +80 -0
- package/package.json +20 -1
- package/public/apple-touch-icon.png +0 -0
- package/public/logo-transparent.png +0 -0
- package/public/xithead.ps1 +937 -0
- package/scripts/README.md +77 -0
- package/scripts/audit_wheel_glibc_symbols.py +217 -0
- package/scripts/build-master-design-system.cjs +33 -0
- package/scripts/build_rust_extension.sh +58 -0
- package/scripts/changelog-gen.py +203 -0
- package/scripts/eval_output_shaper.py +235 -0
- package/scripts/export_kompress_v2_onnx.py +267 -0
- package/scripts/fixtures/anthropic_replay_body.json +133 -0
- package/scripts/fixtures/codex_response_create_frame.json +52 -0
- package/scripts/install-git-hooks.sh +104 -0
- package/scripts/install.ps1 +1809 -0
- package/scripts/install.sh +1673 -0
- package/scripts/pr-governance.py +297 -0
- package/scripts/record_fixtures.py +59 -0
- package/scripts/refresh_model_limits.sh +48 -0
- package/scripts/replay_codex_ws_load.py +445 -0
- package/scripts/repro_codex_replay.py +699 -0
- package/scripts/smoke_issue_327.py +233 -0
- package/scripts/sync-plugin-versions.py +116 -0
- package/scripts/tests/test_changelog_gen.py +302 -0
- package/scripts/tests/test_pr_governance.py +163 -0
- package/scripts/tests/test_pr_health_labels.py +94 -0
- package/scripts/tests/test_pr_health_workflow.py +14 -0
- package/scripts/tests/test_sync_plugin_versions.py +131 -0
- package/scripts/tests/test_version_sync.py +291 -0
- package/scripts/validate-workflows.sh +39 -0
- package/scripts/verify-versions.py +106 -0
- package/scripts/version-sync.py +207 -0
- package/tailwind.config.js +31 -0
- package/tsconfig.json +84 -0
- package/.actrc +0 -14
- package/.actrc.local.example +0 -15
- package/.changelog.md +0 -2
- package/.claude/agents/academic-anthropologist.md +0 -125
- package/.claude/agents/academic-geographer.md +0 -127
- package/.claude/agents/academic-historian.md +0 -123
- package/.claude/agents/academic-narratologist.md +0 -118
- package/.claude/agents/academic-psychologist.md +0 -118
- package/.claude/agents/academic-statistician.md +0 -144
- package/.claude/agents/accounts-payable-agent.md +0 -205
- package/.claude/agents/agentic-identity-trust.md +0 -394
- package/.claude/agents/agents-orchestrator.md +0 -367
- package/.claude/agents/automation-governance-architect.md +0 -216
- package/.claude/agents/blender-addon-engineer.md +0 -243
- package/.claude/agents/business-strategist.md +0 -488
- package/.claude/agents/change-management-consultant.md +0 -497
- package/.claude/agents/chief-financial-officer.md +0 -388
- package/.claude/agents/corporate-training-designer.md +0 -192
- package/.claude/agents/customer-service.md +0 -398
- package/.claude/agents/customer-success-manager.md +0 -460
- package/.claude/agents/data-consolidation-agent.md +0 -60
- package/.claude/agents/data-privacy-officer.md +0 -412
- package/.claude/agents/design-brand-guardian.md +0 -322
- package/.claude/agents/design-image-prompt-engineer.md +0 -236
- package/.claude/agents/design-inclusive-visuals-specialist.md +0 -73
- package/.claude/agents/design-persona-walkthrough.md +0 -272
- package/.claude/agents/design-ui-designer.md +0 -386
- package/.claude/agents/design-ui-finish-gate-reviewer.md +0 -217
- package/.claude/agents/design-ux-architect.md +0 -482
- package/.claude/agents/design-ux-researcher.md +0 -329
- package/.claude/agents/design-visual-storyteller.md +0 -149
- package/.claude/agents/design-whimsy-injector.md +0 -460
- package/.claude/agents/economy-designer.md +0 -156
- package/.claude/agents/engineering-ai-data-remediation-engineer.md +0 -211
- package/.claude/agents/engineering-ai-engineer.md +0 -146
- package/.claude/agents/engineering-api-platform-engineer.md +0 -181
- package/.claude/agents/engineering-ats-validator-architect.md +0 -383
- package/.claude/agents/engineering-autonomous-optimization-architect.md +0 -121
- package/.claude/agents/engineering-backend-architect.md +0 -255
- package/.claude/agents/engineering-china-network-engineer.md +0 -252
- package/.claude/agents/engineering-cms-developer.md +0 -536
- package/.claude/agents/engineering-code-reviewer.md +0 -76
- package/.claude/agents/engineering-codebase-onboarding-engineer.md +0 -173
- package/.claude/agents/engineering-data-engineer.md +0 -349
- package/.claude/agents/engineering-data-visualization-engineer.md +0 -151
- package/.claude/agents/engineering-database-optimizer.md +0 -188
- package/.claude/agents/engineering-database-reliability-engineer.md +0 -201
- package/.claude/agents/engineering-desktop-app-engineer.md +0 -209
- package/.claude/agents/engineering-developer-tooling-engineer.md +0 -153
- package/.claude/agents/engineering-devops-automator.md +0 -385
- package/.claude/agents/engineering-drupal-performance.md +0 -347
- package/.claude/agents/engineering-drupal-shopping-cart.md +0 -360
- package/.claude/agents/engineering-electrical-engineer.md +0 -575
- package/.claude/agents/engineering-email-intelligence-engineer.md +0 -390
- package/.claude/agents/engineering-embedded-firmware-engineer.md +0 -196
- package/.claude/agents/engineering-feishu-integration-developer.md +0 -606
- package/.claude/agents/engineering-filament-optimization-specialist.md +0 -283
- package/.claude/agents/engineering-finops-engineer.md +0 -164
- package/.claude/agents/engineering-frontend-developer.md +0 -257
- package/.claude/agents/engineering-gaussdb-expert.md +0 -334
- package/.claude/agents/engineering-git-workflow-master.md +0 -98
- package/.claude/agents/engineering-i18n-engineer.md +0 -214
- package/.claude/agents/engineering-identity-access-engineer.md +0 -217
- package/.claude/agents/engineering-incident-response-commander.md +0 -444
- package/.claude/agents/engineering-iot-fleet-engineer.md +0 -148
- package/.claude/agents/engineering-it-service-manager.md +0 -561
- package/.claude/agents/engineering-knowledge-graph-engineer.md +0 -372
- package/.claude/agents/engineering-llm-post-training-engineer.md +0 -166
- package/.claude/agents/engineering-minimal-change-engineer.md +0 -207
- package/.claude/agents/engineering-mobile-app-builder.md +0 -493
- package/.claude/agents/engineering-mobile-release-engineer.md +0 -164
- package/.claude/agents/engineering-multi-agent-systems-architect.md +0 -600
- package/.claude/agents/engineering-network-engineer.md +0 -245
- package/.claude/agents/engineering-orgscript-engineer.md +0 -113
- package/.claude/agents/engineering-payments-billing-engineer.md +0 -228
- package/.claude/agents/engineering-pdf-engine-architect.md +0 -696
- package/.claude/agents/engineering-platform-engineer.md +0 -270
- package/.claude/agents/engineering-privacy-engineer.md +0 -152
- package/.claude/agents/engineering-prompt-engineer.md +0 -209
- package/.claude/agents/engineering-rag-pipeline-engineer.md +0 -450
- package/.claude/agents/engineering-rapid-prototyper.md +0 -466
- package/.claude/agents/engineering-realtime-collaboration-engineer.md +0 -200
- package/.claude/agents/engineering-rust-refactoring-specialist.md +0 -313
- package/.claude/agents/engineering-search-relevance-engineer.md +0 -237
- package/.claude/agents/engineering-section-508-specialist.md +0 -339
- package/.claude/agents/engineering-senior-developer.md +0 -176
- package/.claude/agents/engineering-servicenow-developer-mentor.md +0 -180
- package/.claude/agents/engineering-software-architect.md +0 -112
- package/.claude/agents/engineering-solidity-smart-contract-engineer.md +0 -522
- package/.claude/agents/engineering-sre.md +0 -90
- package/.claude/agents/engineering-technical-writer.md +0 -393
- package/.claude/agents/engineering-universal-document-compiler.md +0 -370
- package/.claude/agents/engineering-uswds-developer.md +0 -340
- package/.claude/agents/engineering-video-streaming-engineer.md +0 -151
- package/.claude/agents/engineering-voice-ai-integration-engineer.md +0 -584
- package/.claude/agents/engineering-webassembly-engineer.md +0 -153
- package/.claude/agents/engineering-wechat-mini-program-developer.md +0 -356
- package/.claude/agents/engineering-wordpress-performance.md +0 -346
- package/.claude/agents/engineering-wordpress-shopping-cart.md +0 -346
- package/.claude/agents/esg-sustainability-officer.md +0 -396
- package/.claude/agents/finance-bookkeeper-controller.md +0 -260
- package/.claude/agents/finance-financial-analyst.md +0 -234
- package/.claude/agents/finance-fpa-analyst.md +0 -263
- package/.claude/agents/finance-investment-researcher.md +0 -272
- package/.claude/agents/finance-tax-strategist.md +0 -239
- package/.claude/agents/game-audio-engineer.md +0 -264
- package/.claude/agents/game-designer.md +0 -167
- package/.claude/agents/gis-3d-scene-developer.md +0 -111
- package/.claude/agents/gis-analyst.md +0 -91
- package/.claude/agents/gis-bim-specialist.md +0 -108
- package/.claude/agents/gis-cartography-designer.md +0 -150
- package/.claude/agents/gis-drone-reality-mapping.md +0 -120
- package/.claude/agents/gis-geoai-ml-engineer.md +0 -105
- package/.claude/agents/gis-geoprocessing-specialist.md +0 -97
- package/.claude/agents/gis-qa-engineer.md +0 -133
- package/.claude/agents/gis-solution-engineer.md +0 -101
- package/.claude/agents/gis-spatial-data-engineer.md +0 -97
- package/.claude/agents/gis-spatial-data-scientist.md +0 -111
- package/.claude/agents/gis-technical-consultant.md +0 -86
- package/.claude/agents/gis-web-gis-developer.md +0 -108
- package/.claude/agents/godot-gameplay-scripter.md +0 -338
- package/.claude/agents/godot-multiplayer-engineer.md +0 -301
- package/.claude/agents/godot-shader-developer.md +0 -267
- package/.claude/agents/government-digital-presales-consultant.md +0 -363
- package/.claude/agents/grant-writer.md +0 -511
- package/.claude/agents/healthcare-aging-parent-care-companion.md +0 -414
- package/.claude/agents/healthcare-clinical-evidence-agent.md +0 -231
- package/.claude/agents/healthcare-customer-service.md +0 -389
- package/.claude/agents/healthcare-innovation-strategist.md +0 -433
- package/.claude/agents/healthcare-marketing-compliance.md +0 -395
- package/.claude/agents/healthcare-sovereign-health-systems-agent.md +0 -312
- package/.claude/agents/hospitality-guest-services.md +0 -603
- package/.claude/agents/hr-onboarding.md +0 -451
- package/.claude/agents/identity-graph-operator.md +0 -303
- package/.claude/agents/language-translator.md +0 -264
- package/.claude/agents/legal-billing-time-tracking.md +0 -569
- package/.claude/agents/legal-client-intake.md +0 -492
- package/.claude/agents/legal-document-review.md +0 -454
- package/.claude/agents/level-designer.md +0 -208
- package/.claude/agents/loan-officer-assistant.md +0 -555
- package/.claude/agents/lsp-index-engineer.md +0 -320
- package/.claude/agents/ma-integration-manager.md +0 -427
- package/.claude/agents/macos-spatial-metal-engineer.md +0 -337
- package/.claude/agents/marketing-aeo-foundations.md +0 -264
- package/.claude/agents/marketing-agentic-search-optimizer.md +0 -279
- package/.claude/agents/marketing-ai-citation-strategist.md +0 -172
- package/.claude/agents/marketing-app-store-optimizer.md +0 -321
- package/.claude/agents/marketing-baidu-seo-specialist.md +0 -226
- package/.claude/agents/marketing-bilibili-content-strategist.md +0 -199
- package/.claude/agents/marketing-book-co-author.md +0 -110
- package/.claude/agents/marketing-carousel-growth-engine.md +0 -204
- package/.claude/agents/marketing-china-ecommerce-operator.md +0 -283
- package/.claude/agents/marketing-china-market-localization-strategist.md +0 -283
- package/.claude/agents/marketing-content-creator.md +0 -54
- package/.claude/agents/marketing-cross-border-ecommerce.md +0 -259
- package/.claude/agents/marketing-developer-community-builder.md +0 -285
- package/.claude/agents/marketing-douyin-strategist.md +0 -149
- package/.claude/agents/marketing-email-strategist.md +0 -249
- package/.claude/agents/marketing-global-podcast-strategist.md +0 -206
- package/.claude/agents/marketing-growth-hacker.md +0 -54
- package/.claude/agents/marketing-instagram-curator.md +0 -113
- package/.claude/agents/marketing-kuaishou-strategist.md +0 -223
- package/.claude/agents/marketing-linkedin-content-creator.md +0 -214
- package/.claude/agents/marketing-livestream-commerce-coach.md +0 -305
- package/.claude/agents/marketing-multi-platform-publisher.md +0 -217
- package/.claude/agents/marketing-podcast-strategist.md +0 -277
- package/.claude/agents/marketing-pr-communications-manager.md +0 -473
- package/.claude/agents/marketing-private-domain-operator.md +0 -308
- package/.claude/agents/marketing-reddit-community-builder.md +0 -123
- package/.claude/agents/marketing-seo-specialist.md +0 -370
- package/.claude/agents/marketing-short-video-editing-coach.md +0 -412
- package/.claude/agents/marketing-social-media-strategist.md +0 -125
- package/.claude/agents/marketing-tiktok-strategist.md +0 -125
- package/.claude/agents/marketing-twitter-engager.md +0 -126
- package/.claude/agents/marketing-video-optimization-specialist.md +0 -119
- package/.claude/agents/marketing-wechat-official-account.md +0 -145
- package/.claude/agents/marketing-weibo-strategist.md +0 -240
- package/.claude/agents/marketing-x-twitter-intelligence-analyst.md +0 -161
- package/.claude/agents/marketing-xiaohongshu-specialist.md +0 -138
- package/.claude/agents/marketing-zhihu-strategist.md +0 -162
- package/.claude/agents/medical-billing-coding-specialist.md +0 -491
- package/.claude/agents/narrative-designer.md +0 -243
- package/.claude/agents/operations-manager.md +0 -399
- package/.claude/agents/organizational-psychologist.md +0 -391
- package/.claude/agents/paid-media-auditor.md +0 -71
- package/.claude/agents/paid-media-creative-strategist.md +0 -71
- package/.claude/agents/paid-media-paid-social-strategist.md +0 -71
- package/.claude/agents/paid-media-ppc-strategist.md +0 -71
- package/.claude/agents/paid-media-programmatic-buyer.md +0 -71
- package/.claude/agents/paid-media-search-query-analyst.md +0 -71
- package/.claude/agents/paid-media-tracking-specialist.md +0 -71
- package/.claude/agents/personal-growth-mentor.md +0 -159
- package/.claude/agents/product-behavioral-nudge-engine.md +0 -83
- package/.claude/agents/product-dx-engineer.md +0 -332
- package/.claude/agents/product-feedback-synthesizer.md +0 -119
- package/.claude/agents/product-manager.md +0 -469
- package/.claude/agents/product-sprint-prioritizer.md +0 -154
- package/.claude/agents/product-trend-researcher.md +0 -159
- package/.claude/agents/project-management-experiment-tracker.md +0 -198
- package/.claude/agents/project-management-jira-workflow-steward.md +0 -233
- package/.claude/agents/project-management-meeting-notes-specialist.md +0 -95
- package/.claude/agents/project-management-project-shepherd.md +0 -194
- package/.claude/agents/project-management-studio-operations.md +0 -200
- package/.claude/agents/project-management-studio-producer.md +0 -203
- package/.claude/agents/project-manager-senior.md +0 -135
- package/.claude/agents/real-estate-buyer-seller.md +0 -596
- package/.claude/agents/recruitment-specialist.md +0 -515
- package/.claude/agents/report-distribution-agent.md +0 -65
- package/.claude/agents/research-synthesist.md +0 -136
- package/.claude/agents/resume-tailor.md +0 -230
- package/.claude/agents/retail-customer-returns.md +0 -566
- package/.claude/agents/roblox-avatar-creator.md +0 -297
- package/.claude/agents/roblox-experience-designer.md +0 -306
- package/.claude/agents/roblox-systems-scripter.md +0 -332
- package/.claude/agents/sales-account-strategist.md +0 -227
- package/.claude/agents/sales-coach.md +0 -271
- package/.claude/agents/sales-data-extraction-agent.md +0 -67
- package/.claude/agents/sales-deal-strategist.md +0 -180
- package/.claude/agents/sales-discovery-coach.md +0 -225
- package/.claude/agents/sales-engineer.md +0 -182
- package/.claude/agents/sales-offer-lead-gen-strategist.md +0 -257
- package/.claude/agents/sales-outbound-strategist.md +0 -201
- package/.claude/agents/sales-outreach.md +0 -425
- package/.claude/agents/sales-pipeline-analyst.md +0 -267
- package/.claude/agents/sales-proposal-strategist.md +0 -217
- package/.claude/agents/security-ai-generated-code-auditor.md +0 -207
- package/.claude/agents/security-appsec-engineer.md +0 -536
- package/.claude/agents/security-architect.md +0 -307
- package/.claude/agents/security-blockchain-security-auditor.md +0 -482
- package/.claude/agents/security-cloud-security-architect.md +0 -576
- package/.claude/agents/security-compliance-auditor.md +0 -158
- package/.claude/agents/security-incident-responder.md +0 -450
- package/.claude/agents/security-penetration-tester.md +0 -399
- package/.claude/agents/security-secrets-credential-engineer.md +0 -189
- package/.claude/agents/security-senior-secops.md +0 -760
- package/.claude/agents/security-threat-detection-engineer.md +0 -553
- package/.claude/agents/security-threat-intelligence-analyst.md +0 -661
- package/.claude/agents/specialized-chief-of-staff.md +0 -279
- package/.claude/agents/specialized-civil-engineer.md +0 -356
- package/.claude/agents/specialized-codebase-archaeologist.md +0 -341
- package/.claude/agents/specialized-cultural-intelligence-strategist.md +0 -88
- package/.claude/agents/specialized-developer-advocate.md +0 -317
- package/.claude/agents/specialized-document-generator.md +0 -55
- package/.claude/agents/specialized-fedramp-rmf-compliance.md +0 -378
- package/.claude/agents/specialized-focus-music-architect.md +0 -175
- package/.claude/agents/specialized-french-consulting-market.md +0 -194
- package/.claude/agents/specialized-korean-business-navigator.md +0 -216
- package/.claude/agents/specialized-master-plan-architect.md +0 -157
- package/.claude/agents/specialized-mcp-builder.md +0 -260
- package/.claude/agents/specialized-model-qa.md +0 -528
- package/.claude/agents/specialized-pricing-analyst.md +0 -243
- package/.claude/agents/specialized-salesforce-architect.md +0 -182
- package/.claude/agents/specialized-strategy-duel-agent.md +0 -130
- package/.claude/agents/specialized-workflow-architect.md +0 -597
- package/.claude/agents/study-abroad-advisor.md +0 -282
- package/.claude/agents/supply-chain-strategist.md +0 -591
- package/.claude/agents/support-analytics-reporter.md +0 -387
- package/.claude/agents/support-executive-summary-generator.md +0 -212
- package/.claude/agents/support-finance-tracker.md +0 -480
- package/.claude/agents/support-infrastructure-maintainer.md +0 -628
- package/.claude/agents/support-legal-compliance-checker.md +0 -591
- package/.claude/agents/support-support-responder.md +0 -607
- package/.claude/agents/technical-artist.md +0 -233
- package/.claude/agents/terminal-integration-specialist.md +0 -70
- package/.claude/agents/testing-accessibility-auditor.md +0 -327
- package/.claude/agents/testing-api-tester.md +0 -334
- package/.claude/agents/testing-evidence-collector.md +0 -210
- package/.claude/agents/testing-performance-benchmarker.md +0 -283
- package/.claude/agents/testing-reality-checker.md +0 -249
- package/.claude/agents/testing-test-automation-engineer.md +0 -196
- package/.claude/agents/testing-test-results-analyzer.md +0 -330
- package/.claude/agents/testing-tool-evaluator.md +0 -416
- package/.claude/agents/testing-workflow-optimizer.md +0 -463
- package/.claude/agents/unity-architect.md +0 -271
- package/.claude/agents/unity-editor-tool-developer.md +0 -310
- package/.claude/agents/unity-multiplayer-engineer.md +0 -323
- package/.claude/agents/unity-shader-graph-artist.md +0 -269
- package/.claude/agents/unreal-multiplayer-architect.md +0 -364
- package/.claude/agents/unreal-systems-engineer.md +0 -322
- package/.claude/agents/unreal-technical-artist.md +0 -256
- package/.claude/agents/unreal-world-builder.md +0 -273
- package/.claude/agents/visionos-spatial-engineer.md +0 -54
- package/.claude/agents/xr-cockpit-interaction-specialist.md +0 -32
- package/.claude/agents/xr-immersive-developer.md +0 -32
- package/.claude/agents/xr-interface-architect.md +0 -32
- package/.claude/agents/zk-steward.md +0 -211
- package/.claude-plugin/marketplace.json +0 -30
- package/.commitlintrc.json +0 -26
- package/.devcontainer/Dockerfile +0 -24
- package/.devcontainer/devcontainer.json +0 -70
- package/.devcontainer/docker-compose.memory.yml +0 -42
- package/.devcontainer/memory-stack/devcontainer.json +0 -84
- package/.devcontainer/post-create.sh +0 -83
- package/.dockerignore +0 -23
- package/.env.act.example +0 -15
- package/.env.example +0 -171
- package/.eslintrc.json +0 -16
- package/.git-blame-ignore-revs +0 -10
- package/.gitattributes +0 -2
- package/.gitguardian.yaml +0 -50
- package/.githooks/pre-commit +0 -6
- package/.pre-commit-config.yaml +0 -30
- package/.release-please-config-xithead.json +0 -22
- package/.release-please-config.json +0 -44
- package/.release-please-manifest-xithead.json +0 -3
- package/.release-please-manifest.json +0 -3
- package/CODE_OF_CONDUCT.md +0 -133
- package/CONTRIBUTING.md +0 -133
- package/Cargo.lock +0 -5557
- package/Cargo.toml +0 -121
- package/Dockerfile +0 -38
- package/Dockerfile.proxy +0 -48
- package/ENTERPRISE.md +0 -5
- package/FEATURES_ADVANCED.md +0 -311
- package/Headroom-2.gif +0 -0
- package/HeadroomDemo-Fast.gif +0 -0
- package/MANIFEST.in +0 -4
- package/MODERNIZATION_GUIDE.md +0 -358
- package/Makefile +0 -140
- package/NOTICE +0 -43
- package/NPM_TOKEN_SETUP.md +0 -81
- package/PR.md +0 -170
- package/PUBLISH.md +0 -77
- package/README_FRONTEND.md +0 -196
- package/REALIGNMENT/00-overview.md +0 -53
- package/REALIGNMENT/01-bug-list.md +0 -421
- package/REALIGNMENT/02-architecture.md +0 -322
- package/REALIGNMENT/03-phase-A-lockdown.md +0 -420
- package/REALIGNMENT/04-phase-B-live-zone.md +0 -470
- package/REALIGNMENT/05-phase-C-rust-proxy.md +0 -329
- package/REALIGNMENT/06-phase-D-bedrock-vertex.md +0 -222
- package/REALIGNMENT/07-phase-E-cache-stabilization.md +0 -338
- package/REALIGNMENT/08-phase-F-auth-mode.md +0 -254
- package/REALIGNMENT/09-phase-G-rtk-observability.md +0 -194
- package/REALIGNMENT/10-phase-H-python-retirement.md +0 -214
- package/REALIGNMENT/11-phase-I-test-infra.md +0 -385
- package/REALIGNMENT/12-decisions-needed.md +0 -196
- package/REALIGNMENT/INDEX.md +0 -82
- package/REFACTORING_CAMPAIGN.md +0 -277
- package/RESTRUCTURE_PLAN.md +0 -100
- package/RUST_DEV.md +0 -361
- package/SECURITY.md +0 -65
- package/SETUP_AUTO_PUBLISH.md +0 -164
- package/TESTING-copilot-subscription.md +0 -153
- package/codecov.yml +0 -34
- package/crates/headroom-core/Cargo.toml +0 -165
- package/crates/headroom-core/benches/auth_mode.rs +0 -74
- package/crates/headroom-core/benches/ccr_store.rs +0 -224
- package/crates/headroom-core/benches/tokenizer.rs +0 -52
- package/crates/headroom-core/config/pipeline.toml +0 -151
- package/crates/headroom-core/proptest-regressions/transforms/tag_protector.txt +0 -9
- package/crates/headroom-core/src/auth_mode.rs +0 -250
- package/crates/headroom-core/src/cache_control.rs +0 -414
- package/crates/headroom-core/src/ccr/backends/in_memory.rs +0 -317
- package/crates/headroom-core/src/ccr/backends/mod.rs +0 -152
- package/crates/headroom-core/src/ccr/backends/redis.rs +0 -146
- package/crates/headroom-core/src/ccr/backends/sqlite.rs +0 -205
- package/crates/headroom-core/src/ccr/mod.rs +0 -119
- package/crates/headroom-core/src/compression_policy.rs +0 -505
- package/crates/headroom-core/src/lib.rs +0 -33
- package/crates/headroom-core/src/relevance/base.rs +0 -139
- package/crates/headroom-core/src/relevance/bm25.rs +0 -385
- package/crates/headroom-core/src/relevance/embedding.rs +0 -354
- package/crates/headroom-core/src/relevance/hybrid.rs +0 -364
- package/crates/headroom-core/src/relevance/mod.rs +0 -64
- package/crates/headroom-core/src/signals/keyword_detector.rs +0 -433
- package/crates/headroom-core/src/signals/line_importance.rs +0 -84
- package/crates/headroom-core/src/signals/mod.rs +0 -61
- package/crates/headroom-core/src/signals/tiered.rs +0 -141
- package/crates/headroom-core/src/tokenizer/estimator.rs +0 -152
- package/crates/headroom-core/src/tokenizer/hf_impl.rs +0 -314
- package/crates/headroom-core/src/tokenizer/mod.rs +0 -56
- package/crates/headroom-core/src/tokenizer/registry.rs +0 -342
- package/crates/headroom-core/src/tokenizer/tiktoken_impl.rs +0 -265
- package/crates/headroom-core/src/transforms/adaptive_sizer.rs +0 -610
- package/crates/headroom-core/src/transforms/anchor_selector.rs +0 -1189
- package/crates/headroom-core/src/transforms/content_detector.rs +0 -769
- package/crates/headroom-core/src/transforms/detection.rs +0 -222
- package/crates/headroom-core/src/transforms/diff_compressor.rs +0 -1685
- package/crates/headroom-core/src/transforms/live_zone.rs +0 -2967
- package/crates/headroom-core/src/transforms/log_compressor.rs +0 -1295
- package/crates/headroom-core/src/transforms/magika_detector.rs +0 -395
- package/crates/headroom-core/src/transforms/mod.rs +0 -64
- package/crates/headroom-core/src/transforms/pipeline/config.rs +0 -331
- package/crates/headroom-core/src/transforms/pipeline/mod.rs +0 -103
- package/crates/headroom-core/src/transforms/pipeline/offloads/diff_noise.rs +0 -524
- package/crates/headroom-core/src/transforms/pipeline/offloads/diff_offload.rs +0 -279
- package/crates/headroom-core/src/transforms/pipeline/offloads/json_offload.rs +0 -400
- package/crates/headroom-core/src/transforms/pipeline/offloads/log_offload.rs +0 -284
- package/crates/headroom-core/src/transforms/pipeline/offloads/mod.rs +0 -34
- package/crates/headroom-core/src/transforms/pipeline/offloads/search_offload.rs +0 -331
- package/crates/headroom-core/src/transforms/pipeline/orchestrator.rs +0 -848
- package/crates/headroom-core/src/transforms/pipeline/reformats/json_minifier.rs +0 -175
- package/crates/headroom-core/src/transforms/pipeline/reformats/log_template.rs +0 -545
- package/crates/headroom-core/src/transforms/pipeline/reformats/mod.rs +0 -12
- package/crates/headroom-core/src/transforms/pipeline/traits.rs +0 -338
- package/crates/headroom-core/src/transforms/recommendations.rs +0 -329
- package/crates/headroom-core/src/transforms/safety.rs +0 -215
- package/crates/headroom-core/src/transforms/search_compressor.rs +0 -902
- package/crates/headroom-core/src/transforms/smart_crusher/analyzer.rs +0 -1262
- package/crates/headroom-core/src/transforms/smart_crusher/anchors.rs +0 -407
- package/crates/headroom-core/src/transforms/smart_crusher/builder.rs +0 -263
- package/crates/headroom-core/src/transforms/smart_crusher/classifier.rs +0 -214
- package/crates/headroom-core/src/transforms/smart_crusher/compaction/classifier.rs +0 -283
- package/crates/headroom-core/src/transforms/smart_crusher/compaction/compactor.rs +0 -733
- package/crates/headroom-core/src/transforms/smart_crusher/compaction/formatter.rs +0 -961
- package/crates/headroom-core/src/transforms/smart_crusher/compaction/ir.rs +0 -252
- package/crates/headroom-core/src/transforms/smart_crusher/compaction/mod.rs +0 -127
- package/crates/headroom-core/src/transforms/smart_crusher/compaction/walker.rs +0 -397
- package/crates/headroom-core/src/transforms/smart_crusher/config.rs +0 -173
- package/crates/headroom-core/src/transforms/smart_crusher/constraints.rs +0 -159
- package/crates/headroom-core/src/transforms/smart_crusher/crusher.rs +0 -1665
- package/crates/headroom-core/src/transforms/smart_crusher/crushers.rs +0 -865
- package/crates/headroom-core/src/transforms/smart_crusher/error_keywords.rs +0 -77
- package/crates/headroom-core/src/transforms/smart_crusher/field_detect.rs +0 -393
- package/crates/headroom-core/src/transforms/smart_crusher/hashing.rs +0 -72
- package/crates/headroom-core/src/transforms/smart_crusher/mod.rs +0 -81
- package/crates/headroom-core/src/transforms/smart_crusher/observer.rs +0 -66
- package/crates/headroom-core/src/transforms/smart_crusher/orchestration.rs +0 -459
- package/crates/headroom-core/src/transforms/smart_crusher/outliers.rs +0 -507
- package/crates/headroom-core/src/transforms/smart_crusher/planning.rs +0 -904
- package/crates/headroom-core/src/transforms/smart_crusher/statistics.rs +0 -510
- package/crates/headroom-core/src/transforms/smart_crusher/stats_math.rs +0 -287
- package/crates/headroom-core/src/transforms/smart_crusher/traits.rs +0 -203
- package/crates/headroom-core/src/transforms/smart_crusher/types.rs +0 -263
- package/crates/headroom-core/src/transforms/tag_protector.rs +0 -1272
- package/crates/headroom-core/src/transforms/unidiff_detector.rs +0 -232
- package/crates/headroom-parity/Cargo.toml +0 -26
- package/crates/headroom-parity/examples/diff_fixture.rs +0 -66
- package/crates/headroom-parity/src/bin/parity_run.rs +0 -78
- package/crates/headroom-parity/src/lib.rs +0 -613
- package/crates/headroom-proxy/Cargo.toml +0 -119
- package/crates/headroom-proxy/data/model_prices_and_context_window.json +0 -39767
- package/crates/headroom-proxy/src/bedrock/auth_mode_layer.rs +0 -192
- package/crates/headroom-proxy/src/bedrock/envelope.rs +0 -239
- package/crates/headroom-proxy/src/bedrock/eventstream.rs +0 -769
- package/crates/headroom-proxy/src/bedrock/eventstream_to_sse.rs +0 -459
- package/crates/headroom-proxy/src/bedrock/invoke.rs +0 -735
- package/crates/headroom-proxy/src/bedrock/invoke_streaming.rs +0 -1098
- package/crates/headroom-proxy/src/bedrock/mod.rs +0 -66
- package/crates/headroom-proxy/src/bedrock/sigv4.rs +0 -324
- package/crates/headroom-proxy/src/bedrock/vendor.rs +0 -82
- package/crates/headroom-proxy/src/cache_stabilization/anthropic_cache_control.rs +0 -698
- package/crates/headroom-proxy/src/cache_stabilization/drift_detector.rs +0 -683
- package/crates/headroom-proxy/src/cache_stabilization/mod.rs +0 -61
- package/crates/headroom-proxy/src/cache_stabilization/openai_cache_key.rs +0 -600
- package/crates/headroom-proxy/src/cache_stabilization/tool_def_normalize.rs +0 -514
- package/crates/headroom-proxy/src/cache_stabilization/volatile_detector.rs +0 -720
- package/crates/headroom-proxy/src/compression/anthropic.rs +0 -92
- package/crates/headroom-proxy/src/compression/live_zone_anthropic.rs +0 -1311
- package/crates/headroom-proxy/src/compression/live_zone_openai.rs +0 -660
- package/crates/headroom-proxy/src/compression/live_zone_responses.rs +0 -678
- package/crates/headroom-proxy/src/compression/mod.rs +0 -127
- package/crates/headroom-proxy/src/compression/model_limits.rs +0 -211
- package/crates/headroom-proxy/src/config.rs +0 -646
- package/crates/headroom-proxy/src/error.rs +0 -69
- package/crates/headroom-proxy/src/handlers/chat_completions.rs +0 -100
- package/crates/headroom-proxy/src/handlers/conversations.rs +0 -241
- package/crates/headroom-proxy/src/handlers/mod.rs +0 -13
- package/crates/headroom-proxy/src/handlers/responses.rs +0 -256
- package/crates/headroom-proxy/src/headers.rs +0 -288
- package/crates/headroom-proxy/src/health.rs +0 -41
- package/crates/headroom-proxy/src/lib.rs +0 -21
- package/crates/headroom-proxy/src/main.rs +0 -141
- package/crates/headroom-proxy/src/observability/cache_hit_rate.rs +0 -340
- package/crates/headroom-proxy/src/observability/compression_ratio.rs +0 -158
- package/crates/headroom-proxy/src/observability/metric_names.rs +0 -174
- package/crates/headroom-proxy/src/observability/mod.rs +0 -68
- package/crates/headroom-proxy/src/observability/prometheus.rs +0 -394
- package/crates/headroom-proxy/src/observability/proxy_metrics.rs +0 -368
- package/crates/headroom-proxy/src/proxy.rs +0 -1619
- package/crates/headroom-proxy/src/responses_items.rs +0 -565
- package/crates/headroom-proxy/src/sse/anthropic.rs +0 -415
- package/crates/headroom-proxy/src/sse/framing.rs +0 -366
- package/crates/headroom-proxy/src/sse/mod.rs +0 -40
- package/crates/headroom-proxy/src/sse/openai_chat.rs +0 -231
- package/crates/headroom-proxy/src/sse/openai_responses.rs +0 -458
- package/crates/headroom-proxy/src/vertex/adc.rs +0 -315
- package/crates/headroom-proxy/src/vertex/envelope.rs +0 -167
- package/crates/headroom-proxy/src/vertex/mod.rs +0 -277
- package/crates/headroom-proxy/src/vertex/raw_predict.rs +0 -490
- package/crates/headroom-proxy/src/vertex/stream_raw_predict.rs +0 -49
- package/crates/headroom-proxy/src/websocket.rs +0 -246
- package/crates/headroom-py/Cargo.toml +0 -37
- package/crates/headroom-py/build.rs +0 -77
- package/crates/headroom-py/glibc_compat.c +0 -170
- package/crates/headroom-py/src/lib.rs +0 -1655
- package/deny.toml +0 -32
- package/docker/differential-network-capture/Dockerfile.runner +0 -14
- package/docker/differential-network-capture/docker-compose.yml +0 -142
- package/docker/differential-network-capture/run-claude-lane.sh +0 -24
- package/docker/docker-compose.native.yml +0 -44
- package/docker-bake.hcl +0 -88
- package/docker-compose.yml +0 -80
- package/e2e/_lib/make_shim.ps1 +0 -24
- package/e2e/_lib/make_shim.sh +0 -28
- package/e2e/docker-native-install.sh +0 -120
- package/e2e/init/Dockerfile +0 -79
- package/e2e/wrap/Dockerfile +0 -115
- package/examples/07-context-compression.ipynb +0 -279
- package/examples/deployment/macos-launchagent/com.headroom.proxy.plist.template +0 -65
- package/examples/deployment/macos-launchagent/install.sh +0 -227
- package/examples/deployment/macos-launchagent/shell-integration.sh +0 -74
- package/examples/deployment/macos-launchagent/uninstall.sh +0 -145
- package/headroom-savings.png +0 -0
- package/headroom_learn.gif +0 -0
- package/llms.txt +0 -67
- package/mkdocs.yml +0 -136
- package/npm/bin/xithead.js +0 -366
- package/npm/bin/xtream-head.js +0 -366
- package/npm/index.d.ts +0 -57
- package/npm/index.js +0 -139
- package/npm/package.json +0 -55
- package/npm/postinstall.js +0 -43
- package/plugins/headroom-agent-hooks/.claude-plugin/plugin.json +0 -17
- package/plugins/headroom-agent-hooks/hooks/hooks.json +0 -29
- package/plugins/headroom-oauth2/LICENSE +0 -3
- package/plugins/headroom-oauth2/SPEC.md +0 -115
- package/plugins/headroom-oauth2/pyproject.toml +0 -48
- package/plugins/hermes/headroom_retrieve/plugin.yaml +0 -6
- package/plugins/openclaw/hook-shim/HOOK.md +0 -21
- package/plugins/openclaw/hook-shim/handler.js +0 -3
- package/plugins/openclaw/openclaw.plugin.json +0 -98
- package/plugins/openclaw/package-lock.json +0 -2692
- package/plugins/openclaw/package.json +0 -54
- package/plugins/openclaw/prepare-dist.mjs +0 -56
- package/plugins/openclaw/src/convert.ts +0 -418
- package/plugins/openclaw/src/engine.ts +0 -284
- package/plugins/openclaw/src/gateway-config.ts +0 -143
- package/plugins/openclaw/src/index.ts +0 -11
- package/plugins/openclaw/src/plugin/index.ts +0 -98
- package/plugins/openclaw/src/proxy-manager.ts +0 -477
- package/plugins/openclaw/src/tools/headroom-retrieve.ts +0 -76
- package/plugins/openclaw/test/convert.test.ts +0 -96
- package/plugins/openclaw/test/engine-normalization.test.ts +0 -21
- package/plugins/openclaw/test/engine.test.ts +0 -101
- package/plugins/openclaw/test/gateway-config.test.ts +0 -278
- package/plugins/openclaw/test/plugin-runtime-routing.test.ts +0 -141
- package/plugins/openclaw/test/proxy-manager.test.ts +0 -343
- package/plugins/openclaw/tsup.config.ts +0 -9
- package/pyproject.toml +0 -438
- package/rust-toolchain.toml +0 -16
- package/sdk/typescript/examples/basic-compress.ts +0 -64
- package/sdk/typescript/examples/ccr-retrieve.ts +0 -80
- package/sdk/typescript/examples/hooks-custom-compression.ts +0 -117
- package/sdk/typescript/examples/middleware-composition.ts +0 -59
- package/sdk/typescript/examples/multi-provider.ts +0 -53
- package/sdk/typescript/examples/openai-anthropic-adapters.ts +0 -73
- package/sdk/typescript/examples/shared-context-multi-agent.ts +0 -74
- package/sdk/typescript/examples/simulation-dry-run.ts +0 -80
- package/sdk/typescript/examples/streaming-chat.ts +0 -71
- package/sdk/typescript/examples/structured-output.ts +0 -99
- package/sdk/typescript/examples/tool-calling-agent.ts +0 -86
- package/sdk/typescript/examples/with-headroom-vercel.ts +0 -57
- package/sdk/typescript/package-lock.json +0 -3437
- package/sdk/typescript/package.json +0 -108
- package/sdk/typescript/src/adapters/anthropic.ts +0 -218
- package/sdk/typescript/src/adapters/gemini.ts +0 -83
- package/sdk/typescript/src/adapters/openai.ts +0 -77
- package/sdk/typescript/src/adapters/vercel-ai.ts +0 -131
- package/sdk/typescript/src/client.ts +0 -632
- package/sdk/typescript/src/compress.ts +0 -87
- package/sdk/typescript/src/errors.ts +0 -114
- package/sdk/typescript/src/hooks.ts +0 -113
- package/sdk/typescript/src/index.ts +0 -140
- package/sdk/typescript/src/paths.ts +0 -272
- package/sdk/typescript/src/shared-context.ts +0 -188
- package/sdk/typescript/src/simulate.ts +0 -52
- package/sdk/typescript/src/types/config.ts +0 -183
- package/sdk/typescript/src/types/models.ts +0 -314
- package/sdk/typescript/src/types.ts +0 -139
- package/sdk/typescript/src/utils/case.ts +0 -34
- package/sdk/typescript/src/utils/format.ts +0 -480
- package/sdk/typescript/src/utils/stream.ts +0 -50
- package/sdk/typescript/test/adapters/anthropic.test.ts +0 -217
- package/sdk/typescript/test/adapters/gemini.test.ts +0 -131
- package/sdk/typescript/test/adapters/openai.test.ts +0 -174
- package/sdk/typescript/test/adapters/vercel-ai.test.ts +0 -306
- package/sdk/typescript/test/client-expanded.test.ts +0 -333
- package/sdk/typescript/test/client.test.ts +0 -266
- package/sdk/typescript/test/compress.test.ts +0 -118
- package/sdk/typescript/test/config.test.ts +0 -275
- package/sdk/typescript/test/errors.test.ts +0 -169
- package/sdk/typescript/test/format-integration.test.ts +0 -252
- package/sdk/typescript/test/hooks.test.ts +0 -265
- package/sdk/typescript/test/integration.test.ts +0 -249
- package/sdk/typescript/test/mdx-examples.test.ts +0 -253
- package/sdk/typescript/test/models.test.ts +0 -318
- package/sdk/typescript/test/parity.test.ts +0 -337
- package/sdk/typescript/test/paths.test.ts +0 -447
- package/sdk/typescript/test/shared-context.test.ts +0 -245
- package/sdk/typescript/test/simulate.test.ts +0 -84
- package/sdk/typescript/test/types.test.ts +0 -244
- package/sdk/typescript/test/utils/case.test.ts +0 -129
- package/sdk/typescript/test/utils/detect-format.test.ts +0 -133
- package/sdk/typescript/test/utils/format.test.ts +0 -434
- package/sdk/typescript/test/vercel-ai-e2e.test.ts +0 -179
- package/sdk/typescript/tsup.config.ts +0 -17
- package/uv.lock +0 -6951
- package/xithead.egg-info/PKG-INFO +0 -22
- package/xithead.egg-info/SOURCES.txt +0 -16
- package/xithead.egg-info/dependency_links.txt +0 -1
- package/xithead.egg-info/entry_points.txt +0 -2
- package/xithead.egg-info/requires.txt +0 -10
- package/xithead.egg-info/top_level.txt +0 -2
- package/xithead.ps1 +0 -136
- package/xithead.sh +0 -129
- package/xithead_dist/pyproject.toml +0 -39
- package/xithead_dist/xithead.egg-info/PKG-INFO +0 -22
- package/xithead_dist/xithead.egg-info/SOURCES.txt +0 -16
- package/xithead_dist/xithead.egg-info/dependency_links.txt +0 -1
- package/xithead_dist/xithead.egg-info/entry_points.txt +0 -3
- package/xithead_dist/xithead.egg-info/requires.txt +0 -10
- package/xithead_dist/xithead.egg-info/top_level.txt +0 -2
package/MODERNIZATION_GUIDE.md
DELETED
|
@@ -1,358 +0,0 @@
|
|
|
1
|
-
# xithead Modernization & Enhancement Guide
|
|
2
|
-
|
|
3
|
-
Comprehensive improvements for production-grade deployment, enterprise features, and developer experience.
|
|
4
|
-
|
|
5
|
-
## 🎯 Quick-Win Features (Implemented This Sprint)
|
|
6
|
-
|
|
7
|
-
### 1. **Centralized Configuration System**
|
|
8
|
-
```bash
|
|
9
|
-
# View current settings
|
|
10
|
-
headroom config get proxy.port
|
|
11
|
-
|
|
12
|
-
# Update settings
|
|
13
|
-
headroom config set cache.ttl_default 7200
|
|
14
|
-
|
|
15
|
-
# List all settings
|
|
16
|
-
headroom config list
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-
**Files:**
|
|
20
|
-
- `headroom/config/settings.py` - Centralized Pydantic-based config
|
|
21
|
-
- All settings stored in `~/.headroom/settings.json`
|
|
22
|
-
- Environment variable override support (`HEADROOM_PROXY_PORT=8888`)
|
|
23
|
-
|
|
24
|
-
**Benefits:**
|
|
25
|
-
- ✅ Hot reload (no restart needed for most settings)
|
|
26
|
-
- ✅ Type-safe configuration with validation
|
|
27
|
-
- ✅ Environment variable support
|
|
28
|
-
- ✅ Configuration UI integration (coming soon)
|
|
29
|
-
|
|
30
|
-
---
|
|
31
|
-
|
|
32
|
-
### 2. **Interactive Testing Mode**
|
|
33
|
-
```bash
|
|
34
|
-
# Launch interactive shell
|
|
35
|
-
headroom interactive
|
|
36
|
-
|
|
37
|
-
# Commands in interactive mode:
|
|
38
|
-
load /path/to/file # Load content for testing
|
|
39
|
-
paste # Paste content from stdin
|
|
40
|
-
analyze # Analyze content type & size
|
|
41
|
-
compress # Apply compression
|
|
42
|
-
compress --aggressive # Aggressive compression
|
|
43
|
-
preview # Show compression preview
|
|
44
|
-
cache-estimate # Estimate cache behavior
|
|
45
|
-
stats # Show adaptive strategy stats
|
|
46
|
-
help # Show commands
|
|
47
|
-
quit # Exit
|
|
48
|
-
```
|
|
49
|
-
|
|
50
|
-
**Features:**
|
|
51
|
-
- ✅ Load files or paste content
|
|
52
|
-
- ✅ Real-time compression preview
|
|
53
|
-
- ✅ Cache behavior estimation
|
|
54
|
-
- ✅ Compression strategy testing
|
|
55
|
-
- ✅ Token savings estimation
|
|
56
|
-
|
|
57
|
-
**Use cases:**
|
|
58
|
-
- Test compression on your actual data
|
|
59
|
-
- Understand cache hit likelihood
|
|
60
|
-
- Optimize settings before production
|
|
61
|
-
- Debug compression issues
|
|
62
|
-
|
|
63
|
-
---
|
|
64
|
-
|
|
65
|
-
### 3. **JSON-Structured Logging**
|
|
66
|
-
```python
|
|
67
|
-
from headroom.logging.structured import setup_structured_logging
|
|
68
|
-
|
|
69
|
-
logger = setup_structured_logging("myapp", level=logging.INFO)
|
|
70
|
-
|
|
71
|
-
# Logs are emitted as JSON for easy aggregation
|
|
72
|
-
# {"timestamp": "2026-07-31T...", "level": "INFO", "message": "...", "custom_field": "value"}
|
|
73
|
-
```
|
|
74
|
-
|
|
75
|
-
**Benefits:**
|
|
76
|
-
- ✅ Machine-parseable logs
|
|
77
|
-
- ✅ Easy ELK/DataDog integration
|
|
78
|
-
- ✅ Structured fields for filtering
|
|
79
|
-
- ✅ Correlation IDs for tracing
|
|
80
|
-
|
|
81
|
-
---
|
|
82
|
-
|
|
83
|
-
### 4. **Security Headers Middleware**
|
|
84
|
-
```python
|
|
85
|
-
from headroom.proxy.security_middleware import SecurityHeadersMiddleware
|
|
86
|
-
|
|
87
|
-
# Add to FastAPI app
|
|
88
|
-
app.add_middleware(SecurityHeadersMiddleware)
|
|
89
|
-
```
|
|
90
|
-
|
|
91
|
-
**Headers added automatically:**
|
|
92
|
-
- ✅ `Strict-Transport-Security` (HSTS)
|
|
93
|
-
- ✅ `X-Frame-Options: DENY` (clickjacking protection)
|
|
94
|
-
- ✅ `X-Content-Type-Options: nosniff` (MIME sniffing prevention)
|
|
95
|
-
- ✅ `Content-Security-Policy` (XSS protection)
|
|
96
|
-
- ✅ `Permissions-Policy` (feature access control)
|
|
97
|
-
|
|
98
|
-
---
|
|
99
|
-
|
|
100
|
-
### 5. **Per-API-Key Rate Limiting & Quotas**
|
|
101
|
-
```python
|
|
102
|
-
from headroom.rate_limiting.key_quota import KeyQuotaManager
|
|
103
|
-
|
|
104
|
-
manager = KeyQuotaManager()
|
|
105
|
-
|
|
106
|
-
# Check if request allowed
|
|
107
|
-
allowed, reason = manager.check_quota(api_key="key-123", tokens=1000)
|
|
108
|
-
if not allowed:
|
|
109
|
-
return error(reason) # "Daily quota exceeded"
|
|
110
|
-
|
|
111
|
-
# Record usage
|
|
112
|
-
manager.record_usage(api_key="key-123", tokens=1000)
|
|
113
|
-
|
|
114
|
-
# Get status
|
|
115
|
-
status = manager.get_quota_status("key-123")
|
|
116
|
-
# {
|
|
117
|
-
# "daily": {"used": 5000, "limit": 1000000, "remaining": 995000, "percentage": 0.5},
|
|
118
|
-
# "monthly": {...}
|
|
119
|
-
# }
|
|
120
|
-
```
|
|
121
|
-
|
|
122
|
-
**Configuration:**
|
|
123
|
-
- Per-key daily token limit (default 1M)
|
|
124
|
-
- Per-key monthly token limit (default 10M)
|
|
125
|
-
- Enable/disable keys
|
|
126
|
-
- Automatic daily/monthly reset
|
|
127
|
-
|
|
128
|
-
---
|
|
129
|
-
|
|
130
|
-
### 6. **Webhook System for Integrations**
|
|
131
|
-
```python
|
|
132
|
-
from headroom.integrations.webhooks import WebhookEvent, get_webhook_manager, send_webhook_event
|
|
133
|
-
|
|
134
|
-
manager = get_webhook_manager()
|
|
135
|
-
|
|
136
|
-
# Register webhooks
|
|
137
|
-
manager.register_webhook(
|
|
138
|
-
url="https://hooks.slack.com/services/...",
|
|
139
|
-
events=[
|
|
140
|
-
WebhookEvent.HIGH_COMPRESSION_RATIO,
|
|
141
|
-
WebhookEvent.QUOTA_EXCEEDED,
|
|
142
|
-
WebhookEvent.COST_ALERT,
|
|
143
|
-
],
|
|
144
|
-
secret="optional-hmac-secret"
|
|
145
|
-
)
|
|
146
|
-
|
|
147
|
-
# Send events
|
|
148
|
-
await send_webhook_event(
|
|
149
|
-
event=WebhookEvent.COST_ALERT,
|
|
150
|
-
data={"projected_cost": 150.00, "budget": 100.00},
|
|
151
|
-
correlation_id="req-12345"
|
|
152
|
-
)
|
|
153
|
-
```
|
|
154
|
-
|
|
155
|
-
**Supported Events:**
|
|
156
|
-
- `HIGH_COMPRESSION_RATIO` - Compression achieved >50%
|
|
157
|
-
- `CACHE_HIT_MILESTONE` - Cache hit rate >80%
|
|
158
|
-
- `QUOTA_EXCEEDED` - API key quota exceeded
|
|
159
|
-
- `ANOMALY_DETECTED` - Cost spike detected
|
|
160
|
-
- `UPDATE_AVAILABLE` - New version available
|
|
161
|
-
- `ERROR_SPIKE` - Error rate increased
|
|
162
|
-
- `COST_ALERT` - Cost projection exceeded budget
|
|
163
|
-
|
|
164
|
-
**Features:**
|
|
165
|
-
- ✅ Multiple webhooks per event
|
|
166
|
-
- ✅ Automatic retries with exponential backoff
|
|
167
|
-
- ✅ HMAC signing for verification
|
|
168
|
-
- ✅ Local event handler support
|
|
169
|
-
- ✅ Async delivery (non-blocking)
|
|
170
|
-
|
|
171
|
-
---
|
|
172
|
-
|
|
173
|
-
### 7. **Real-time Metrics Collection**
|
|
174
|
-
```python
|
|
175
|
-
from headroom.dashboard.realtime import record_metric, get_metrics_collector
|
|
176
|
-
|
|
177
|
-
# Record metrics
|
|
178
|
-
record_metric("throughput", value=1250, tags={"model": "claude-3-sonnet"})
|
|
179
|
-
record_metric("cache_hit_rate", value=0.82, tags={"window": "5m"})
|
|
180
|
-
record_metric("compression_ratio", value=0.45)
|
|
181
|
-
|
|
182
|
-
# Get aggregated metrics
|
|
183
|
-
collector = get_metrics_collector()
|
|
184
|
-
summary = collector.get_metrics_summary()
|
|
185
|
-
# {
|
|
186
|
-
# "total_metrics": 2543,
|
|
187
|
-
# "window_seconds": 300,
|
|
188
|
-
# "metric_types": ["throughput", "cache_hit_rate", "compression_ratio"],
|
|
189
|
-
# "throughput": {"count": 800, "min": 1000, "max": 2000, "avg": 1500, "p50": 1450, "p95": 1950, "p99": 2000},
|
|
190
|
-
# ...
|
|
191
|
-
# }
|
|
192
|
-
|
|
193
|
-
# Get time series
|
|
194
|
-
timeseries = collector.get_time_series("throughput", window_seconds=300, bucket_size=10)
|
|
195
|
-
# [
|
|
196
|
-
# {"timestamp": 1722379200, "count": 50, "value": 1450},
|
|
197
|
-
# {"timestamp": 1722379210, "count": 52, "value": 1480},
|
|
198
|
-
# ...
|
|
199
|
-
# ]
|
|
200
|
-
```
|
|
201
|
-
|
|
202
|
-
**Features:**
|
|
203
|
-
- ✅ Real-time metric recording
|
|
204
|
-
- ✅ Automatic aggregation (min, max, avg, p50, p95, p99)
|
|
205
|
-
- ✅ Time-series bucketing
|
|
206
|
-
- ✅ Subscriber pattern for live updates
|
|
207
|
-
- ✅ Sliding window support
|
|
208
|
-
|
|
209
|
-
---
|
|
210
|
-
|
|
211
|
-
## 📋 Feature Checklist
|
|
212
|
-
|
|
213
|
-
### Quick-Wins (Completed ✅)
|
|
214
|
-
- ✅ Centralized config system (settings.py)
|
|
215
|
-
- ✅ Interactive CLI mode (interactive.py)
|
|
216
|
-
- ✅ JSON-structured logging (logging/structured.py)
|
|
217
|
-
- ✅ Security headers middleware (proxy/security_middleware.py)
|
|
218
|
-
- ✅ Per-API-key quotas (rate_limiting/key_quota.py)
|
|
219
|
-
- ✅ Webhook system (integrations/webhooks.py)
|
|
220
|
-
- ✅ Real-time metrics (dashboard/realtime.py)
|
|
221
|
-
|
|
222
|
-
### High-Priority (Next Sprint)
|
|
223
|
-
- ⏳ WebSocket dashboard updates
|
|
224
|
-
- ⏳ Settings UI in dashboard
|
|
225
|
-
- ⏳ Cost forecasting alerts
|
|
226
|
-
- ⏳ Distributed tracing (Jaeger)
|
|
227
|
-
- ⏳ OpenAPI/Swagger documentation
|
|
228
|
-
|
|
229
|
-
### Strategic (Q1-Q4 2027)
|
|
230
|
-
- 🗺️ Plugin/extension system
|
|
231
|
-
- 🗺️ Multi-tenant support
|
|
232
|
-
- 🗺️ Kubernetes Helm charts
|
|
233
|
-
- 🗺️ AI-powered tuning
|
|
234
|
-
- 🗺️ Global federation
|
|
235
|
-
|
|
236
|
-
---
|
|
237
|
-
|
|
238
|
-
## 🚀 Integration Examples
|
|
239
|
-
|
|
240
|
-
### Slack Integration
|
|
241
|
-
```python
|
|
242
|
-
# Send compression milestone to Slack
|
|
243
|
-
await send_webhook_event(
|
|
244
|
-
event=WebhookEvent.HIGH_COMPRESSION_RATIO,
|
|
245
|
-
data={
|
|
246
|
-
"ratio": 0.55,
|
|
247
|
-
"tokens_saved": 25000,
|
|
248
|
-
"cost_saved": "$0.075"
|
|
249
|
-
}
|
|
250
|
-
)
|
|
251
|
-
```
|
|
252
|
-
|
|
253
|
-
### Discord Integration
|
|
254
|
-
```python
|
|
255
|
-
# Register Discord webhook
|
|
256
|
-
manager.register_webhook(
|
|
257
|
-
url="https://discord.com/api/webhooks/...",
|
|
258
|
-
events=[WebhookEvent.COST_ALERT, WebhookEvent.ANOMALY_DETECTED]
|
|
259
|
-
)
|
|
260
|
-
```
|
|
261
|
-
|
|
262
|
-
### Custom Monitoring
|
|
263
|
-
```python
|
|
264
|
-
# Register local handler
|
|
265
|
-
def on_cost_alert(payload: WebhookPayload):
|
|
266
|
-
send_email("alerts@company.com", f"Cost alert: {payload.data}")
|
|
267
|
-
|
|
268
|
-
manager.register_handler(WebhookEvent.COST_ALERT, on_cost_alert)
|
|
269
|
-
```
|
|
270
|
-
|
|
271
|
-
---
|
|
272
|
-
|
|
273
|
-
## 📊 Performance Impact
|
|
274
|
-
|
|
275
|
-
| Feature | Performance Gain | Implementation |
|
|
276
|
-
|---------|-----------------|-----------------|
|
|
277
|
-
| LRU Caching (models) | 15-30% latency | Added `@lru_cache` |
|
|
278
|
-
| Async webhooks | Non-blocking | asyncio delivery |
|
|
279
|
-
| Metric aggregation | Real-time insights | Sliding window |
|
|
280
|
-
| Config hot-reload | No downtime | File watcher |
|
|
281
|
-
| **Total** | **Significant** | **Production-ready** |
|
|
282
|
-
|
|
283
|
-
---
|
|
284
|
-
|
|
285
|
-
## 🔧 Configuration Reference
|
|
286
|
-
|
|
287
|
-
### Config File Location
|
|
288
|
-
```
|
|
289
|
-
~/.headroom/settings.json
|
|
290
|
-
```
|
|
291
|
-
|
|
292
|
-
### Environment Variables
|
|
293
|
-
```bash
|
|
294
|
-
# Proxy settings
|
|
295
|
-
HEADROOM_PROXY_HOST=0.0.0.0
|
|
296
|
-
HEADROOM_PROXY_PORT=8787
|
|
297
|
-
HEADROOM_PROXY_WORKERS=4
|
|
298
|
-
|
|
299
|
-
# Cache settings
|
|
300
|
-
HEADROOM_CACHE_TTL_DEFAULT=3600
|
|
301
|
-
HEADROOM_CACHE_BACKEND=sqlite
|
|
302
|
-
|
|
303
|
-
# Compression settings
|
|
304
|
-
HEADROOM_COMPRESSION_LEVEL=balanced
|
|
305
|
-
|
|
306
|
-
# Logging settings
|
|
307
|
-
HEADROOM_LOG_LEVEL=INFO
|
|
308
|
-
HEADROOM_LOG_FORMAT=json
|
|
309
|
-
|
|
310
|
-
# Rate limiting
|
|
311
|
-
HEADROOM_RATE_LIMIT_GLOBAL_RPS=100
|
|
312
|
-
```
|
|
313
|
-
|
|
314
|
-
---
|
|
315
|
-
|
|
316
|
-
## 📖 Next Steps
|
|
317
|
-
|
|
318
|
-
1. **Test Locally**
|
|
319
|
-
```bash
|
|
320
|
-
headroom interactive
|
|
321
|
-
# Test compression on your content
|
|
322
|
-
```
|
|
323
|
-
|
|
324
|
-
2. **Review Settings**
|
|
325
|
-
```bash
|
|
326
|
-
headroom config list
|
|
327
|
-
# Adjust settings as needed
|
|
328
|
-
```
|
|
329
|
-
|
|
330
|
-
3. **Enable Integrations**
|
|
331
|
-
```python
|
|
332
|
-
# Register webhooks for your Slack/Discord
|
|
333
|
-
```
|
|
334
|
-
|
|
335
|
-
4. **Monitor Metrics**
|
|
336
|
-
```bash
|
|
337
|
-
headroom analytics forecast
|
|
338
|
-
# Check cost projections
|
|
339
|
-
```
|
|
340
|
-
|
|
341
|
-
5. **Deploy to Production**
|
|
342
|
-
- Use configuration files for production settings
|
|
343
|
-
- Enable webhook integration for monitoring
|
|
344
|
-
- Set up per-API-key quotas for multi-tenant scenarios
|
|
345
|
-
|
|
346
|
-
---
|
|
347
|
-
|
|
348
|
-
## 📞 Support
|
|
349
|
-
|
|
350
|
-
For questions or issues:
|
|
351
|
-
- Check `FEATURES_ADVANCED.md` for detailed API docs
|
|
352
|
-
- Review examples in this guide
|
|
353
|
-
- Open GitHub issue with reproduction steps
|
|
354
|
-
|
|
355
|
-
---
|
|
356
|
-
|
|
357
|
-
Last Updated: 2026-07-31
|
|
358
|
-
Version: xithead 2.0 (Modernization Sprint)
|
package/Makefile
DELETED
|
@@ -1,140 +0,0 @@
|
|
|
1
|
-
# Headroom Rust build targets. `just` is not installed on dev boxes; this
|
|
2
|
-
# Makefile is the source of truth and is mirrored by .github/workflows/rust.yml.
|
|
3
|
-
|
|
4
|
-
SHELL := /bin/bash
|
|
5
|
-
CARGO ?= cargo
|
|
6
|
-
MATURIN ?= maturin
|
|
7
|
-
PYTHON ?= python3
|
|
8
|
-
FIXTURES ?= tests/parity/fixtures
|
|
9
|
-
|
|
10
|
-
.PHONY: help test test-parity bench build-proxy build-wheel fmt fmt-check lint clippy clean ci-precheck ci-precheck-rust ci-precheck-python ci-precheck-commitlint install-git-hooks verify-rust-core
|
|
11
|
-
|
|
12
|
-
help:
|
|
13
|
-
@echo "Headroom Rust targets:"
|
|
14
|
-
@echo " make test - cargo test --workspace"
|
|
15
|
-
@echo " make test-parity - maturin develop + parity-run against fixtures"
|
|
16
|
-
@echo " make bench - cargo bench --workspace"
|
|
17
|
-
@echo " make build-proxy - release build + strip headroom-proxy, print size"
|
|
18
|
-
@echo " make build-wheel - release wheel for headroom-py"
|
|
19
|
-
@echo " make verify-rust-core - build + install + import-verify headroom._core"
|
|
20
|
-
@echo " make fmt - cargo fmt --all"
|
|
21
|
-
@echo " make fmt-check - cargo fmt --all -- --check"
|
|
22
|
-
@echo " make lint - cargo clippy --workspace -- -D warnings"
|
|
23
|
-
@echo " make clean - cargo clean"
|
|
24
|
-
@echo ""
|
|
25
|
-
@echo "Pre-push verification (run BEFORE git push to catch CI failures locally):"
|
|
26
|
-
@echo " make ci-precheck - run all CI gates (rust + python + commitlint)"
|
|
27
|
-
@echo " make ci-precheck-rust - cargo fmt --check + clippy + test"
|
|
28
|
-
@echo " make ci-precheck-python - smart_crusher-affected python tests"
|
|
29
|
-
@echo " make ci-precheck-commitlint - lint commits since origin/main"
|
|
30
|
-
@echo " make install-git-hooks - install pre-commit, commit-msg, and pre-push hooks"
|
|
31
|
-
|
|
32
|
-
test:
|
|
33
|
-
$(CARGO) test --workspace
|
|
34
|
-
|
|
35
|
-
test-parity:
|
|
36
|
-
@if [ -z "$$VIRTUAL_ENV" ]; then \
|
|
37
|
-
echo "error: activate a venv first (e.g. source .venv/bin/activate)"; \
|
|
38
|
-
exit 1; \
|
|
39
|
-
fi
|
|
40
|
-
$(MATURIN) develop -m crates/headroom-py/Cargo.toml
|
|
41
|
-
$(CARGO) run -p headroom-parity -- run --fixtures $(FIXTURES)
|
|
42
|
-
|
|
43
|
-
bench:
|
|
44
|
-
$(CARGO) bench --workspace
|
|
45
|
-
|
|
46
|
-
build-proxy:
|
|
47
|
-
$(CARGO) build --release -p headroom-proxy
|
|
48
|
-
@BIN=target/release/headroom-proxy; \
|
|
49
|
-
if command -v strip >/dev/null 2>&1; then strip "$$BIN" || true; fi; \
|
|
50
|
-
SIZE=$$(wc -c < "$$BIN"); \
|
|
51
|
-
printf 'headroom-proxy: %s bytes (%.1f MiB)\n' "$$SIZE" "$$(echo "$$SIZE / 1048576" | bc -l)"
|
|
52
|
-
|
|
53
|
-
build-wheel:
|
|
54
|
-
$(MATURIN) build --release -m crates/headroom-py/Cargo.toml
|
|
55
|
-
|
|
56
|
-
# Hotfix-A0: maturin-develop + symlink + import-verify in one shot. Run this
|
|
57
|
-
# any time you suspect the proxy is silently falling back to Python-only
|
|
58
|
-
# mode (Finding #2 in HEADROOM_PROXY_LOG_FINDINGS_2026_05_03.md). The
|
|
59
|
-
# proxy itself runs the same check at lifespan startup; this target
|
|
60
|
-
# exposes it as a developer-facing one-liner.
|
|
61
|
-
verify-rust-core:
|
|
62
|
-
@if [ -z "$$VIRTUAL_ENV" ]; then \
|
|
63
|
-
echo "error: activate a venv first (e.g. source .venv/bin/activate)"; \
|
|
64
|
-
exit 1; \
|
|
65
|
-
fi
|
|
66
|
-
bash scripts/build_rust_extension.sh
|
|
67
|
-
|
|
68
|
-
fmt:
|
|
69
|
-
$(CARGO) fmt --all
|
|
70
|
-
|
|
71
|
-
fmt-check:
|
|
72
|
-
$(CARGO) fmt --all -- --check
|
|
73
|
-
|
|
74
|
-
clippy lint:
|
|
75
|
-
$(CARGO) clippy --workspace -- -D warnings
|
|
76
|
-
|
|
77
|
-
clean:
|
|
78
|
-
$(CARGO) clean
|
|
79
|
-
|
|
80
|
-
# ─── Pre-push CI gate ──────────────────────────────────────────────────────
|
|
81
|
-
#
|
|
82
|
-
# These targets run the same checks GitHub Actions runs, locally. The intent
|
|
83
|
-
# is: if `make ci-precheck` is green, `git push` will not turn red. The
|
|
84
|
-
# 2026-04-27 push surfaced five CI breaks (cargo fmt drift, x86_64-apple-
|
|
85
|
-
# darwin wheel, headroom._core not built in test-extras + smoke-test,
|
|
86
|
-
# commitlint footer-leading-blank). The first three are caught by the gates
|
|
87
|
-
# below; the last two are caught by the workflow fixes themselves.
|
|
88
|
-
#
|
|
89
|
-
# Run before EVERY `git push`. Install the git hook (one-time) with:
|
|
90
|
-
# make install-git-hooks
|
|
91
|
-
|
|
92
|
-
ci-precheck: ci-precheck-rust ci-precheck-python ci-precheck-commitlint
|
|
93
|
-
@echo ""
|
|
94
|
-
@echo "✅ ci-precheck PASSED — safe to push."
|
|
95
|
-
|
|
96
|
-
ci-precheck-rust:
|
|
97
|
-
@echo "── ci-precheck-rust ────────────────────────────────────────────"
|
|
98
|
-
$(CARGO) fmt --all -- --check
|
|
99
|
-
$(CARGO) clippy --workspace -- -D warnings
|
|
100
|
-
$(CARGO) test --workspace
|
|
101
|
-
|
|
102
|
-
# Mirrors the smart_crusher-affected test files we expect green on every
|
|
103
|
-
# push. Builds the Rust extension first because most of these tests
|
|
104
|
-
# instantiate `SmartCrusher`, which hard-imports `headroom._core`.
|
|
105
|
-
ci-precheck-python:
|
|
106
|
-
@echo "── ci-precheck-python ─────────────────────────────────────────"
|
|
107
|
-
@if [ -z "$$VIRTUAL_ENV" ]; then \
|
|
108
|
-
echo "error: activate a venv first (e.g. source .venv/bin/activate)"; \
|
|
109
|
-
exit 1; \
|
|
110
|
-
fi
|
|
111
|
-
bash scripts/build_rust_extension.sh
|
|
112
|
-
$(PYTHON) -m pytest -q \
|
|
113
|
-
tests/test_transforms/test_smart_crusher_bugs.py \
|
|
114
|
-
tests/test_transforms/test_smart_crusher_rust_parity.py \
|
|
115
|
-
tests/test_transforms/test_diff_compressor.py \
|
|
116
|
-
tests/test_transforms/test_diff_compressor_rust_parity.py \
|
|
117
|
-
tests/test_relevance.py \
|
|
118
|
-
tests/test_relevance_extra.py \
|
|
119
|
-
tests/test_ccr.py \
|
|
120
|
-
tests/test_acceptance.py \
|
|
121
|
-
tests/test_critical_fixes.py \
|
|
122
|
-
tests/test_quality_retention.py \
|
|
123
|
-
tests/test_toin_integration.py
|
|
124
|
-
|
|
125
|
-
# Lint commits since `origin/main`. Requires npx (Node 18+) on PATH.
|
|
126
|
-
ci-precheck-commitlint:
|
|
127
|
-
@echo "── ci-precheck-commitlint ─────────────────────────────────────"
|
|
128
|
-
@if ! command -v npx >/dev/null 2>&1; then \
|
|
129
|
-
echo "error: npx not on PATH (install Node 18+ to enable commitlint checks)"; \
|
|
130
|
-
exit 1; \
|
|
131
|
-
fi
|
|
132
|
-
@if ! git rev-parse --verify origin/main >/dev/null 2>&1; then \
|
|
133
|
-
echo "error: origin/main not fetched (run 'git fetch origin main')"; \
|
|
134
|
-
exit 1; \
|
|
135
|
-
fi
|
|
136
|
-
npx --yes --package=@commitlint/cli --package=@commitlint/config-conventional -- \
|
|
137
|
-
commitlint --from origin/main --to HEAD --config .commitlintrc.json
|
|
138
|
-
|
|
139
|
-
install-git-hooks:
|
|
140
|
-
@scripts/install-git-hooks.sh
|
package/NOTICE
DELETED
|
@@ -1,43 +0,0 @@
|
|
|
1
|
-
Headroom
|
|
2
|
-
Copyright 2025 Headroom Contributors
|
|
3
|
-
|
|
4
|
-
This product includes software developed by the Headroom Contributors.
|
|
5
|
-
|
|
6
|
-
Third-Party Licenses
|
|
7
|
-
====================
|
|
8
|
-
|
|
9
|
-
This software uses the following third-party libraries:
|
|
10
|
-
|
|
11
|
-
tiktoken
|
|
12
|
-
--------
|
|
13
|
-
Copyright (c) 2022 OpenAI, Shantanu Jain
|
|
14
|
-
Licensed under the MIT License
|
|
15
|
-
https://github.com/openai/tiktoken
|
|
16
|
-
|
|
17
|
-
Pydantic
|
|
18
|
-
--------
|
|
19
|
-
Copyright (c) 2017 to present Pydantic Services Inc. and individual contributors
|
|
20
|
-
Licensed under the MIT License
|
|
21
|
-
https://github.com/pydantic/pydantic
|
|
22
|
-
|
|
23
|
-
sentence-transformers (optional dependency)
|
|
24
|
-
-------------------------------------------
|
|
25
|
-
Copyright 2019 Nils Reimers
|
|
26
|
-
Licensed under the Apache License 2.0
|
|
27
|
-
https://github.com/UKPLab/sentence-transformers
|
|
28
|
-
|
|
29
|
-
Note: Some pretrained sentence-transformer models may have additional licensing
|
|
30
|
-
restrictions based on their training data. Please verify model-specific licenses
|
|
31
|
-
before commercial use.
|
|
32
|
-
|
|
33
|
-
FastAPI (optional dependency)
|
|
34
|
-
-----------------------------
|
|
35
|
-
Copyright (c) 2018 Sebastián Ramírez
|
|
36
|
-
Licensed under the MIT License
|
|
37
|
-
https://github.com/tiangolo/fastapi
|
|
38
|
-
|
|
39
|
-
NumPy (optional dependency)
|
|
40
|
-
---------------------------
|
|
41
|
-
Copyright (c) 2005-2024, NumPy Developers
|
|
42
|
-
Licensed under the BSD 3-Clause License
|
|
43
|
-
https://github.com/numpy/numpy
|
package/NPM_TOKEN_SETUP.md
DELETED
|
@@ -1,81 +0,0 @@
|
|
|
1
|
-
# GitHub Actions npm Publishing Setup
|
|
2
|
-
|
|
3
|
-
## 🔴 Problem: npm publish failed
|
|
4
|
-
|
|
5
|
-
GitHub Actions braucht einen `NPM_TOKEN` um automatisch zu npm zu publishen.
|
|
6
|
-
|
|
7
|
-
## ✅ Lösung: NPM_TOKEN Secret hinzufügen
|
|
8
|
-
|
|
9
|
-
### 1. npm Token generieren
|
|
10
|
-
|
|
11
|
-
Gehe zu: https://www.npmjs.com/settings/~/tokens
|
|
12
|
-
|
|
13
|
-
Klicke: **"Generate new token"**
|
|
14
|
-
|
|
15
|
-
Typ: **Automation** (wichtig!)
|
|
16
|
-
|
|
17
|
-
Kopiere den generierten Token.
|
|
18
|
-
|
|
19
|
-
### 2. GitHub Secret hinzufügen
|
|
20
|
-
|
|
21
|
-
1. Gehe zu deinem Repository auf GitHub
|
|
22
|
-
2. **Settings** → **Secrets and variables** → **Actions**
|
|
23
|
-
3. Klicke **"New repository secret"**
|
|
24
|
-
4. **Name:** `NPM_TOKEN` (exakt!)
|
|
25
|
-
5. **Value:** (paste den npm token)
|
|
26
|
-
6. Klicke **"Add secret"**
|
|
27
|
-
|
|
28
|
-
### 3. Test
|
|
29
|
-
|
|
30
|
-
Das nächste Mal wenn du einen Push zu `main` machst mit einer neuen Version in `package.json`:
|
|
31
|
-
|
|
32
|
-
```bash
|
|
33
|
-
npm version minor # 1.5.0 → 1.6.0
|
|
34
|
-
git push origin main # Trigger GitHub Actions
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
GitHub Actions wird dann automatisch:
|
|
38
|
-
- ✅ Build das Projekt
|
|
39
|
-
- ✅ npm publish ausführen
|
|
40
|
-
- ✅ Git tag erstellen
|
|
41
|
-
- ✅ GitHub Release erstellen
|
|
42
|
-
|
|
43
|
-
## 🔍 Status überprüfen
|
|
44
|
-
|
|
45
|
-
Gehe zu: **Actions** → Wähle den neuesten Workflow → Schau auf die Logs
|
|
46
|
-
|
|
47
|
-
## 🛠️ Troubleshooting
|
|
48
|
-
|
|
49
|
-
**"need auth"?**
|
|
50
|
-
- Token ist falsch oder expired
|
|
51
|
-
- Generiere einen neuen Token
|
|
52
|
-
|
|
53
|
-
**"already published"?**
|
|
54
|
-
- Die Version existiert bereits auf npm
|
|
55
|
-
- Bump die Version mit: `npm version minor`
|
|
56
|
-
|
|
57
|
-
**Token expired?**
|
|
58
|
-
- npm Tokens laufen nach 30 Tagen Inaktivität ab
|
|
59
|
-
- Generiere einen neuen Token auf npmjs.com
|
|
60
|
-
|
|
61
|
-
## 🔐 Token Sicherheit
|
|
62
|
-
|
|
63
|
-
- Nie im Code committen!
|
|
64
|
-
- Nur auf GitHub als Secret speichern
|
|
65
|
-
- Token regenerieren wenn exposed
|
|
66
|
-
- "Automation" Type für CI/CD (nicht "Granular")
|
|
67
|
-
|
|
68
|
-
## 📊 Beispiel Workflow
|
|
69
|
-
|
|
70
|
-
```
|
|
71
|
-
1. Entwickler: npm version minor
|
|
72
|
-
2. Entwickler: git push origin main
|
|
73
|
-
3. GitHub Actions triggered (automatisch)
|
|
74
|
-
4. Actions: npm ci && npm run build
|
|
75
|
-
5. Actions: npm publish (mit NPM_TOKEN)
|
|
76
|
-
6. Actions: git tag v1.6.0
|
|
77
|
-
7. Actions: GitHub Release erstellen
|
|
78
|
-
8. Benutzer: npm install -g xithead@1.6.0 ✨
|
|
79
|
-
```
|
|
80
|
-
|
|
81
|
-
Das ist es! Alles läuft dann automatisch. 🚀
|