@simplens/config-gen

CLI tool to generate simplens.config.yaml from plugin manifests.

Installation

npm install -g @simplens/config-gen
# or use with npx
npx @simplens/config-gen generate @simplens/mock

Usage

Generate config for plugins

# Single plugin
simplens-config generate @simplens/mock

# Multiple plugins
simplens-config gen @simplens/mock @simplens/nodemailer-gmail

# Multiple plugins for same channel (creates default + fallback)
simplens-config gen @simplens/nodemailer-gmail @simplens/sendgrid

Modify existing config

# Add new plugins to existing config
simplens-config gen @simplens/twilio-sms -c simplens.config.yaml

Other options

# Output to custom file
simplens-config gen @simplens/mock -o custom.yaml

# Print to stdout
simplens-config gen @simplens/mock --stdout

# List official plugins
simplens-config list

Example Output

# ============================================
# SimpleNS Configuration
# Generated by @simplens/config-gen
# ============================================

# Provider configurations
providers:
  # nodemailer-gmail - @simplens/nodemailer-gmail
  - package: "@simplens/nodemailer-gmail"
    id: nodemailer-gmail
    credentials:
      EMAIL_USER: ${EMAIL_USER}  # Required
      EMAIL_PASS: ${EMAIL_PASS}  # Required
    optionalConfig:
      EMAIL_FROM: ${EMAIL_FROM}  # Optional
    options:
      priority: 1  # Higher = preferred
      rateLimit:
        maxTokens: 100
        refillRate: 10

# Channel to provider mapping
channels:
  email:
    default: nodemailer-gmail

License

MIT