Railway URLs

Generate URLs to railway.com resources.

Installation

bun add @railway/urls

Usage

Use the default instance for standard Railway URLs:

import { railwayUrls } from "@railway/urls";

railwayUrls.project({ projectId: "abc123" });
// https://railway.com/project/abc123

railwayUrls.projectSettings({
  projectId: "abc123",
  environmentId: "prod",
});
// https://railway.com/project/abc123/settings?environmentId=prod

Create a custom instance for different base URLs:

import { RailwayUrls } from "railway-urls";

const urls = new RailwayUrls("http://localhost:3000");
urls.project({ projectId: "abc123" });
// http://localhost:3000/project/abc123

Smart Resource Inference

The resource() method automatically determines the correct URL based on which IDs you provide:

// Project overview
railwayUrls.resource({ projectId: "abc" });
// https://railway.com/project/abc

// Service deployments
railwayUrls.resource({ projectId: "abc", serviceId: "svc-123" });
// https://railway.com/project/abc/service/svc-123

// Volume metrics
railwayUrls.resource({ projectId: "abc", volumeId: "vol-456" });
// https://railway.com/project/abc/volume/vol-456/metrics

// Bucket files
railwayUrls.resource({ projectId: "abc", bucketId: "bucket-789" });
// https://railway.com/project/abc/bucket/bucket-789

Priority order: service > volume > bucket > project