Vercel Monorepos

https://vercel.com/docs/monorepos
Admin
Vercel Monorepos documentation provides guidance on deploying and managing monorepo projects using...
Tokens:14,606
Snippets:135
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install @vercel/remote-nx with bun

Source: https://vercel.com/docs/monorepos/nx?from=graph&relationship=outbound&source_path=%2Fdocs%2Fmonorepos%2Fremote-caching&source_site=vercel-docs&surface=html

Install the @vercel/remote-nx plugin using bun. Required for Nx 17-19 remote caching setup.

```bash
bun add @vercel/remote-nx
```

--------------------------------

### Install @vercel/remote-nx with npm

Source: https://vercel.com/docs/monorepos/nx?from=graph&relationship=outbound&source_path=%2Fdocs%2Fmonorepos%2Fremote-caching&source_site=vercel-docs&surface=html

Install the @vercel/remote-nx plugin using npm. Required for Nx 17-19 remote caching setup.

```bash
npm i @vercel/remote-nx
```

--------------------------------

### Install @vercel/remote-nx with pnpm

Source: https://vercel.com/docs/monorepos/nx?from=graph&relationship=outbound&source_path=%2Fdocs%2Fmonorepos%2Fremote-caching&source_site=vercel-docs&surface=html

Install the @vercel/remote-nx plugin using pnpm. Required for Nx 17-19 remote caching setup.

```bash
pnpm i @vercel/remote-nx
```

--------------------------------

### Install @vercel/remote-nx with yarn

Source: https://vercel.com/docs/monorepos/nx?from=graph&relationship=outbound&source_path=%2Fdocs%2Fmonorepos%2Fremote-caching&source_site=vercel-docs&surface=html

Install the @vercel/remote-nx plugin using yarn. Required for Nx 17-19 remote caching setup.

```bash
yarn add @vercel/remote-nx
```

--------------------------------

### Configure filtered install command with Bun in vercel.json

Source: https://vercel.com/docs/monorepos?from=graph&relationship=outbound&source_path=%2Fdocs%2Fmonorepos%2Fturborepo&source_site=vercel-docs&surface=html

Sets a custom install command using Bun workspace filtering for the web application.

```json
{
&#x20; "installCommand": "bun install --filter web"
}
```

--------------------------------

### Configure filtered install command with pnpm in vercel.json

Source: https://vercel.com/docs/monorepos?from=graph&relationship=outbound&source_path=%2Fdocs%2Fmonorepos%2Fturborepo&source_site=vercel-docs&surface=html

Sets a custom install command to install only the dependencies for the web project and its workspace dependencies.

```json
{
&#x20; "installCommand": "pnpm install --filter web..."
}
```

--------------------------------

### Configure filtered install command with Yarn in vercel.json

Source: https://vercel.com/docs/monorepos?from=graph&relationship=outbound&source_path=%2Fdocs%2Fmonorepos%2Fturborepo&source_site=vercel-docs&surface=html

Sets a custom install command using Yarn workspaces focus to install dependencies for the target workspace.

```json
{
&#x20; "installCommand": "yarn workspaces focus web"
}
```

--------------------------------

### Configure filtered install command with npm in vercel.json

Source: https://vercel.com/docs/monorepos?from=graph&relationship=outbound&source_path=%2Fdocs%2Fmonorepos%2Fturborepo&source_site=vercel-docs&surface=html

Sets a custom install command using npm workspace filtering for the web application.

```json
{
&#x20; "installCommand": "npm install --workspace=web"
}
```

--------------------------------

### Install @vercel/remote-nx plugin

Source: https://vercel.com/docs/monorepos/nx

Install the @vercel/remote-nx plugin for Nx 17 to 19. Use the command for your package manager (pnpm, yarn, npm, or bun).

```bash
pnpm i @vercel/remote-nx
```

```bash
yarn add @vercel/remote-nx
```

```bash
npm i @vercel/remote-nx
```

```bash
bun add @vercel/remote-nx
```

--------------------------------

### Build Nx project with bun

Source: https://vercel.com/docs/monorepos/nx?from=graph&relationship=outbound&source_path=%2Fdocs%2Fmonorepos%2Fremote-caching&source_site=vercel-docs&surface=html

Build the Nx project using bunx nx build. Part of the 'Clear cache and run' step.

```bash
bunx nx build
```

--------------------------------

### Build Nx project with pnpm

Source: https://vercel.com/docs/monorepos/nx?from=graph&relationship=outbound&source_path=%2Fdocs%2Fmonorepos%2Fremote-caching&source_site=vercel-docs&surface=html

Build the Nx project using pnpm dlx nx build. Part of the 'Clear cache and run' step.

```bash
pnpm dlx nx build
```

--------------------------------

### Build Nx project with npm

Source: https://vercel.com/docs/monorepos/nx?from=graph&relationship=outbound&source_path=%2Fdocs%2Fmonorepos%2Fremote-caching&source_site=vercel-docs&surface=html

Build the Nx project using npx nx build. Part of the 'Clear cache and run' step.

```bash
npx nx build
```

--------------------------------

### Build Nx project with yarn

Source: https://vercel.com/docs/monorepos/nx?from=graph&relationship=outbound&source_path=%2Fdocs%2Fmonorepos%2Fremote-caching&source_site=vercel-docs&surface=html

Build the Nx project using yarn dlx nx build. Part of the 'Clear cache and run' step.

```bash
yarn dlx nx build
```

--------------------------------

### Authenticate with Vercel using npm

Source: https://vercel.com/docs/monorepos/remote-caching?from=graph&relationship=inbound&source_path=%2Fdocs%2Fmonorepos%2Fnx&source_site=vercel-docs&surface=html

Authenticate the Turborepo CLI with your Vercel account using npm. Run this command in your monorepo root.

```bash
npx turbo login
```

--------------------------------

### Authenticate Turborepo CLI with Vercel (pnpm, yarn, npm, bun)

Source: https://vercel.com/docs/monorepos/remote-caching

Run the appropriate command for your package manager to log in to Vercel. Required before linking the remote cache.

```bash
pnpm dlx turbo login
```

```bash
yarn dlx turbo login
```

```bash
npx turbo login
```

```bash
bunx turbo login
```

--------------------------------

### Rebuild project with nx build

Source: https://vercel.com/docs/monorepos/nx

Rebuild the project after clearing the cache. Use the command for your package manager.

```bash
pnpm dlx nx build
```

```bash
yarn dlx nx build
```

```bash
npx nx build
```

```bash
bunx nx build
```

--------------------------------

### Test the cache with turbo run build

Source: https://vercel.com/docs/monorepos/remote-caching?from=graph&relationship=inbound&source_path=%2Fdocs%2Fmonorepos%2Fnx&source_site=vercel-docs&surface=html

Run turbo run build to see caching in action. Turborepo caches filesystem output both locally and remotely. Cached artifacts are in .turbo/cache.

```bash
turbo run build
```

--------------------------------

### Deploy with Vercel CLI using environment variables

Source: https://vercel.com/docs/monorepos/monorepo-faq?from=graph&relationship=semantic&source_path=%2Fdocs%2Fmonorepos%2Fnx&source_site=vercel-docs&surface=html

Use this command to deploy with Vercel CLI without project linking by setting the VERCEL_ORG_ID and VERCEL_PROJECT_ID environment variables. The --project flag takes precedence over VERCEL_PROJECT_ID if both are provided.

```zsh
VERCEL_ORG_ID=team_123 VERCEL_PROJECT_ID=prj_456 vercel
```

--------------------------------

### Configure Turborepo Remote Cache action in GitHub Actions

Source: https://vercel.com/docs/monorepos/remote-caching/external-ci-cd

Configures vercel/setup-turborepo-remote-cache-action in a GitHub Actions workflow to exchange OIDC tokens for short-lived Turborepo tokens. Requires id-token: write permissions and accepts the team variable.

```yaml
# ...

jobs:
  build:
    name: Build and Test
    timeout-minutes: 15
    runs-on: ubuntu-latest
    permissions:
      contents: read
      id-token: write

    steps:
      - name: Check out code
        uses: actions/checkout@v4
        with:
          fetch-depth: 2

      - name: Set up Turborepo Remote Cache
        uses: vercel/setup-turborepo-remote-cache-action@v1.0.0
        with:
          team: ${{ vars.TURBO_TEAM }}
    # ...
```

--------------------------------

### Authenticate with Vercel using bun

Source: https://vercel.com/docs/monorepos/remote-caching?from=graph&relationship=inbound&source_path=%2Fdocs%2Fmonorepos%2Fnx&source_site=vercel-docs&surface=html

Authenticate the Turborepo CLI with your Vercel account using bun. Run this command in your monorepo root.

```bash
bunx turbo login
```

--------------------------------

### Link to Vercel Remote Cache (pnpm, yarn, npm, bun)

Source: https://vercel.com/docs/monorepos/remote-caching

Run in the root of the monorepo to enable Remote Caching and connect to the Vercel Remote Cache. You will be prompted to enable Remote Caching and select a team scope.

```bash
pnpm dlx turbo link
```

```bash
yarn dlx turbo link
```

```bash
npx turbo link
```

```bash
bunx turbo link
```

--------------------------------

### Authenticate with Vercel using pnpm

Source: https://vercel.com/docs/monorepos/remote-caching?from=graph&relationship=inbound&source_path=%2Fdocs%2Fmonorepos%2Fnx&source_site=vercel-docs&surface=html

Authenticate the Turborepo CLI with your Vercel account using pnpm. Run this command in your monorepo root.

```bash
pnpm dlx turbo login
```

--------------------------------

### Configure @vercel/remote-nx runner in nx.json

Source: https://vercel.com/docs/monorepos/nx

Configure the @vercel/remote-nx runner in nx.json. Add the runner to tasksRunnerOptions and specify token and teamId, or set them as environment variables.

```json
{
  "tasksRunnerOptions": {
    "default": {
      "runner": "@vercel/remote-nx",
      "options": {
        "token": "<token>",
        "teamId": "<teamId>"
      }
    }
  }
}
```

--------------------------------

### Authenticate with Vercel using yarn

Source: https://vercel.com/docs/monorepos/remote-caching?from=graph&relationship=inbound&source_path=%2Fdocs%2Fmonorepos%2Fnx&source_site=vercel-docs&surface=html

Authenticate the Turborepo CLI with your Vercel account using yarn. Run this command in your monorepo root.

```bash
yarn dlx turbo login
```

--------------------------------

### Clear Nx cache with bun

Source: https://vercel.com/docs/monorepos/nx?from=graph&relationship=outbound&source_path=%2Fdocs%2Fmonorepos%2Fremote-caching&source_site=vercel-docs&surface=html

Clear the local Nx cache using bunx nx reset. Part of the 'Clear cache and run' step.

```bash
bunx nx reset
```

--------------------------------

### Authenticate with SSO team using npm

Source: https://vercel.com/docs/monorepos/remote-caching?from=graph&relationship=inbound&source_path=%2Fdocs%2Fmonorepos%2Fnx&source_site=vercel-docs&surface=html

Authenticate with an SSO-enabled Vercel team by providing your team slug as an argument. Replace team-slug with your actual team slug.

```bash
npx turbo login --sso-team=team-slug
```

--------------------------------

### Authenticate with SSO team using pnpm

Source: https://vercel.com/docs/monorepos/remote-caching?from=graph&relationship=inbound&source_path=%2Fdocs%2Fmonorepos%2Fnx&source_site=vercel-docs&surface=html

Authenticate with an SSO-enabled Vercel team by providing your team slug as an argument. Replace team-slug with your actual team slug.

```bash
pnpm dlx turbo login --sso-team=team-slug
```

--------------------------------

### Authenticate with SSO team using bun

Source: https://vercel.com/docs/monorepos/remote-caching?from=graph&relationship=inbound&source_path=%2Fdocs%2Fmonorepos%2Fnx&source_site=vercel-docs&surface=html

Authenticate with an SSO-enabled Vercel team by providing your team slug as an argument. Replace team-slug with your actual team slug.

```bash
bunx turbo login --sso-team=team-slug
```

--------------------------------

### Clear Nx cache with npm

Source: https://vercel.com/docs/monorepos/nx?from=graph&relationship=outbound&source_path=%2Fdocs%2Fmonorepos%2Fremote-caching&source_site=vercel-docs&surface=html

Clear the local Nx cache using npx nx reset. Part of the 'Clear cache and run' step.

```bash
npx nx reset
```

--------------------------------

### Configure Nx inputs to prevent cached environment variables

Source: https://vercel.com/docs/monorepos/monorepo-faq?from=graph&relationship=semantic&source_path=%2Fdocs%2Fmonorepos%2Fnx&source_site=vercel-docs&surface=html

Add this configuration to your `nx.json` file to include the `MY_VERCEL_ENV` environment variable in the `sharedGlobals` named inputs. This prevents Nx from using a cached value for that variable in deployments.

```json
{
  "namedInputs": {
    "sharedGlobals": [{ "env": "MY_VERCEL_ENV" }]
  }
}
```

--------------------------------

### Authenticate with SSO team slug (pnpm, yarn, npm, bun)

Source: https://vercel.com/docs/monorepos/remote-caching

Use the --sso-team flag with your team slug when connecting to an SSO-enabled Vercel team.

```bash
pnpm dlx turbo login --sso-team=team-slug
```

```bash
yarn dlx turbo login --sso-team=team-slug
```

```bash
npx turbo login --sso-team=team-slug
```

```bash
bunx turbo login --sso-team=team-slug
```

--------------------------------

### Clear Nx cache with pnpm

Source: https://vercel.com/docs/monorepos/nx?from=graph&relationship=outbound&source_path=%2Fdocs%2Fmonorepos%2Fremote-caching&source_site=vercel-docs&surface=html

Clear the local Nx cache using pnpm dlx nx reset. Part of the 'Clear cache and run' step.

```bash
pnpm dlx nx reset
```

--------------------------------

### Clear Nx cache with nx reset

Source: https://vercel.com/docs/monorepos/nx

Clear the local Nx cache before rebuilding. Use the command for your package manager.

```bash
pnpm dlx nx reset
```

```bash
yarn dlx nx reset
```

```bash
npx nx reset
```

```bash
bunx nx reset
```

--------------------------------

### Set TURBO_TEAM repository variable with GitHub CLI

Source: https://vercel.com/docs/monorepos/remote-caching/external-ci-cd

Sets the TURBO_TEAM repository configuration variable to your Vercel team slug using the GitHub CLI. Using a repository variable rather than a secret prevents CI logs from unnecessarily censoring your team name.

```bash
gh variable set TURBO_TEAM --body "your-team-slug"
```

--------------------------------

### Unlink from Vercel Remote Cache (pnpm, yarn, npm, bun)

Source: https://vercel.com/docs/monorepos/remote-caching

Run to disable Remote Caching and unlink the current directory from the Vercel Remote Cache. This is per-developer, so each developer must run it locally.

```bash
pnpm dlx turbo unlink
```

```bash
yarn dlx turbo unlink
```

```bash
npx turbo unlink
```

```bash
bunx turbo unlink
```

--------------------------------

### Configure TURBO_TOKEN and TURBO_TEAM in .github/workflows/ci.yml

Source: https://vercel.com/docs/monorepos/remote-caching/external-ci-cd

Exposes the TURBO_TOKEN secret and TURBO_TEAM variable to GitHub Actions jobs that run turbo commands.

```yaml
# ...

jobs:
  build:
    name: Build and Test
    timeout-minutes: 15
    runs-on: ubuntu-latest
    env:
      TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
      TURBO_TEAM: ${{ vars.TURBO_TEAM }}

    steps:
      - name: Check out code
        uses: actions/checkout@v4
        with:
          fetch-depth: 2
    # ...
```

--------------------------------

### Authenticate with SSO team using yarn

Source: https://vercel.com/docs/monorepos/remote-caching?from=graph&relationship=inbound&source_path=%2Fdocs%2Fmonorepos%2Fnx&source_site=vercel-docs&surface=html

Authenticate with an SSO-enabled Vercel team by providing your team slug as an argument. Replace team-slug with your actual team slug.

```bash
yarn dlx turbo login --sso-team=team-slug
```

--------------------------------

### Unlink remote cache using bun

Source: https://vercel.com/docs/monorepos/remote-caching?from=graph&relationship=inbound&source_path=%2Fdocs%2Fmonorepos%2Fnx&source_site=vercel-docs&surface=html

Disable Remote Caching and unlink the current directory from the Vercel Remote Cache. Run on a per-developer basis.

```bash
bunx turbo unlink
```

--------------------------------

### Clear Nx cache with yarn

Source: https://vercel.com/docs/monorepos/nx?from=graph&relationship=outbound&source_path=%2Fdocs%2Fmonorepos%2Fremote-caching&source_site=vercel-docs&surface=html

Clear the local Nx cache using yarn dlx nx reset. Part of the 'Clear cache and run' step.

```bash
yarn dlx nx reset
```

--------------------------------

### Set TURBO_TOKEN secret with gh secret set

Source: https://vercel.com/docs/monorepos/remote-caching/external-ci-cd

Sets the TURBO_TOKEN repository secret using the GitHub CLI. Paste the Personal Access Token value when prompted.

```bash
gh secret set TURBO_TOKEN
```

--------------------------------

### Unlink remote cache using npm

Source: https://vercel.com/docs/monorepos/remote-caching?from=graph&relationship=inbound&source_path=%2Fdocs%2Fmonorepos%2Fnx&source_site=vercel-docs&surface=html

Disable Remote Caching and unlink the current directory from the Vercel Remote Cache. Run on a per-developer basis.

```bash
npx turbo unlink
```

--------------------------------

### Exchange OIDC token for Turborepo access token in exchange-oidc-token.sh

Source: https://vercel.com/docs/monorepos/remote-caching/external-ci-cd

Exchanges an OIDC token issued by your CI/CD provider for a short-lived Turborepo access token assigned to TURBO_TOKEN. If multiple OIDC policies match on your team, include the policy_id parameter with --data-urlencode "policy_id=$POLICY_ID".

```bash
# $OIDC_TOKEN: the OIDC token issued by your CI/CD provider
# $TURBO_TEAM: your Vercel team ID or slug

export TURBO_TOKEN=$(curl -sS -f -X POST https://api.vercel.com/login/oauth/token \
  --data "grant_type=urn:ietf:params:oauth:grant-type:token-exchange" \
  --data "client_id=cl_kyUx2zVvA4MGptBohkmtYHJly2XltXzD" \
  --data "subject_token_type=urn:ietf:params:oauth:token-type:id_token" \
  --data "requested_token_type=urn:ietf:params:oauth:token-type:access_token" \
  --data-urlencode "team_id_or_slug=$TURBO_TEAM" \
  --data-urlencode "subject_token=$OIDC_TOKEN" \
  | jq -r '.access_token')
```

--------------------------------

### Unlink remote cache using yarn

Source: https://vercel.com/docs/monorepos/remote-caching?from=graph&relationship=inbound&source_path=%2Fdocs%2Fmonorepos%2Fnx&source_site=vercel-docs&surface=html

Disable Remote Caching and unlink the current directory from the Vercel Remote Cache. Run on a per-developer basis.

```bash
yarn dlx turbo unlink
```
Tokens:
Raw