@arthai/agents 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +123 -0
- package/VERSION +1 -0
- package/agents/ai-consultant.md +999 -0
- package/agents/architect.md +174 -0
- package/agents/code-reviewer.md +115 -0
- package/agents/competitive-analyst.md +688 -0
- package/agents/content-strategist.md +607 -0
- package/agents/design-studio-create.md +304 -0
- package/agents/design-studio-critique.md +258 -0
- package/agents/design-studio-think.md +79 -0
- package/agents/domain-hunter.md +519 -0
- package/agents/explore-light.md +52 -0
- package/agents/frontend.md +261 -0
- package/agents/gtm-expert.md +811 -0
- package/agents/meeting-prep.md +318 -0
- package/agents/ops.md +149 -0
- package/agents/product-manager.md +563 -0
- package/agents/python-backend.md +286 -0
- package/agents/qa-baseline-updater.md +45 -0
- package/agents/qa-challenger.md +97 -0
- package/agents/qa-domain.md +145 -0
- package/agents/qa-e2e.md +184 -0
- package/agents/qa-test-promoter.md +97 -0
- package/agents/qa.md +226 -0
- package/agents/setup.md +134 -0
- package/agents/sre.md +165 -0
- package/agents/stakeholder-reporter.md +94 -0
- package/agents/user-researcher.md +602 -0
- package/bin/cli.js +322 -0
- package/bundles/canvas.json +16 -0
- package/bundles/compass.json +16 -0
- package/bundles/counsel.json +31 -0
- package/bundles/cruise.json +11 -0
- package/bundles/forge.json +26 -0
- package/bundles/prime.json +10 -0
- package/bundles/prism.json +23 -0
- package/bundles/scalpel.json +17 -0
- package/bundles/sentinel.json +19 -0
- package/bundles/shield.json +14 -0
- package/bundles/spark.json +19 -0
- package/compiler.sh +305 -0
- package/dist/plugins/canvas/.claude-plugin/plugin.json +6 -0
- package/dist/plugins/canvas/agents/design-studio-create.md +304 -0
- package/dist/plugins/canvas/agents/design-studio-critique.md +258 -0
- package/dist/plugins/canvas/agents/design-studio-think.md +79 -0
- package/dist/plugins/canvas/agents/frontend.md +261 -0
- package/dist/plugins/canvas/skills/planning/SKILL.md +436 -0
- package/dist/plugins/compass/.claude-plugin/plugin.json +6 -0
- package/dist/plugins/compass/agents/content-strategist.md +607 -0
- package/dist/plugins/compass/agents/gtm-expert.md +811 -0
- package/dist/plugins/compass/agents/product-manager.md +563 -0
- package/dist/plugins/compass/agents/user-researcher.md +602 -0
- package/dist/plugins/compass/skills/planning/SKILL.md +436 -0
- package/dist/plugins/counsel/.claude-plugin/plugin.json +6 -0
- package/dist/plugins/counsel/agents/ai-consultant.md +999 -0
- package/dist/plugins/counsel/agents/competitive-analyst.md +688 -0
- package/dist/plugins/counsel/agents/meeting-prep.md +318 -0
- package/dist/plugins/counsel/agents/stakeholder-reporter.md +94 -0
- package/dist/plugins/counsel/hooks/check-deliverable.sh +65 -0
- package/dist/plugins/counsel/hooks/ensure-client-dir.sh +59 -0
- package/dist/plugins/counsel/hooks/hooks.json +28 -0
- package/dist/plugins/counsel/skills/client-discovery/SKILL.md +266 -0
- package/dist/plugins/counsel/skills/consulting/SKILL.md +282 -0
- package/dist/plugins/counsel/skills/deliverable-builder/SKILL.md +928 -0
- package/dist/plugins/counsel/skills/engagement-tracker/SKILL.md +380 -0
- package/dist/plugins/counsel/skills/market-research/SKILL.md +300 -0
- package/dist/plugins/counsel/skills/opportunity-map/SKILL.md +307 -0
- package/dist/plugins/counsel/skills/pitch-generator/SKILL.md +378 -0
- package/dist/plugins/counsel/skills/roi-calculator/SKILL.md +469 -0
- package/dist/plugins/counsel/skills/share/SKILL.md +211 -0
- package/dist/plugins/counsel/skills/solution-architect/SKILL.md +566 -0
- package/dist/plugins/counsel/skills/templates/SKILL.md +194 -0
- package/dist/plugins/counsel/skills/welcome/SKILL.md +136 -0
- package/dist/plugins/counsel/skills/wizard/SKILL.md +411 -0
- package/dist/plugins/cruise/.claude-plugin/plugin.json +6 -0
- package/dist/plugins/cruise/skills/autopilot/SKILL.md +425 -0
- package/dist/plugins/forge/.claude-plugin/plugin.json +6 -0
- package/dist/plugins/forge/agents/architect.md +174 -0
- package/dist/plugins/forge/agents/code-reviewer.md +115 -0
- package/dist/plugins/forge/agents/frontend.md +261 -0
- package/dist/plugins/forge/agents/product-manager.md +563 -0
- package/dist/plugins/forge/agents/python-backend.md +286 -0
- package/dist/plugins/forge/agents/qa.md +226 -0
- package/dist/plugins/forge/hooks/hooks.json +28 -0
- package/dist/plugins/forge/hooks/post-test-summary.sh +115 -0
- package/dist/plugins/forge/hooks/triage-router.sh +740 -0
- package/dist/plugins/forge/skills/implement/SKILL.md +532 -0
- package/dist/plugins/forge/skills/planning/SKILL.md +436 -0
- package/dist/plugins/forge/skills/pr/SKILL.md +275 -0
- package/dist/plugins/forge/skills/precheck/SKILL.md +159 -0
- package/dist/plugins/forge/skills/qa/SKILL.md +127 -0
- package/dist/plugins/forge/skills/review-pr/SKILL.md +367 -0
- package/dist/plugins/prime/.claude-plugin/plugin.json +6 -0
- package/dist/plugins/prime/agents/ai-consultant.md +999 -0
- package/dist/plugins/prime/agents/architect.md +174 -0
- package/dist/plugins/prime/agents/code-reviewer.md +115 -0
- package/dist/plugins/prime/agents/competitive-analyst.md +688 -0
- package/dist/plugins/prime/agents/content-strategist.md +607 -0
- package/dist/plugins/prime/agents/design-studio-create.md +304 -0
- package/dist/plugins/prime/agents/design-studio-critique.md +258 -0
- package/dist/plugins/prime/agents/design-studio-think.md +79 -0
- package/dist/plugins/prime/agents/explore-light.md +52 -0
- package/dist/plugins/prime/agents/frontend.md +261 -0
- package/dist/plugins/prime/agents/gtm-expert.md +811 -0
- package/dist/plugins/prime/agents/meeting-prep.md +318 -0
- package/dist/plugins/prime/agents/ops.md +149 -0
- package/dist/plugins/prime/agents/product-manager.md +563 -0
- package/dist/plugins/prime/agents/python-backend.md +286 -0
- package/dist/plugins/prime/agents/qa-baseline-updater.md +45 -0
- package/dist/plugins/prime/agents/qa-challenger.md +97 -0
- package/dist/plugins/prime/agents/qa-domain.md +145 -0
- package/dist/plugins/prime/agents/qa-e2e.md +184 -0
- package/dist/plugins/prime/agents/qa-test-promoter.md +97 -0
- package/dist/plugins/prime/agents/qa.md +226 -0
- package/dist/plugins/prime/agents/setup.md +134 -0
- package/dist/plugins/prime/agents/sre.md +165 -0
- package/dist/plugins/prime/agents/stakeholder-reporter.md +94 -0
- package/dist/plugins/prime/agents/user-researcher.md +602 -0
- package/dist/plugins/prime/hooks/check-deliverable.sh +65 -0
- package/dist/plugins/prime/hooks/ensure-client-dir.sh +59 -0
- package/dist/plugins/prime/hooks/hooks.json +184 -0
- package/dist/plugins/prime/hooks/post-deploy-health.sh +83 -0
- package/dist/plugins/prime/hooks/post-diff-test-compare.sh +125 -0
- package/dist/plugins/prime/hooks/post-edit-lint.sh +92 -0
- package/dist/plugins/prime/hooks/post-git-state.sh +54 -0
- package/dist/plugins/prime/hooks/post-merge-cleanup.sh +101 -0
- package/dist/plugins/prime/hooks/post-test-summary.sh +115 -0
- package/dist/plugins/prime/hooks/pre-bash-guard.sh +142 -0
- package/dist/plugins/prime/hooks/pre-edit-guard.sh +121 -0
- package/dist/plugins/prime/hooks/pre-task-context.sh +113 -0
- package/dist/plugins/prime/hooks/session-bootstrap.sh +379 -0
- package/dist/plugins/prime/hooks/session-end.sh +107 -0
- package/dist/plugins/prime/hooks/session-summary.sh +97 -0
- package/dist/plugins/prime/hooks/sync-agents.sh +269 -0
- package/dist/plugins/prime/hooks/triage-router.sh +740 -0
- package/dist/plugins/prime/skills/arth/SKILL.md +165 -0
- package/dist/plugins/prime/skills/autopilot/SKILL.md +425 -0
- package/dist/plugins/prime/skills/calibrate/SKILL.md +1807 -0
- package/dist/plugins/prime/skills/ci-fix/SKILL.md +293 -0
- package/dist/plugins/prime/skills/client-discovery/SKILL.md +266 -0
- package/dist/plugins/prime/skills/consulting/SKILL.md +282 -0
- package/dist/plugins/prime/skills/custom-domain/SKILL.md +261 -0
- package/dist/plugins/prime/skills/deliverable-builder/SKILL.md +928 -0
- package/dist/plugins/prime/skills/discord-ops/SKILL.md +125 -0
- package/dist/plugins/prime/skills/engagement-tracker/SKILL.md +380 -0
- package/dist/plugins/prime/skills/explore.md +43 -0
- package/dist/plugins/prime/skills/fix/SKILL.md +1058 -0
- package/dist/plugins/prime/skills/implement/SKILL.md +532 -0
- package/dist/plugins/prime/skills/incident/SKILL.md +910 -0
- package/dist/plugins/prime/skills/issue/SKILL.md +134 -0
- package/dist/plugins/prime/skills/market-research/SKILL.md +300 -0
- package/dist/plugins/prime/skills/onboard/SKILL.md +344 -0
- package/dist/plugins/prime/skills/opportunity-map/SKILL.md +307 -0
- package/dist/plugins/prime/skills/pitch-generator/SKILL.md +378 -0
- package/dist/plugins/prime/skills/planning/SKILL.md +436 -0
- package/dist/plugins/prime/skills/pr/SKILL.md +275 -0
- package/dist/plugins/prime/skills/precheck/SKILL.md +159 -0
- package/dist/plugins/prime/skills/qa/SKILL.md +127 -0
- package/dist/plugins/prime/skills/qa-incident/SKILL.md +54 -0
- package/dist/plugins/prime/skills/qa-learn/SKILL.md +47 -0
- package/dist/plugins/prime/skills/restart/SKILL.md +70 -0
- package/dist/plugins/prime/skills/review-pr/SKILL.md +367 -0
- package/dist/plugins/prime/skills/roi-calculator/SKILL.md +469 -0
- package/dist/plugins/prime/skills/scan/SKILL.md +232 -0
- package/dist/plugins/prime/skills/setup/SKILL.md +691 -0
- package/dist/plugins/prime/skills/share/SKILL.md +211 -0
- package/dist/plugins/prime/skills/solution-architect/SKILL.md +566 -0
- package/dist/plugins/prime/skills/sre/SKILL.md +362 -0
- package/dist/plugins/prime/skills/sync/SKILL.md +188 -0
- package/dist/plugins/prime/skills/templates/SKILL.md +194 -0
- package/dist/plugins/prime/skills/welcome/SKILL.md +136 -0
- package/dist/plugins/prime/skills/wizard/SKILL.md +411 -0
- package/dist/plugins/prism/.claude-plugin/plugin.json +6 -0
- package/dist/plugins/prism/agents/qa-baseline-updater.md +45 -0
- package/dist/plugins/prism/agents/qa-challenger.md +97 -0
- package/dist/plugins/prism/agents/qa-domain.md +145 -0
- package/dist/plugins/prism/agents/qa-e2e.md +184 -0
- package/dist/plugins/prism/agents/qa-test-promoter.md +97 -0
- package/dist/plugins/prism/agents/qa.md +226 -0
- package/dist/plugins/prism/hooks/hooks.json +26 -0
- package/dist/plugins/prism/hooks/post-diff-test-compare.sh +125 -0
- package/dist/plugins/prism/hooks/post-test-summary.sh +115 -0
- package/dist/plugins/prism/skills/qa/SKILL.md +127 -0
- package/dist/plugins/prism/skills/qa-incident/SKILL.md +54 -0
- package/dist/plugins/prism/skills/qa-learn/SKILL.md +47 -0
- package/dist/plugins/scalpel/.claude-plugin/plugin.json +6 -0
- package/dist/plugins/scalpel/agents/code-reviewer.md +115 -0
- package/dist/plugins/scalpel/hooks/hooks.json +26 -0
- package/dist/plugins/scalpel/hooks/pre-edit-guard.sh +121 -0
- package/dist/plugins/scalpel/skills/ci-fix/SKILL.md +293 -0
- package/dist/plugins/scalpel/skills/fix/SKILL.md +1058 -0
- package/dist/plugins/scalpel/skills/issue/SKILL.md +134 -0
- package/dist/plugins/sentinel/.claude-plugin/plugin.json +6 -0
- package/dist/plugins/sentinel/agents/ops.md +149 -0
- package/dist/plugins/sentinel/agents/sre.md +165 -0
- package/dist/plugins/sentinel/hooks/hooks.json +26 -0
- package/dist/plugins/sentinel/hooks/post-deploy-health.sh +83 -0
- package/dist/plugins/sentinel/hooks/post-git-state.sh +54 -0
- package/dist/plugins/sentinel/skills/incident/SKILL.md +910 -0
- package/dist/plugins/sentinel/skills/restart/SKILL.md +70 -0
- package/dist/plugins/sentinel/skills/sre/SKILL.md +362 -0
- package/dist/plugins/shield/.claude-plugin/plugin.json +6 -0
- package/dist/plugins/shield/hooks/hooks.json +60 -0
- package/dist/plugins/shield/hooks/pre-bash-guard.sh +142 -0
- package/dist/plugins/shield/hooks/pre-edit-guard.sh +121 -0
- package/dist/plugins/shield/hooks/session-bootstrap.sh +379 -0
- package/dist/plugins/shield/hooks/triage-router.sh +740 -0
- package/dist/plugins/spark/.claude-plugin/plugin.json +6 -0
- package/dist/plugins/spark/agents/explore-light.md +52 -0
- package/dist/plugins/spark/agents/setup.md +134 -0
- package/dist/plugins/spark/hooks/hooks.json +16 -0
- package/dist/plugins/spark/hooks/session-bootstrap.sh +379 -0
- package/dist/plugins/spark/skills/calibrate/SKILL.md +1807 -0
- package/dist/plugins/spark/skills/onboard/SKILL.md +344 -0
- package/dist/plugins/spark/skills/scan/SKILL.md +232 -0
- package/dist/plugins/spark/skills/setup/SKILL.md +691 -0
- package/hook-defs.json +104 -0
- package/hooks/check-deliverable.sh +65 -0
- package/hooks/ensure-client-dir.sh +59 -0
- package/hooks/hooks.json +16 -0
- package/hooks/post-deploy-health.sh +83 -0
- package/hooks/post-diff-test-compare.sh +125 -0
- package/hooks/post-edit-lint.sh +92 -0
- package/hooks/post-git-state.sh +54 -0
- package/hooks/post-merge-cleanup.sh +101 -0
- package/hooks/post-test-summary.sh +115 -0
- package/hooks/pre-bash-guard.sh +142 -0
- package/hooks/pre-edit-guard.sh +121 -0
- package/hooks/pre-task-context.sh +113 -0
- package/hooks/session-bootstrap.sh +379 -0
- package/hooks/session-end.sh +107 -0
- package/hooks/session-start.sh +46 -0
- package/hooks/session-summary.sh +97 -0
- package/hooks/sync-agents.sh +269 -0
- package/hooks/triage-router.sh +740 -0
- package/install.sh +3185 -0
- package/package.json +40 -0
- package/portable.manifest +112 -0
- package/skills/arth/SKILL.md +165 -0
- package/skills/autopilot/SKILL.md +425 -0
- package/skills/calibrate/SKILL.md +1807 -0
- package/skills/ci-fix/SKILL.md +293 -0
- package/skills/client-discovery/SKILL.md +266 -0
- package/skills/consulting/SKILL.md +282 -0
- package/skills/continue/SKILL.md +174 -0
- package/skills/custom-domain/SKILL.md +261 -0
- package/skills/deliverable-builder/SKILL.md +928 -0
- package/skills/discord-ops/SKILL.md +125 -0
- package/skills/engagement-tracker/SKILL.md +380 -0
- package/skills/explore.md +43 -0
- package/skills/fix/SKILL.md +1058 -0
- package/skills/implement/SKILL.md +532 -0
- package/skills/incident/SKILL.md +910 -0
- package/skills/issue/SKILL.md +134 -0
- package/skills/market-research/SKILL.md +300 -0
- package/skills/onboard/SKILL.md +344 -0
- package/skills/opportunity-map/SKILL.md +307 -0
- package/skills/pitch-generator/SKILL.md +378 -0
- package/skills/planning/SKILL.md +436 -0
- package/skills/pr/SKILL.md +275 -0
- package/skills/precheck/SKILL.md +159 -0
- package/skills/qa/SKILL.md +127 -0
- package/skills/qa-incident/SKILL.md +54 -0
- package/skills/qa-learn/SKILL.md +47 -0
- package/skills/railway/central-station/SKILL.md +226 -0
- package/skills/railway/central-station/references/environment-config.md +183 -0
- package/skills/railway/central-station/references/monorepo.md +216 -0
- package/skills/railway/central-station/references/railpack.md +257 -0
- package/skills/railway/central-station/references/variables.md +170 -0
- package/skills/railway/database/SKILL.md +284 -0
- package/skills/railway/database/references/environment-config.md +183 -0
- package/skills/railway/database/references/monorepo.md +216 -0
- package/skills/railway/database/references/railpack.md +257 -0
- package/skills/railway/database/references/variables.md +170 -0
- package/skills/railway/database/scripts/railway-api.sh +41 -0
- package/skills/railway/deploy/SKILL.md +128 -0
- package/skills/railway/deploy/references/environment-config.md +183 -0
- package/skills/railway/deploy/references/monorepo.md +216 -0
- package/skills/railway/deploy/references/railpack.md +257 -0
- package/skills/railway/deploy/references/variables.md +170 -0
- package/skills/railway/deployment/SKILL.md +222 -0
- package/skills/railway/deployment/references/environment-config.md +183 -0
- package/skills/railway/deployment/references/monorepo.md +216 -0
- package/skills/railway/deployment/references/railpack.md +257 -0
- package/skills/railway/deployment/references/variables.md +170 -0
- package/skills/railway/domain/SKILL.md +137 -0
- package/skills/railway/domain/references/environment-config.md +183 -0
- package/skills/railway/domain/references/monorepo.md +216 -0
- package/skills/railway/domain/references/railpack.md +257 -0
- package/skills/railway/domain/references/variables.md +170 -0
- package/skills/railway/environment/SKILL.md +266 -0
- package/skills/railway/environment/references/environment-config.md +183 -0
- package/skills/railway/environment/references/monorepo.md +216 -0
- package/skills/railway/environment/references/railpack.md +257 -0
- package/skills/railway/environment/references/variables.md +170 -0
- package/skills/railway/metrics/SKILL.md +211 -0
- package/skills/railway/metrics/references/environment-config.md +183 -0
- package/skills/railway/metrics/references/monorepo.md +216 -0
- package/skills/railway/metrics/references/railpack.md +257 -0
- package/skills/railway/metrics/references/variables.md +170 -0
- package/skills/railway/metrics/scripts/railway-api.sh +41 -0
- package/skills/railway/new/SKILL.md +489 -0
- package/skills/railway/new/references/environment-config.md +183 -0
- package/skills/railway/new/references/monorepo.md +216 -0
- package/skills/railway/new/references/railpack.md +257 -0
- package/skills/railway/new/references/variables.md +170 -0
- package/skills/railway/projects/SKILL.md +142 -0
- package/skills/railway/projects/references/environment-config.md +183 -0
- package/skills/railway/projects/references/monorepo.md +216 -0
- package/skills/railway/projects/references/railpack.md +257 -0
- package/skills/railway/projects/references/variables.md +170 -0
- package/skills/railway/projects/scripts/railway-api.sh +41 -0
- package/skills/railway/railway-docs/SKILL.md +47 -0
- package/skills/railway/railway-docs/references/environment-config.md +183 -0
- package/skills/railway/railway-docs/references/monorepo.md +216 -0
- package/skills/railway/railway-docs/references/railpack.md +257 -0
- package/skills/railway/railway-docs/references/variables.md +170 -0
- package/skills/railway/service/SKILL.md +249 -0
- package/skills/railway/service/references/environment-config.md +183 -0
- package/skills/railway/service/references/monorepo.md +216 -0
- package/skills/railway/service/references/railpack.md +257 -0
- package/skills/railway/service/references/variables.md +170 -0
- package/skills/railway/service/scripts/railway-api.sh +41 -0
- package/skills/railway/status/SKILL.md +91 -0
- package/skills/railway/status/references/environment-config.md +183 -0
- package/skills/railway/status/references/monorepo.md +216 -0
- package/skills/railway/status/references/railpack.md +257 -0
- package/skills/railway/status/references/variables.md +170 -0
- package/skills/railway/templates/SKILL.md +275 -0
- package/skills/railway/templates/references/environment-config.md +183 -0
- package/skills/railway/templates/references/monorepo.md +216 -0
- package/skills/railway/templates/references/railpack.md +257 -0
- package/skills/railway/templates/references/variables.md +170 -0
- package/skills/railway/templates/scripts/railway-api.sh +41 -0
- package/skills/restart/SKILL.md +70 -0
- package/skills/review-pr/SKILL.md +367 -0
- package/skills/roi-calculator/SKILL.md +469 -0
- package/skills/scan/SKILL.md +232 -0
- package/skills/setup/SKILL.md +691 -0
- package/skills/share/SKILL.md +211 -0
- package/skills/solution-architect/SKILL.md +566 -0
- package/skills/sre/SKILL.md +362 -0
- package/skills/superpowers/brainstorming/SKILL.md +96 -0
- package/skills/superpowers/dispatching-parallel-agents/SKILL.md +180 -0
- package/skills/superpowers/executing-plans/SKILL.md +84 -0
- package/skills/superpowers/finishing-a-development-branch/SKILL.md +200 -0
- package/skills/superpowers/receiving-code-review/SKILL.md +213 -0
- package/skills/superpowers/requesting-code-review/SKILL.md +105 -0
- package/skills/superpowers/requesting-code-review/code-reviewer.md +146 -0
- package/skills/superpowers/subagent-driven-development/SKILL.md +242 -0
- package/skills/superpowers/subagent-driven-development/code-quality-reviewer-prompt.md +20 -0
- package/skills/superpowers/subagent-driven-development/implementer-prompt.md +78 -0
- package/skills/superpowers/subagent-driven-development/spec-reviewer-prompt.md +61 -0
- package/skills/superpowers/systematic-debugging/CREATION-LOG.md +119 -0
- package/skills/superpowers/systematic-debugging/SKILL.md +296 -0
- package/skills/superpowers/systematic-debugging/condition-based-waiting-example.ts +158 -0
- package/skills/superpowers/systematic-debugging/condition-based-waiting.md +115 -0
- package/skills/superpowers/systematic-debugging/defense-in-depth.md +122 -0
- package/skills/superpowers/systematic-debugging/find-polluter.sh +63 -0
- package/skills/superpowers/systematic-debugging/root-cause-tracing.md +169 -0
- package/skills/superpowers/systematic-debugging/test-academic.md +14 -0
- package/skills/superpowers/systematic-debugging/test-pressure-1.md +58 -0
- package/skills/superpowers/systematic-debugging/test-pressure-2.md +68 -0
- package/skills/superpowers/systematic-debugging/test-pressure-3.md +69 -0
- package/skills/superpowers/test-driven-development/SKILL.md +371 -0
- package/skills/superpowers/test-driven-development/testing-anti-patterns.md +299 -0
- package/skills/superpowers/using-git-worktrees/SKILL.md +218 -0
- package/skills/superpowers/using-superpowers/SKILL.md +95 -0
- package/skills/superpowers/verification-before-completion/SKILL.md +139 -0
- package/skills/superpowers/writing-plans/SKILL.md +116 -0
- package/skills/superpowers/writing-skills/SKILL.md +655 -0
- package/skills/superpowers/writing-skills/anthropic-best-practices.md +1150 -0
- package/skills/superpowers/writing-skills/examples/CLAUDE_MD_TESTING.md +189 -0
- package/skills/superpowers/writing-skills/graphviz-conventions.dot +172 -0
- package/skills/superpowers/writing-skills/persuasion-principles.md +187 -0
- package/skills/superpowers/writing-skills/render-graphs.js +168 -0
- package/skills/superpowers/writing-skills/testing-skills-with-subagents.md +384 -0
- package/skills/sync/SKILL.md +188 -0
- package/skills/templates/SKILL.md +194 -0
- package/skills/welcome/SKILL.md +136 -0
- package/skills/wizard/SKILL.md +411 -0
- package/templates/CLAUDE.md.managed-block +123 -0
- package/templates/CLAUDE.md.template +111 -0
- package/templates/consulting/engagement-tracker-template.md +181 -0
- package/templates/consulting/executive-summary-template.md +83 -0
- package/templates/consulting/maturity-assessment-template.md +182 -0
- package/templates/consulting/proposal-template.md +209 -0
- package/templates/consulting/roi-model-template.md +139 -0
- package/templates/consulting/solution-architecture-template.md +313 -0
- package/templates/settings.json +130 -0
|
@@ -0,0 +1,170 @@
|
|
|
1
|
+
# Variables Reference
|
|
2
|
+
|
|
3
|
+
Variables in Railway support references to other services, shared variables, and Railway-provided values.
|
|
4
|
+
|
|
5
|
+
## Template Syntax
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
${{NAMESPACE.VAR}}
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
| Namespace | Description |
|
|
12
|
+
|-----------|-------------|
|
|
13
|
+
| `shared` | Shared variables (project-wide) |
|
|
14
|
+
| `<serviceName>` | Variables from another service (case-sensitive) |
|
|
15
|
+
|
|
16
|
+
## Examples
|
|
17
|
+
|
|
18
|
+
**Reference shared variable:**
|
|
19
|
+
```json
|
|
20
|
+
{ "value": "${{shared.DOMAIN}}" }
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
**Reference another service's variable:**
|
|
24
|
+
```json
|
|
25
|
+
{ "value": "${{api.API_KEY}}" }
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
**Combine with text:**
|
|
29
|
+
```json
|
|
30
|
+
{ "value": "https://${{shared.DOMAIN}}/api" }
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Railway-Provided Variables
|
|
34
|
+
|
|
35
|
+
Railway injects these into every service automatically.
|
|
36
|
+
|
|
37
|
+
### Networking
|
|
38
|
+
| Variable | Description | Example | Availability |
|
|
39
|
+
|----------|-------------|---------|--------------|
|
|
40
|
+
| `RAILWAY_PUBLIC_DOMAIN` | Public domain | `myapp.up.railway.app` | Only if service has a domain |
|
|
41
|
+
| `RAILWAY_PRIVATE_DOMAIN` | Private DNS (internal only) | `myapp.railway.internal` | Always |
|
|
42
|
+
| `RAILWAY_TCP_PROXY_DOMAIN` | TCP proxy domain | `roundhouse.proxy.rlwy.net` | Only if TCP proxy enabled |
|
|
43
|
+
| `RAILWAY_TCP_PROXY_PORT` | TCP proxy port | `11105` | Only if TCP proxy enabled |
|
|
44
|
+
|
|
45
|
+
**Note:** `RAILWAY_PUBLIC_DOMAIN` is only available if the service has a domain configured.
|
|
46
|
+
Check the service's environment config to verify a domain exists before referencing it.
|
|
47
|
+
|
|
48
|
+
### Context
|
|
49
|
+
| Variable | Description |
|
|
50
|
+
|----------|-------------|
|
|
51
|
+
| `RAILWAY_PROJECT_ID` | Project ID |
|
|
52
|
+
| `RAILWAY_PROJECT_NAME` | Project name |
|
|
53
|
+
| `RAILWAY_ENVIRONMENT_ID` | Environment ID |
|
|
54
|
+
| `RAILWAY_ENVIRONMENT_NAME` | Environment name |
|
|
55
|
+
| `RAILWAY_SERVICE_ID` | Service ID |
|
|
56
|
+
| `RAILWAY_SERVICE_NAME` | Service name |
|
|
57
|
+
| `RAILWAY_DEPLOYMENT_ID` | Deployment ID |
|
|
58
|
+
| `RAILWAY_REPLICA_ID` | Replica ID |
|
|
59
|
+
| `RAILWAY_REPLICA_REGION` | Region (e.g., `us-west2`) |
|
|
60
|
+
|
|
61
|
+
### Volume (if attached)
|
|
62
|
+
| Variable | Description |
|
|
63
|
+
|----------|-------------|
|
|
64
|
+
| `RAILWAY_VOLUME_NAME` | Volume name |
|
|
65
|
+
| `RAILWAY_VOLUME_MOUNT_PATH` | Mount path |
|
|
66
|
+
|
|
67
|
+
### Git (if deployed from GitHub)
|
|
68
|
+
| Variable | Description |
|
|
69
|
+
|----------|-------------|
|
|
70
|
+
| `RAILWAY_GIT_COMMIT_SHA` | Commit SHA |
|
|
71
|
+
| `RAILWAY_GIT_BRANCH` | Branch name |
|
|
72
|
+
| `RAILWAY_GIT_REPO_NAME` | Repository name |
|
|
73
|
+
| `RAILWAY_GIT_REPO_OWNER` | Repository owner |
|
|
74
|
+
| `RAILWAY_GIT_AUTHOR` | Commit author |
|
|
75
|
+
| `RAILWAY_GIT_COMMIT_MESSAGE` | Commit message |
|
|
76
|
+
|
|
77
|
+
## Wiring Services Together
|
|
78
|
+
|
|
79
|
+
### Frontend → Backend (public network)
|
|
80
|
+
Use when: Browser makes requests to API (browser can't access private network)
|
|
81
|
+
|
|
82
|
+
```json
|
|
83
|
+
{
|
|
84
|
+
"services": {
|
|
85
|
+
"<frontendId>": {
|
|
86
|
+
"variables": {
|
|
87
|
+
"API_URL": { "value": "https://${{backend.RAILWAY_PUBLIC_DOMAIN}}" }
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### Service → Database (private network)
|
|
95
|
+
Use when: Backend connects to database (faster, no egress cost, more secure)
|
|
96
|
+
|
|
97
|
+
Railway databases auto-generate connection URL variables. Use the private versions:
|
|
98
|
+
|
|
99
|
+
| Database | Variable Reference |
|
|
100
|
+
|----------|-------------------|
|
|
101
|
+
| Postgres | `${{Postgres.DATABASE_URL}}` |
|
|
102
|
+
| MySQL | `${{MySQL.DATABASE_URL}}` |
|
|
103
|
+
| Redis | `${{Redis.REDIS_URL}}` |
|
|
104
|
+
| Mongo | `${{Mongo.MONGO_URL}}` |
|
|
105
|
+
|
|
106
|
+
**Postgres/MySQL example:**
|
|
107
|
+
```json
|
|
108
|
+
{
|
|
109
|
+
"services": {
|
|
110
|
+
"<apiId>": {
|
|
111
|
+
"variables": {
|
|
112
|
+
"DATABASE_URL": { "value": "${{Postgres.DATABASE_URL}}" }
|
|
113
|
+
}
|
|
114
|
+
}
|
|
115
|
+
}
|
|
116
|
+
}
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
**Redis example:**
|
|
120
|
+
```json
|
|
121
|
+
{
|
|
122
|
+
"services": {
|
|
123
|
+
"<apiId>": {
|
|
124
|
+
"variables": {
|
|
125
|
+
"REDIS_URL": { "value": "${{Redis.REDIS_URL}}" }
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
**Mongo example:**
|
|
133
|
+
```json
|
|
134
|
+
{
|
|
135
|
+
"services": {
|
|
136
|
+
"<apiId>": {
|
|
137
|
+
"variables": {
|
|
138
|
+
"MONGO_URL": { "value": "${{Mongo.MONGO_URL}}" }
|
|
139
|
+
}
|
|
140
|
+
}
|
|
141
|
+
}
|
|
142
|
+
}
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
**Note:** Service names are case-sensitive. Match the exact name from your project (e.g., "Postgres", "Redis").
|
|
146
|
+
|
|
147
|
+
### Service → Service (private network)
|
|
148
|
+
Use when: Microservices communicate internally
|
|
149
|
+
|
|
150
|
+
```json
|
|
151
|
+
{
|
|
152
|
+
"services": {
|
|
153
|
+
"<workerServiceId>": {
|
|
154
|
+
"variables": {
|
|
155
|
+
"API_INTERNAL_URL": { "value": "http://${{api.RAILWAY_PRIVATE_DOMAIN}}:${{api.PORT}}" }
|
|
156
|
+
}
|
|
157
|
+
}
|
|
158
|
+
}
|
|
159
|
+
}
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
## When to Use Public vs Private
|
|
163
|
+
|
|
164
|
+
| Use Case | Domain | Reason |
|
|
165
|
+
|----------|--------|--------|
|
|
166
|
+
| Browser → API | Public | Browser can't access private network |
|
|
167
|
+
| Service → Service | Private | Faster, no egress, more secure |
|
|
168
|
+
| Service → Database | Private | Databases should never be public |
|
|
169
|
+
| External webhook → Service | Public | External services need public access |
|
|
170
|
+
| Cron job → API | Private | Internal communication |
|
|
@@ -0,0 +1,275 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: templates
|
|
3
|
+
description: This skill should be used when the user wants to add a service from a template, find templates for a specific use case, or deploy tools like Ghost, Strapi, n8n, Minio, Uptime Kuma, etc. For databases (Postgres, Redis, MySQL, MongoDB), prefer the database skill.
|
|
4
|
+
allowed-tools: Bash(railway:*)
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Templates
|
|
8
|
+
|
|
9
|
+
Search and deploy services from Railway's template marketplace.
|
|
10
|
+
|
|
11
|
+
## When to Use
|
|
12
|
+
|
|
13
|
+
- User asks to "add Postgres", "add Redis", "add a database"
|
|
14
|
+
- User asks to "add Ghost", "add Strapi", "add n8n", or any other service
|
|
15
|
+
- User wants to find templates for a use case (e.g., "CMS", "storage", "monitoring")
|
|
16
|
+
- User asks "what templates are available?"
|
|
17
|
+
- User wants to deploy a pre-configured service
|
|
18
|
+
|
|
19
|
+
## Common Template Codes
|
|
20
|
+
|
|
21
|
+
| Category | Template | Code |
|
|
22
|
+
|----------|----------|------|
|
|
23
|
+
| **Databases** | PostgreSQL | `postgres` |
|
|
24
|
+
| | Redis | `redis` |
|
|
25
|
+
| | MySQL | `mysql` |
|
|
26
|
+
| | MongoDB | `mongodb` |
|
|
27
|
+
| **CMS** | Ghost | `ghost` |
|
|
28
|
+
| | Strapi | `strapi` |
|
|
29
|
+
| **Storage** | Minio | `minio` |
|
|
30
|
+
| **Automation** | n8n | `n8n` |
|
|
31
|
+
| **Monitoring** | Uptime Kuma | `uptime-kuma` |
|
|
32
|
+
|
|
33
|
+
For other templates, use the search query below.
|
|
34
|
+
|
|
35
|
+
## Prerequisites
|
|
36
|
+
|
|
37
|
+
Get project context:
|
|
38
|
+
```bash
|
|
39
|
+
railway status --json
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
Extract:
|
|
43
|
+
- `id` - project ID
|
|
44
|
+
- `environments.edges[0].node.id` - environment ID
|
|
45
|
+
|
|
46
|
+
Get workspace ID:
|
|
47
|
+
```bash
|
|
48
|
+
bash <<'SCRIPT'
|
|
49
|
+
scripts/railway-api.sh \
|
|
50
|
+
'query getWorkspace($projectId: String!) {
|
|
51
|
+
project(id: $projectId) { workspaceId }
|
|
52
|
+
}' \
|
|
53
|
+
'{"projectId": "PROJECT_ID"}'
|
|
54
|
+
SCRIPT
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## Search Templates
|
|
58
|
+
|
|
59
|
+
List available templates with optional filters:
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
bash <<'SCRIPT'
|
|
63
|
+
scripts/railway-api.sh \
|
|
64
|
+
'query templates($first: Int, $verified: Boolean) {
|
|
65
|
+
templates(first: $first, verified: $verified) {
|
|
66
|
+
edges {
|
|
67
|
+
node {
|
|
68
|
+
name
|
|
69
|
+
code
|
|
70
|
+
description
|
|
71
|
+
category
|
|
72
|
+
}
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
}' \
|
|
76
|
+
'{"first": 20, "verified": true}'
|
|
77
|
+
SCRIPT
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
### Arguments
|
|
81
|
+
|
|
82
|
+
| Argument | Type | Description |
|
|
83
|
+
|----------|------|-------------|
|
|
84
|
+
| `first` | Int | Number of results (max ~100) |
|
|
85
|
+
| `verified` | Boolean | Only verified templates |
|
|
86
|
+
| `recommended` | Boolean | Only recommended templates |
|
|
87
|
+
|
|
88
|
+
### Rate Limit
|
|
89
|
+
|
|
90
|
+
10 requests per minute. Don't spam searches.
|
|
91
|
+
|
|
92
|
+
## Get Template Details
|
|
93
|
+
|
|
94
|
+
Fetch a specific template by code:
|
|
95
|
+
|
|
96
|
+
```bash
|
|
97
|
+
bash <<'SCRIPT'
|
|
98
|
+
scripts/railway-api.sh \
|
|
99
|
+
'query template($code: String!) {
|
|
100
|
+
template(code: $code) {
|
|
101
|
+
id
|
|
102
|
+
name
|
|
103
|
+
description
|
|
104
|
+
serializedConfig
|
|
105
|
+
}
|
|
106
|
+
}' \
|
|
107
|
+
'{"code": "postgres"}'
|
|
108
|
+
SCRIPT
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
Returns:
|
|
112
|
+
- `id` - template ID (needed for deployment)
|
|
113
|
+
- `serializedConfig` - service configuration (needed for deployment)
|
|
114
|
+
|
|
115
|
+
## Deploy Template
|
|
116
|
+
|
|
117
|
+
### Step 1: Fetch Template
|
|
118
|
+
|
|
119
|
+
```bash
|
|
120
|
+
bash <<'SCRIPT'
|
|
121
|
+
scripts/railway-api.sh \
|
|
122
|
+
'query template($code: String!) {
|
|
123
|
+
template(code: $code) {
|
|
124
|
+
id
|
|
125
|
+
serializedConfig
|
|
126
|
+
}
|
|
127
|
+
}' \
|
|
128
|
+
'{"code": "postgres"}'
|
|
129
|
+
SCRIPT
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
### Step 2: Deploy to Project
|
|
133
|
+
|
|
134
|
+
```bash
|
|
135
|
+
bash <<'SCRIPT'
|
|
136
|
+
scripts/railway-api.sh \
|
|
137
|
+
'mutation deployTemplate($input: TemplateDeployV2Input!) {
|
|
138
|
+
templateDeployV2(input: $input) {
|
|
139
|
+
projectId
|
|
140
|
+
workflowId
|
|
141
|
+
}
|
|
142
|
+
}' \
|
|
143
|
+
'{
|
|
144
|
+
"input": {
|
|
145
|
+
"templateId": "TEMPLATE_ID_FROM_STEP_1",
|
|
146
|
+
"serializedConfig": SERIALIZED_CONFIG_FROM_STEP_1,
|
|
147
|
+
"projectId": "PROJECT_ID",
|
|
148
|
+
"environmentId": "ENVIRONMENT_ID",
|
|
149
|
+
"workspaceId": "WORKSPACE_ID"
|
|
150
|
+
}
|
|
151
|
+
}'
|
|
152
|
+
SCRIPT
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
**Important:** `serializedConfig` is the exact JSON object from the template query, not a string.
|
|
156
|
+
|
|
157
|
+
## Connecting Services
|
|
158
|
+
|
|
159
|
+
After deploying a template, connect other services using reference variables.
|
|
160
|
+
|
|
161
|
+
For complete variable syntax and wiring patterns, see [variables.md](references/variables.md).
|
|
162
|
+
|
|
163
|
+
### Pattern
|
|
164
|
+
|
|
165
|
+
```
|
|
166
|
+
${{ServiceName.VARIABLE_NAME}}
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
### Common Database Variables
|
|
170
|
+
|
|
171
|
+
| Service | Connection Variable |
|
|
172
|
+
|---------|---------------------|
|
|
173
|
+
| PostgreSQL (Postgres) | `${{Postgres.DATABASE_URL}}` |
|
|
174
|
+
| Redis | `${{Redis.REDIS_URL}}` |
|
|
175
|
+
| MySQL | `${{MySQL.MYSQL_URL}}` |
|
|
176
|
+
| MongoDB | `${{MongoDB.MONGO_URL}}` |
|
|
177
|
+
|
|
178
|
+
### Backend vs Frontend
|
|
179
|
+
|
|
180
|
+
**Backend services** can use private URLs (internal network):
|
|
181
|
+
```
|
|
182
|
+
${{Postgres.DATABASE_URL}}
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
**Frontend applications** run in the browser and cannot access Railway's private network. Options:
|
|
186
|
+
1. Use public URL variables (e.g., `${{MongoDB.MONGO_PUBLIC_URL}}`)
|
|
187
|
+
2. Better: Route through a backend API
|
|
188
|
+
|
|
189
|
+
## Example: Add PostgreSQL
|
|
190
|
+
|
|
191
|
+
```bash
|
|
192
|
+
bash <<'SCRIPT'
|
|
193
|
+
# 1. Get context
|
|
194
|
+
railway status --json
|
|
195
|
+
# → project.id = "proj-123", environment.id = "env-456"
|
|
196
|
+
|
|
197
|
+
# 2. Get workspace ID
|
|
198
|
+
scripts/railway-api.sh \
|
|
199
|
+
'query { project(id: "proj-123") { workspaceId } }' '{}'
|
|
200
|
+
# → workspaceId = "ws-789"
|
|
201
|
+
|
|
202
|
+
# 3. Fetch Postgres template
|
|
203
|
+
scripts/railway-api.sh \
|
|
204
|
+
'query { template(code: "postgres") { id serializedConfig } }' '{}'
|
|
205
|
+
# → id = "template-abc", serializedConfig = {...}
|
|
206
|
+
|
|
207
|
+
# 4. Deploy
|
|
208
|
+
scripts/railway-api.sh \
|
|
209
|
+
'mutation deploy($input: TemplateDeployV2Input!) {
|
|
210
|
+
templateDeployV2(input: $input) { projectId workflowId }
|
|
211
|
+
}' \
|
|
212
|
+
'{"input": {
|
|
213
|
+
"templateId": "template-abc",
|
|
214
|
+
"serializedConfig": {...},
|
|
215
|
+
"projectId": "proj-123",
|
|
216
|
+
"environmentId": "env-456",
|
|
217
|
+
"workspaceId": "ws-789"
|
|
218
|
+
}}'
|
|
219
|
+
SCRIPT
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
## Example: Search for CMS Templates
|
|
223
|
+
|
|
224
|
+
```bash
|
|
225
|
+
bash <<'SCRIPT'
|
|
226
|
+
# Search verified templates
|
|
227
|
+
scripts/railway-api.sh \
|
|
228
|
+
'query {
|
|
229
|
+
templates(first: 50, verified: true) {
|
|
230
|
+
edges {
|
|
231
|
+
node { name code description category }
|
|
232
|
+
}
|
|
233
|
+
}
|
|
234
|
+
}' '{}'
|
|
235
|
+
# Filter results for "CMS" category or search descriptions
|
|
236
|
+
SCRIPT
|
|
237
|
+
```
|
|
238
|
+
|
|
239
|
+
## What Gets Created
|
|
240
|
+
|
|
241
|
+
Templates typically create:
|
|
242
|
+
- Service with pre-configured image/source
|
|
243
|
+
- Environment variables (connection strings, secrets)
|
|
244
|
+
- Volume for persistent data (databases)
|
|
245
|
+
- TCP proxy for external access (where needed)
|
|
246
|
+
|
|
247
|
+
## Response
|
|
248
|
+
|
|
249
|
+
Successful deployment returns:
|
|
250
|
+
```json
|
|
251
|
+
{
|
|
252
|
+
"data": {
|
|
253
|
+
"templateDeployV2": {
|
|
254
|
+
"projectId": "proj-123",
|
|
255
|
+
"workflowId": "deployTemplate/project/proj-123/xxx"
|
|
256
|
+
}
|
|
257
|
+
}
|
|
258
|
+
}
|
|
259
|
+
```
|
|
260
|
+
|
|
261
|
+
## Error Handling
|
|
262
|
+
|
|
263
|
+
| Error | Cause | Solution |
|
|
264
|
+
|-------|-------|----------|
|
|
265
|
+
| Template not found | Invalid code | Search templates or check spelling |
|
|
266
|
+
| Rate limit exceeded | Too many searches | Wait 1 minute, then retry |
|
|
267
|
+
| Permission denied | User lacks access | Need DEVELOPER role or higher |
|
|
268
|
+
| Project not found | Invalid project ID | Run `railway status --json` |
|
|
269
|
+
|
|
270
|
+
## Composability
|
|
271
|
+
|
|
272
|
+
- **Connect services**: Use `environment` skill to add variable references
|
|
273
|
+
- **View deployed service**: Use `service` skill
|
|
274
|
+
- **Check logs**: Use `deployment` skill
|
|
275
|
+
- **Add domains**: Use `domain` skill
|
|
@@ -0,0 +1,183 @@
|
|
|
1
|
+
# Environment Config Reference
|
|
2
|
+
|
|
3
|
+
The `EnvironmentConfig` object is used to configure services, volumes, and shared variables in Railway.
|
|
4
|
+
|
|
5
|
+
## Structure
|
|
6
|
+
|
|
7
|
+
```json
|
|
8
|
+
{
|
|
9
|
+
"services": {
|
|
10
|
+
"<serviceId>": {
|
|
11
|
+
"source": { ... },
|
|
12
|
+
"build": { ... },
|
|
13
|
+
"deploy": { ... },
|
|
14
|
+
"variables": { ... },
|
|
15
|
+
"networking": { ... }
|
|
16
|
+
}
|
|
17
|
+
},
|
|
18
|
+
"sharedVariables": { ... },
|
|
19
|
+
"volumes": { ... },
|
|
20
|
+
"buckets": { ... }
|
|
21
|
+
}
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Only include fields being changed. The patch is merged with existing config.
|
|
25
|
+
|
|
26
|
+
Apply changes via CLI: `echo '<json>' | railway environment edit --json`
|
|
27
|
+
|
|
28
|
+
## Service Config
|
|
29
|
+
|
|
30
|
+
### Source
|
|
31
|
+
| Field | Type | Description |
|
|
32
|
+
|-------|------|-------------|
|
|
33
|
+
| `image` | string | Docker image (e.g., `nginx:latest`) |
|
|
34
|
+
| `repo` | string | Git repository URL |
|
|
35
|
+
| `branch` | string | Git branch to deploy |
|
|
36
|
+
| `commitSha` | string | Specific commit SHA |
|
|
37
|
+
| `rootDirectory` | string | Root directory (monorepos) |
|
|
38
|
+
| `checkSuites` | boolean | Wait for GitHub check suites |
|
|
39
|
+
| `autoUpdates.type` | disabled \| patch \| minor | Auto-update policy for Docker images |
|
|
40
|
+
|
|
41
|
+
### Build
|
|
42
|
+
| Field | Type | Description |
|
|
43
|
+
|-------|------|-------------|
|
|
44
|
+
| `builder` | NIXPACKS \| DOCKERFILE \| RAILPACK | Build system |
|
|
45
|
+
| `buildCommand` | string | Command for Nixpacks builds |
|
|
46
|
+
| `dockerfilePath` | string | Path to Dockerfile |
|
|
47
|
+
| `watchPatterns` | string[] | Patterns to trigger deploys |
|
|
48
|
+
| `nixpacksConfigPath` | string | Path to nixpacks config |
|
|
49
|
+
|
|
50
|
+
### Deploy
|
|
51
|
+
| Field | Type | Description |
|
|
52
|
+
|-------|------|-------------|
|
|
53
|
+
| `startCommand` | string | Container start command |
|
|
54
|
+
| `multiRegionConfig` | object | Region → replica config. See [Multi-Region Config](#multi-region-config). |
|
|
55
|
+
| `healthcheckPath` | string | Health check endpoint |
|
|
56
|
+
| `healthcheckTimeout` | number | Seconds to wait for health |
|
|
57
|
+
| `restartPolicyType` | ON_FAILURE \| ALWAYS \| NEVER | Restart behavior |
|
|
58
|
+
| `restartPolicyMaxRetries` | number | Max restart attempts |
|
|
59
|
+
| `cronSchedule` | string | Cron schedule for cron jobs |
|
|
60
|
+
| `sleepApplication` | boolean | Sleep when inactive |
|
|
61
|
+
|
|
62
|
+
### Variables
|
|
63
|
+
| Field | Type | Description |
|
|
64
|
+
|-------|------|-------------|
|
|
65
|
+
| `value` | string | Variable value |
|
|
66
|
+
| `isOptional` | boolean | Allow empty value |
|
|
67
|
+
|
|
68
|
+
Set to `null` to delete a variable.
|
|
69
|
+
|
|
70
|
+
For variable references, see [variables.md](variables.md).
|
|
71
|
+
|
|
72
|
+
### Lifecycle
|
|
73
|
+
| Field | Type | Description |
|
|
74
|
+
|-------|------|-------------|
|
|
75
|
+
| `isDeleted` | boolean | Mark for deletion (requires ADMIN) |
|
|
76
|
+
| `isCreated` | boolean | Mark as newly created |
|
|
77
|
+
|
|
78
|
+
## Multi-Region Config
|
|
79
|
+
|
|
80
|
+
Controls replica count per region. Structure: region name → `{ numReplicas }` or `null` to remove.
|
|
81
|
+
|
|
82
|
+
```json
|
|
83
|
+
{
|
|
84
|
+
"multiRegionConfig": {
|
|
85
|
+
"us-west2": { "numReplicas": 3 },
|
|
86
|
+
"europe-west4-drams3a": { "numReplicas": 2 }
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
### Available Regions
|
|
92
|
+
|
|
93
|
+
| Name | Location | Aliases |
|
|
94
|
+
|------|----------|---------|
|
|
95
|
+
| `us-west2` | US West (California) | "us west", "california" |
|
|
96
|
+
| `us-east4-eqdc4a` | US East (Virginia) | "us east", "virginia" |
|
|
97
|
+
| `europe-west4-drams3a` | EU West (Amsterdam) | "europe", "eu", "amsterdam" |
|
|
98
|
+
| `asia-southeast1-eqsg3a` | Southeast Asia (Singapore) | "asia", "singapore" |
|
|
99
|
+
|
|
100
|
+
### Interpreting User Requests
|
|
101
|
+
|
|
102
|
+
- "add 3 replicas to europe" → `{ "europe-west4-drams3a": { "numReplicas": 3 } }`
|
|
103
|
+
- "add a replica to all regions" → set `numReplicas: 1` for all 4 regions
|
|
104
|
+
- "remove from asia" → `{ "asia-southeast1-eqsg3a": null }`
|
|
105
|
+
- "increase replicas to 5" (no region specified) → query current config first, update existing region(s)
|
|
106
|
+
|
|
107
|
+
**Important:** When user doesn't specify a region, query the current `multiRegionConfig` and modify the existing region(s). Don't assume a default region.
|
|
108
|
+
|
|
109
|
+
## Common Operations
|
|
110
|
+
|
|
111
|
+
### Set Build Command
|
|
112
|
+
```json
|
|
113
|
+
{ "services": { "<serviceId>": { "build": { "buildCommand": "npm run build" } } } }
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
### Set Start Command
|
|
117
|
+
```json
|
|
118
|
+
{ "services": { "<serviceId>": { "deploy": { "startCommand": "node server.js" } } } }
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
### Set Replicas
|
|
122
|
+
```json
|
|
123
|
+
{ "services": { "<serviceId>": { "deploy": { "multiRegionConfig": { "us-west2": { "numReplicas": 3 } } } } } }
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
### Add Variables
|
|
127
|
+
```json
|
|
128
|
+
{ "services": { "<serviceId>": { "variables": { "API_KEY": { "value": "xxx" } } } } }
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
### Delete Variable
|
|
132
|
+
```json
|
|
133
|
+
{ "services": { "<serviceId>": { "variables": { "OLD_VAR": null } } } }
|
|
134
|
+
```
|
|
135
|
+
Via CLI: `echo '{"services":{"<serviceId>":{"variables":{"OLD_VAR":null}}}}' | railway environment edit --json`
|
|
136
|
+
|
|
137
|
+
### Add Shared Variable
|
|
138
|
+
```json
|
|
139
|
+
{ "sharedVariables": { "DATABASE_URL": { "value": "postgres://..." } } }
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
### Change Docker Image
|
|
143
|
+
```json
|
|
144
|
+
{ "services": { "<serviceId>": { "source": { "image": "nginx:latest" } } } }
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
### Connect GitHub Repo
|
|
148
|
+
```json
|
|
149
|
+
{ "services": { "<serviceId>": { "source": { "repo": "owner/repo", "branch": "main" } } } }
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
### Change Git Branch
|
|
153
|
+
```json
|
|
154
|
+
{ "services": { "<serviceId>": { "source": { "branch": "develop" } } } }
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
### Set Health Check
|
|
158
|
+
```json
|
|
159
|
+
{ "services": { "<serviceId>": { "deploy": { "healthcheckPath": "/health", "healthcheckTimeout": 30 } } } }
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
### Change Builder
|
|
163
|
+
```json
|
|
164
|
+
{ "services": { "<serviceId>": { "build": { "builder": "DOCKERFILE", "dockerfilePath": "./Dockerfile" } } } }
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
### Delete Service
|
|
168
|
+
```json
|
|
169
|
+
{ "services": { "<serviceId>": { "isDeleted": true } } }
|
|
170
|
+
```
|
|
171
|
+
Via CLI: `echo '{"services":{"<serviceId>":{"isDeleted":true}}}' | railway environment edit --json`
|
|
172
|
+
|
|
173
|
+
### Delete Volume
|
|
174
|
+
```json
|
|
175
|
+
{ "volumes": { "<volumeId>": { "isDeleted": true } } }
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
### New Service Instance
|
|
179
|
+
```json
|
|
180
|
+
{ "services": { "<serviceId>": { "isCreated": true, "source": { "image": "nginx" } } } }
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
**Note:** `isCreated: true` is required for new service instances.
|