Skip to content

Configuration

Environment Variables

VariableDefaultDescription
COSY_API_KEY(empty)Bearer token for API auth. If empty, auth is disabled.

CLI Flags

See CLI Reference for all flags.

Brand Defaults

All templates use these default brand colors unless overridden in your JSON input:

FieldDefaultDescription
bg_color#1e1e2eBackground gradient start
bg_color_end#11111bBackground gradient end
accent_color#cba6f7Accent gradient start (purple)
accent_color_end#89b4faAccent gradient end (blue)

These match the Catppuccin Mocha dark palette.

Input JSON Structure

All templates expect the same top-level structure:

json
{
  "brand": {
    "brand_name": "Your Brand",
    "brand_handle": "@yourbrand",
    "bg_color": "#1e1e2e",
    "bg_color_end": "#11111b",
    "accent_color": "#cba6f7",
    "accent_color_end": "#89b4fa",
    "bg_image": "/path/to/bg.png",
    "bg_image_opacity": 0.15,
    "logo": "/path/to/logo.png"
  },
  "slides": [
    {
      "stat_number": "123",
      "stat_label": "Users"
    }
  ]
}

Brand Fields

FieldTypeRequiredDescription
brand_namestringYesBrand name, displayed in footer/header
brand_handlestringNoSocial handle (e.g. @codecoradev)
bg_colorhexNoBackground gradient start
bg_color_endhexNoBackground gradient end
accent_colorhexNoAccent gradient start
accent_color_endhexNoAccent gradient end
bg_imagepathNoBackground image (PNG/JPG/WebP)
bg_image_opacityfloatNoBackground image opacity (0.0–1.0, default: 0.15)
logopathNoBrand logo (PNG/SVG), bottom-right corner

Slide Fields

Each template defines its own slide fields. See Templates for per-template schemas.

Released under the BSL-1.0 License.