Back to Skills

railway-service

davila7
Updated Today
37 views
15,516
1,344
15,516
View on GitHub
MetaRailwayServiceStatusDockerContainerInfrastructureManagement

About

This skill manages existing Railway services by checking status, renaming services, changing icons, and linking services. It can also create new services from Docker images, but for local code or GitHub repos, developers should use railway-new instead. Use this primarily for service monitoring and configuration updates.

Documentation

Railway Service Management

Check status, update properties, and advanced service creation.

When to Use

  • User asks about service status, health, or deployments
  • User asks "is my service deployed?"
  • User wants to rename a service or change service icon
  • User wants to link a different service
  • User wants to deploy a Docker image as a new service (advanced)

Note: For creating services with local code (the common case), prefer the railway-new skill which handles project setup, scaffolding, and service creation together.

For GitHub repo sources: Use railway-new skill to create empty service, then railway-environment skill to configure source.repo via staged changes API.

Create Service

Create a new service via GraphQL API. There is no CLI command for this.

Get Context

railway status --json

Extract:

  • project.id - for creating the service
  • environment.id - for staging the instance config

Create Service Mutation

mutation serviceCreate($input: ServiceCreateInput!) {
  serviceCreate(input: $input) {
    id
    name
  }
}

ServiceCreateInput Fields

FieldTypeDescription
projectIdString!Project ID (required)
nameStringService name (auto-generated if omitted)
source.imageStringDocker image (e.g., nginx:latest)
source.repoStringGitHub repo (e.g., user/repo)
branchStringGit branch for repo source
environmentIdStringIf set and is a fork, only creates in that env

Example: Create empty service

bash <<'SCRIPT'
${CLAUDE_PLUGIN_ROOT}/skills/lib/railway-api.sh \
  'mutation createService($input: ServiceCreateInput!) {
    serviceCreate(input: $input) { id name }
  }' \
  '{"input": {"projectId": "PROJECT_ID"}}'
SCRIPT

Example: Create service with image

bash <<'SCRIPT'
${CLAUDE_PLUGIN_ROOT}/skills/lib/railway-api.sh \
  'mutation createService($input: ServiceCreateInput!) {
    serviceCreate(input: $input) { id name }
  }' \
  '{"input": {"projectId": "PROJECT_ID", "name": "my-service", "source": {"image": "nginx:latest"}}}'
SCRIPT

Connecting a GitHub Repo

Do NOT use serviceCreate with source.repo - use staged changes API instead.

Flow:

  1. Create empty service: serviceCreate(input: {projectId: "...", name: "my-service"})
  2. Use railway-environment skill to configure source via staged changes API
  3. Apply to trigger deployment

After Creating: Configure Instance

Use railway-environment skill to configure the service instance:

{
  "services": {
    "<serviceId>": {
      "isCreated": true,
      "source": { "image": "nginx:latest" },
      "variables": {
        "PORT": { "value": "8080" }
      }
    }
  }
}

Critical: Always include isCreated: true for new service instances.

Then use railway-environment skill to apply and deploy.

Check Service Status

railway service status --json

Returns current deployment status for the linked service.

Deployment History

railway deployment list --json --limit 5

Present Status

Show:

  • Service: name and current status
  • Latest Deployment: status (SUCCESS, FAILED, DEPLOYING, CRASHED, etc.)
  • Deployed At: when the current deployment went live
  • Recent Deployments: last 3-5 with status and timestamps

Deployment Statuses

StatusMeaning
SUCCESSDeployed and running
FAILEDBuild or deploy failed
DEPLOYINGCurrently deploying
BUILDINGBuild in progress
CRASHEDRuntime crash
REMOVEDDeployment removed

Update Service

Update service name or icon via GraphQL API.

Get Service ID

railway status --json

Extract service.id from the response.

Update Name

bash <<'SCRIPT'
${CLAUDE_PLUGIN_ROOT}/skills/lib/railway-api.sh \
  'mutation updateService($id: String!, $input: ServiceUpdateInput!) {
    serviceUpdate(id: $id, input: $input) { id name }
  }' \
  '{"id": "SERVICE_ID", "input": {"name": "new-name"}}'
SCRIPT

Update Icon

Icons can be image URLs or animated GIFs.

TypeExample
Image URL"icon": "https://example.com/logo.png"
Animated GIF"icon": "https://example.com/animated.gif"
Devicons"icon": "https://devicons.railway.app/github"

Railway Devicons: Query https://devicons.railway.app/{query} for common developer icons (e.g., github, postgres, redis, nodejs). Browse all at https://devicons.railway.app

bash <<'SCRIPT'
${CLAUDE_PLUGIN_ROOT}/skills/lib/railway-api.sh \
  'mutation updateService($id: String!, $input: ServiceUpdateInput!) {
    serviceUpdate(id: $id, input: $input) { id icon }
  }' \
  '{"id": "SERVICE_ID", "input": {"icon": "https://devicons.railway.app/github"}}'
SCRIPT

ServiceUpdateInput Fields

FieldTypeDescription
nameStringService name
iconStringEmoji or image URL (including animated GIFs)

Link Service

Switch the linked service for the current directory:

railway service link

Or specify directly:

railway service link <service-name>

Composability

  • Create service with local code: Use railway-new skill (handles scaffolding + creation)
  • Configure service: Use railway-environment skill (variables, commands, image, etc.)
  • Delete service: Use railway-environment skill with isDeleted: true
  • Apply changes: Use railway-environment skill
  • View logs: Use railway-deployment skill
  • Deploy local code: Use railway-deploy skill

Error Handling

No Service Linked

No service linked. Run `railway service link` to link a service.

No Deployments

Service exists but has no deployments yet. Deploy with `railway up`.

Service Not Found

Service "foo" not found. Check available services with `railway status`.

Project Not Found

User may not be in a linked project. Check railway status.

Permission Denied

User needs at least DEVELOPER role to create services.

Invalid Image

Docker image must be accessible (public or with registry credentials).

Quick Install

/plugin add https://github.com/davila7/claude-code-templates/tree/main/service

Copy and paste this command in Claude Code to install this skill

GitHub 仓库

davila7/claude-code-templates
Path: cli-tool/components/skills/railway/service
anthropicanthropic-claudeclaudeclaude-code

Related Skills