← Getting Started

Welcome to App Config.json. This guide will walk you through initializing your first project, integrating the SDK, and syncing your first configuration change in under 5 minutes.

💡 Prerequisites

Ensure you have Node.js (18+), Python (3.9+), or Go (1.21+) installed. You'll also need an active account to generate your API token.

1

Install the CLI & SDK

Start by installing the App Config.json command-line interface. This tool handles project scaffolding, authentication, and local sync operations.

Terminal
# Using npm
npm install -g @appconfig/cli

# Or using pip
pip install appconfig-json-cli
2

Initialize Your Project

Navigate to your project root and run the init command. The CLI will prompt for your API token and target environment.

Terminal
cd /path/to/your/project
appconfig init --env production

# ✅ Created config.json
# ✅ Linked to workspace: my-app-main
3

Integrate the SDK

Drop the SDK into your application entry point. It automatically handles polling, caching, and fallback resolution.

index.js
import { ConfigClient } from '@appconfig/sdk';

const client = new ConfigClient({
  apiKey: process.env.APP_CONFIG_KEY,
  projectId: 'proj_x9k2m',
  pollInterval: 5000
});

const config = await client.load();
console.log(config.database.url);
4

Sync & Verify

Push your local schema and verify real-time propagation across all registered instances.

Terminal
appconfig sync --force

⚡ Syncing config.json → production
✓ 3 endpoints updated
✓ Zero downtime applied

What's Next?

Now that your foundation is set, explore these guides to unlock the full potential of your configuration pipeline.