Skip to content

Document monorepo configuration via CLI #1283

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MykalMachon merged 1 commit into from
Aug 7, 2026
+24 −4
Merged

Document monorepo configuration via CLI #1283

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions content/docs/cli/environment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,12 +109,17 @@ The `--service-config` flag uses dot-path notation to specify nested configurati
# Set a variable value
railway environment edit --service-config backend variables.API_KEY.value "secret"

# Set a service configuration
railway environment edit --service-config api buildCommand "npm run build"
# Set a build command
railway environment edit --service-config api build.buildCommand "npm run build"

# Set a monorepo root directory
railway environment edit --service-config api source.rootDirectory /packages/api
```

The format is: `--service-config <SERVICE_NAME> <DOT.PATH.TO.PROPERTY> <VALUE>`

For more information about configuring monorepo services, see [Deploying a monorepo](/deployments/monorepo).

## Options for `config`

| Flag | Description |
Expand Down
19 changes: 17 additions & 2 deletions content/docs/deployments/monorepo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,12 @@ To deploy this type of monorepo on Railway, define a root directory for the serv
2. Click on the Settings tab.
3. Set the root directory option. Setting this means that Railway will only pull down files from that directory when creating new deployments.

Alternatively, set the root directory from the CLI:

```bash
railway environment edit --service-config backend source.rootDirectory /backend
```

<Image
src="https://res.cloudinary.com/railway/image/upload/v1637798659/docs/root-directory_achzga.png"
alt="Screenshot of root directory configuration"
Expand Down Expand Up @@ -64,6 +70,15 @@ codebase.
2. Click on the Settings tab.
3. Set the start command, e.g. `npm run start:backend` and `npm run start:frontend`

If you prefer, you can set custom build and start commands from the CLI:

```bash
railway environment edit \
--service-config backend build.buildCommand "pnpm --filter backend build"
railway environment edit \
--service-config backend deploy.startCommand "pnpm --filter backend start"
```

<Image
src="https://res.cloudinary.com/railway/image/upload/v1637798815/docs/custom-start-command_a8vcxs.png"
alt="Screenshot of custom start command configuration"
Expand Down Expand Up @@ -112,6 +127,6 @@ A monorepo might want to only trigger builds if files are changed in the `/packa

## Using the CLI

When interacting with your services deployed from a monorepo using the CLI, always ensure you are "linked" to the appropriate service when executing commands.
The Railway CLI lets you configure a service's root directory, build command, and start command with [`railway environment edit`](/cli/environment). Use the `--service-config` flag with the corresponding dot-path.

To link to a specific service from the CLI, use `railway link` and follow the prompts.
Before running the command, use `railway link` and follow the prompts to link the CLI to the correct project and environment. The `--service-config` flag selects the target service by name or ID.
Loading