Railway Docs
Answer Railway hosting questions with live docs instead of stale training data when deploying or debugging on Railway.
Overview
Railway Docs is an agent skill most often used in Operate (also Build integrations, Ship launch prep) that fetches up-to-date Railway documentation to answer platform questions accurately.
Install
npx skills add https://github.com/railwayapp/railway-skills --skill railway-docsWhat is this skill?
- Fetches LLM-optimized sources: llms-docs.md, llms.txt, templates, changelog, blog
- Append `.md` to any docs.railway.com URL for markdown fetch
- Explicit rule: check docs before answering Railway questions from memory
- Common doc paths table for projects, deployments, and platform topics
- Covers user-shared docs.railway.com links and feature/pricing questions
- Five LLM-optimized source endpoints listed (full docs, llms.txt, templates, changelog, blog)
- Docs URLs support `.md` suffix fetch pattern
Adoption & trust: 1.1k installs on skills.sh; 274 GitHub stars; 2/3 security scanners passed (skills.sh audits).
What problem does it solve?
You are configuring Railway deployments but the agent guesses features, pricing, or volume behavior that changed since training.
Who is it for?
Solo builders on Railway who want doc-backed answers about projects, deployments, templates, and pricing before changing prod.
Skip if: Teams on AWS-only or Vercel-only stacks with no Railway footprint, or when you need automated provisioning instead of documentation lookup.
When should I use this skill?
User asks about Railway features, how Railway works, shares a docs.railway.com URL, or needs current Railway features or pricing.
What do I get? / Deliverables
You get answers grounded in fetched Railway markdown docs and index pages so config and architecture decisions match the live platform.
- Doc-backed answer to Railway question
- Referenced markdown doc paths or URLs
Recommended Skills
Journey fit
Spans multiple journey phases - primary shelf plus alternate fits below.
Operating production on Railway is the natural home shelf—infra questions hit after something is deployed, even though docs also help during build-time integration. Infra subphase covers projects, deployments, volumes, pricing, and platform behavior that solo builders need while running services on Railway.
Where it fits
Confirm how to wire a database service and env vars before merging the Railway template.
Verify deployment and domain docs immediately before first production push.
Look up volume mount and project limits when scaling a solo SaaS API.
How it compares
Live Railway documentation fetcher—not an IaC module or generic cloud comparison skill.
Common Questions / FAQ
Who is railway-docs for?
Indie developers and agents working on Railway-hosted services who need authoritative, current platform answers during setup and ops.
When should I use railway-docs?
Use it during Operate when debugging infra; during Build when integrating Railway services; and during Ship when verifying deployment and volume behavior before go-live.
Is railway-docs safe to install?
Check the Security Audits panel on this Prism page; the skill implies network fetches to Railway domains—ensure you are comfortable with outbound requests in your agent environment.
SKILL.md
READMESKILL.md - Railway Docs
# Railway Docs Fetch up-to-date Railway documentation to answer questions accurately. ## When to Use - User asks how something works on Railway (projects, deployments, volumes, etc.) - User shares a docs.railway.com URL - User needs current info about Railway features or pricing - Before answering Railway questions from memory - check the docs first ## LLM-Optimized Sources Start here for comprehensive, up-to-date info: | Source | URL | | ------------------ | ------------------------------------------- | | **Full docs** | `https://docs.railway.com/api/llms-docs.md` | | **llms.txt index** | `https://railway.com/llms.txt` | | **Templates** | `https://railway.com/llms-templates.md` | | **Changelog** | `https://railway.com/llms-changelog.md` | | **Blog** | `https://blog.railway.com/llms-blog.md` | ## Fetching Specific Pages Append `.md` to any docs.railway.com URL: ``` https://docs.railway.com/guides/projects → https://docs.railway.com/guides/projects.md ``` ## Common Doc Paths | Topic | URL | | ----------- | ------------------------------------------------ | | Projects | `https://docs.railway.com/guides/projects.md` | | Deployments | `https://docs.railway.com/guides/deployments.md` | | Volumes | `https://docs.railway.com/guides/volumes.md` | | Variables | `https://docs.railway.com/guides/variables.md` | | CLI | `https://docs.railway.com/reference/cli-api.md` | | Pricing | `https://docs.railway.com/reference/pricing.md` | # Environment Config Reference The `EnvironmentConfig` object is used to configure services, volumes, and shared variables in Railway. ## Structure ```json { "services": { "<serviceId>": { "source": { ... }, "build": { ... }, "deploy": { ... }, "variables": { ... }, "networking": { ... } } }, "sharedVariables": { ... }, "volumes": { ... }, "buckets": { ... } } ``` Only include fields being changed. The patch is merged with existing config. Apply changes via CLI: `echo '<json>' | railway environment edit --json` ## Service Config ### Source | Field | Type | Description | |-------|------|-------------| | `image` | string | Docker image (e.g., `nginx:latest`) | | `repo` | string | Git repository URL | | `branch` | string | Git branch to deploy | | `commitSha` | string | Specific commit SHA | | `rootDirectory` | string | Root directory (monorepos) | | `checkSuites` | boolean | Wait for GitHub check suites | | `autoUpdates.type` | disabled \| patch \| minor | Auto-update policy for Docker images | ### Build | Field | Type | Description | |-------|------|-------------| | `builder` | NIXPACKS \| DOCKERFILE \| RAILPACK | Build system | | `buildCommand` | string | Command for Nixpacks builds | | `dockerfilePath` | string | Path to Dockerfile | | `watchPatterns` | string[] | Patterns to trigger deploys | | `nixpacksConfigPath` | string | Path to nixpacks config | ### Deploy | Field | Type | Description | |-------|------|-------------| | `startCommand` | string | Container start command | | `multiRegionConfig` | object | Region → replica config. See [Multi-Region Config](#multi-region-config). | | `healthcheckPath` | string | Health check endpoint | | `healthcheckTimeout` | number | Seconds to wait for health | | `restartPolicyType` | ON_FAILURE \| ALWAYS \| NEVER | Restart behavior | | `restartPolicyMaxRetries` | number | Max restart attempts | | `cronSchedule` | string | Cron schedule for cron jobs | | `sleepApplication` | boolean | Sleep when inactive | ### Variables | Field | Type | Description | |-------|------|-------------| | `value` | string | Variable