Quick Start

import { defineConfig, s, source } from 'confkit';

export const config = defineConfig({
  sources: [
    source().env(),
    source().file('config.yaml'),
  ],
  schema: {
    NODE_ENV: s.enum(['development','test','production']).default('development'),
    PORT: s.port().default(3000),
    DATABASE_URL: s.url(),
    REDIS_URL: s.string().optional(),
    FEATURES: s.object({
      newCheckout: s.boolean().default(false),
      abTestVariant: s.enum(['A','B']).default('A'),
    }).default({ newCheckout: false, abTestVariant: 'A' }),
    STRIPE_SECRET: s.secret(s.string()),
    PUBLIC_APP_NAME: s.string().client().default('confkit'),
  },
});

import { config } from './conf/config';

const env = await config.ready();
console.log('PORT:', env.PORT);

npx confkit print --file conf/config.ts

import { loadConfig } from 'confkit/load';
const { clientEnv } = await loadConfig({ file: './conf/config.ts' });
export default { env: clientEnv };