Installation

Requirements

• Node.js 18+
• A Gatepost account (free to start)

Install the SDK

npm install @gatepost/client

OpenFeature compatibility

Gatepost is fully compatible with the OpenFeature specification. You can use either:

Option 1: Gatepost SDK (recommended)

import { GatepostProvider } from "@gatepost/client";
import { OpenFeature } from "@openfeature/client";

await OpenFeature.setProvider(new GatepostProvider({
  apiKey: process.env.GATEPOST_API_KEY,
  // Optional: specify default environment
  environment: "production"
}));

Option 2: Official OpenFeature SDK

import { Provider } from "@openfeature/server-sdk";

// Use Gatepost as a provider
// (Provider implementation coming soon)

Get your API key

1. Sign up at gatepost.app
2. Go to Settings → API Keys
3. Create a new key (use gp_live_xxx for production)

Next steps

• Quickstart - Evaluate your first flag
• Core Concepts - Learn the fundamentals