Quick Start
Get your application configured, synced, and ready for production in under 5 minutes.
📋 Prerequisites
RuntimeNode 18+ / Python 3.9+
API KeyGenerated in your dashboard
NetworkInternet access to api.appconfig.json
🛠 Step-by-Step Setup
1
Install the SDK
Add the App Config.json client to your project. We provide native packages for all major ecosystems.
npm install @appconfig/sdk
package.json
"dependencies": {
"@appconfig/sdk": "^3.0.0",
// ... other deps
}
💡
Prefer Python or Go? Run
pip install appconfig or go get github.com/appconfig/sdk-go.2
Initialize & Connect
Run the CLI initializer to generate a local .appconfig.json and connect to your project.
npx appconfig init
✓ Authenticated with key: sk_live_••••••••
✓ Project "my-app" linked
✓ Config schema downloaded (12 keys)
✓ Ready to sync.
⚠️
Never commit
AC_API_KEY to version control. Use environment variables or a secrets manager.3
Load Config in Code
Import the SDK and load your configuration. It handles caching, retries, and live updates automatically.
index.js
import { AppConfig } from '@appconfig/sdk';
const config = new AppConfig({
apiKey: process.env.AC_API_KEY,
env: process.env.NODE_ENV || 'development'
});
await config.sync();
console.log(config.get('features.dark_mode')); // true
console.log(config.get('api.rate_limit', 100)); // fallback: 100
The SDK automatically subscribes to WebSocket updates. When you change a value in the dashboard, config.get() returns the live value without restarts.
4
Publish & Verify
Push your first configuration change. Use the CLI or dashboard to deploy to staging or production.
npx appconfig push --env staging
✓ Validating schema...
✓ Building diff (3 keys changed)
✓ Deploying to staging environment
✓ Synced to 4 instances in 42ms
Check your application logs or use the dashboard's "Instance Status" tab to confirm all nodes received the update.