> ## Documentation Index
> Fetch the complete documentation index at: https://docs.boxd.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# Railway

> Railway is a deployment platform for building and shipping applications with instant deployments, automatic scaling, and managed infrastructure

Railway is a deployment platform for building and shipping applications with instant deployments, automatic scaling, and managed infrastructure.

`railway` · **18 tools** · no triggers

## Connect it

```bash theme={"theme":"github-dark"}
run auth railway
run auth railway --scope team    # shared with the organization
```

Or from the [Integrations page](https://app.boxd.sh/integrations) in the console. See [Connections](/guides/integrations/connections) for personal versus shared, and who may remove one.

## Use it

```bash theme={"theme":"github-dark"}
run railway          # common commands
run railway --all    # every command
```

```ts theme={"theme":"github-dark"}
import { railway } from "@boxd/run";
```

## Common tools

| Tool                      | What it does                                                                                                                                           |
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `create-plugin`           | Creates a new plugin in Railway for the specified project. Use this action when you need to add a custom plugin to a Railway project, such as for...   |
| `delete-variable`         | Delete a Railway environment variable. This action uses the `variableDelete` GraphQL mutation to permanently remove an environment variable from a...  |
| `delete-volume`           | Permanently delete a persistent volume and all its associated data from Railway.                                                                       |
| `delete-workspace`        | Delete a Railway workspace and all data associated with it. This action uses the `workspaceDelete` GraphQL mutation to permanently remove a workspace. |
| `disconnect-user-discord` | Disconnects the authenticated user's Railway account from Discord.                                                                                     |

<Accordion title="All 18 tools" icon="list">
  | Tool                           | What it does                                                                                                                                           |
  | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
  | `create-plugin`                | Creates a new plugin in Railway for the specified project. Use this action when you need to add a custom plugin to a Railway project, such as for...   |
  | `delete-variable`              | Delete a Railway environment variable. This action uses the `variableDelete` GraphQL mutation to permanently remove an environment variable from a...  |
  | `delete-volume`                | Permanently delete a persistent volume and all its associated data from Railway.                                                                       |
  | `delete-workspace`             | Delete a Railway workspace and all data associated with it. This action uses the `workspaceDelete` GraphQL mutation to permanently remove a workspace. |
  | `disconnect-user-discord`      | Disconnects the authenticated user's Railway account from Discord.                                                                                     |
  | `get-deployment-logs`          | Retrieve runtime logs for a deployment. Use when you need to view the runtime application logs for troubleshooting runtime issues, monitoring...       |
  | `get-environment`              | Get details of a specific Railway environment by its ID, including service instances and deployment information.                                       |
  | `get-git-hub-pr-info`          | Get information for a GitHub pull request associated with a Railway service.                                                                           |
  | `get-user-kickback-earnings`   | Get the total kickback earnings for the authenticated Railway user.                                                                                    |
  | `list-api-tokens`              | Retrieve all API tokens for the authenticated user from Railway.                                                                                       |
  | `list-environment-patches`     | Retrieve all patches for a Railway environment using the GraphQL API.                                                                                  |
  | `list-git-hub-repos`           | Retrieve a list of GitHub repositories that Railway has access to.                                                                                     |
  | `list-git-hub-writable-scopes` | Retrieve the list of GitHub scopes the user has installed the installation to.                                                                         |
  | `list-integration-auths`       | Retrieve all integration auths for the authenticated user from Railway.                                                                                |
  | `list-notification-deliveries` | Retrieve notification deliveries for the authenticated user.                                                                                           |
  | `list-trusted-domains`         | Fetch all trusted domains for the authenticated Railway workspace.                                                                                     |
  | `update-project`               | Update project settings and configuration on Railway. Use this action when you need to modify project properties such as description, visibility...    |
  | `update-service-instance`      | Update build/deploy settings for a service in a specific environment on Railway.                                                                       |
</Accordion>

[Open Railway in the console →](https://app.boxd.sh/integrations/detail/railway)