Skip to content
ACMS ACMS Docs

Vercel Edge Config Adapter

The Vercel Edge Config adapter stores your content schema in Vercel Edge Config, providing ultra-low-latency reads at the edge. Ideal for Vercel-hosted applications.

Installation

Section titled “Installation”
Terminal window
npm install @useacms/cli

Configuration

Section titled “Configuration”
import { defineConfig } from '@useacms/client';
import { localFile, vercelEdgeConfig } from '@useacms/cli/adapters';


export default defineConfig({
  dev: localFile({ path: './acms.json' }),
  production: vercelEdgeConfig({
    token: process.env.VERCEL_TOKEN,
    edgeConfigId: process.env.EDGE_CONFIG_ID,
  }),
});

Options

Section titled “Options”
OptionTypeRequiredDescription
tokenstringYesVercel API token
edgeConfigIdstringYesEdge Config store ID

Setup

Section titled “Setup”

1. Create a Vercel API Token

Section titled “1. Create a Vercel API Token”
  1. Go to Vercel Settings > Tokens.
  2. Create a new token with appropriate scope.
  3. Copy the token.

2. Create an Edge Config Store

Section titled “2. Create an Edge Config Store”
  1. In your Vercel dashboard, go to Storage > Edge Config.
  2. Create a new Edge Config store.
  3. Copy the Edge Config ID.

3. Configure Environment Variables

Section titled “3. Configure Environment Variables”
.env
VERCEL_TOKEN=your_vercel_token
EDGE_CONFIG_ID=ecfg_xxxxxxxxxxxxxxxxxxxx

Usage

Section titled “Usage”

Push and pull work the same as any other adapter:

Terminal window
acms push    # Upload to Edge Config
acms pull    # Download from Edge Config
acms sync    # Bi-directional sync

How It Works

Section titled “How It Works”
  • Read: Fetches content from Vercel Edge Config via the Edge Config API.
  • Write: Updates the Edge Config store with the new schema.

Edge Config provides sub-millisecond reads at the edge, making it ideal for runtime content delivery.

Use Cases

Section titled “Use Cases”
  • Vercel-hosted apps — Native integration with Vercel’s infrastructure.
  • Edge performance — Sub-millisecond reads globally.
  • Runtime strategy — Best paired with strategy: 'runtime' for dynamic content.

Limitations

Section titled “Limitations”
  • Requires a Vercel account and project.
  • Edge Config has a size limit (512 KB on the free plan, more on paid plans).
  • Write operations are eventually consistent.

Next Steps

Section titled “Next Steps”