Skip to content

brand.config.json

Generated by nib brand init and stored at .nib/brand.config.json. Controls paths, platform outputs, and AI provider settings for the brand system.

Schema

json
{
  "version": "1",
  "generator": "nib",
  "brand": {
    "name": "Acme Corp",
    "personality": ["professional", "warm"]
  },
  "tokens": "docs/design/system/tokens",
  "platforms": {
    "css": "docs/design/system/build/css/variables.css",
    "tailwind": "docs/design/system/build/tailwind/preset.js",
    "pencil": "docs/design/system/build/pencil/variables.json"
  },
  "output": "docs/design/system",
  "ai": {
    "provider": "anthropic",
    "model": "claude-sonnet-4-20250514"
  }
}

Fields

FieldTypeDescription
version"1"Config format version
generator"nib"Always "nib"
brand.namestringBrand name
brand.personalitystring[]Personality traits (e.g. "professional", "warm", "bold")
tokensstringPath to the DTCG token source directory
platformsobjectPaths to platform-specific build outputs
platforms.cssstringCSS custom properties file
platforms.tailwindstringTailwind preset file
platforms.pencilstringPencil.dev variables JSON
outputstringRoot output directory for the design system
ai.providerstringAI provider used during init: "anthropic", "openai", "ollama"
ai.modelstringModel used (optional)

Environment Variables

VariableDescription
NIB_AI_PROVIDEROverride AI provider (same values as --ai flag)
ANTHROPIC_API_KEYAnthropic API key for brand enhancement
OPENAI_API_KEYOpenAI API key for brand enhancement
NIB_AI_BASE_URLBase URL for Ollama or any OpenAI-compatible endpoint

Notes

  • This file is auto-generated — edit it to change paths or provider settings
  • The tokens path points to the source of truth (DTCG JSON files)
  • The platforms paths point to generated outputs — rebuilding with nib brand build overwrites them
  • All paths are relative to the project root

Released under the AGPL-3.0 License.