{"_id":"@avant-garde/brand-md","name":"@avant-garde/brand-md","dist-tags":{"latest":"0.1.0"},"versions":{"0.1.0":{"name":"@avant-garde/brand-md","version":"0.1.0","description":"brand.md — an open format for describing a brand's soul to agents. Sibling of Google's DESIGN.md, with versioning and per-claim provenance.","type":"module","license":"Apache-2.0","exports":{".":{"types":"./dist/index.d.ts","default":"./dist/index.js"}},"scripts":{"build":"tsup src/index.ts --format esm --dts","test":"vitest run","typecheck":"tsc --noEmit"},"dependencies":{"yaml":"^2.4.0"},"devDependencies":{"tsup":"^8.0.0","typescript":"^5.4.0","vitest":"^1.6.0"},"_id":"@avant-garde/brand-md@0.1.0","gitHead":"882aee4edb09978449709389f6863eeec1aceca8","_nodeVersion":"22.22.2","_npmVersion":"10.9.7","dist":{"integrity":"sha512-KIx0mGbCIpRO0x/CZelX2ihkwgQO960EWwNg5xsYCT7xVVPFbFPlBuHsgoMPC7ye6QNGunNoiGGKIHaOG+e4+g==","shasum":"393399d72709af825e2b0fc06ec2099f4fad9c69","tarball":"https://registry.npmjs.org/@avant-garde/brand-md/-/brand-md-0.1.0.tgz","fileCount":4,"unpackedSize":29261,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQDae6z2FtKAhxlkLxVvKgYrm4HblZaizH3Dh+IbyYjmogIhAITan6Vv3EffMZOtFWzzVShkzQwyAlfS6v3d3D2J4ns5"}]},"_npmUser":{"name":"geastham","email":"garrett@openconjecture.com"},"directories":{},"maintainers":[{"name":"geastham","email":"garrett@openconjecture.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/brand-md_0.1.0_1784261986721_0.5751307009327518"},"_hasShrinkwrap":false}},"time":{"created":"2026-07-17T04:19:46.598Z","0.1.0":"2026-07-17T04:19:46.842Z","modified":"2026-07-17T04:19:46.986Z"},"maintainers":[{"name":"geastham","email":"garrett@openconjecture.com"}],"description":"brand.md — an open format for describing a brand's soul to agents. Sibling of Google's DESIGN.md, with versioning and per-claim provenance.","license":"Apache-2.0","readme":"# brand.md\n\n**An open format for describing a brand's soul to agents.**\n\n[Google's DESIGN.md](https://github.com/google-labs-code/design.md) gives coding agents a persistent, structured understanding of a *visual identity* — how a brand **looks**. `brand.md` is its deliberate sibling: a persistent, structured understanding of who a brand **is** — strategy, personas, voice, positioning, conversion philosophy, guardrails — in a format both humans and agents read natively.\n\nA brand.md file is YAML front matter (the machine-readable brand core) plus markdown prose (the full depth and rationale):\n\n```markdown\n---\nspec: brand.md/v0\nname: Arthaus\nversion: 2\nessence:\n  line: \"Art that lives where you do.\"        # @owner\npersonas:\n  primary:\n    name: \"The Modern Nest Curator\"           # @owner\n    decision_hierarchy:                       # 0–100 weights — sortable by any agent\n      room_first_visual_fit: 98\n      curated_sets_discovery: 92\nvoice:\n  pillars: [curatorial-confidence-not-gatekeeping, ...]\n  never: [\"vague superlatives (stunning, breathtaking)\", ...]\nai_voice_rules:\n  - \"Never reference the technology\"\n  - \"Recommend 2–3 options, never 20\"\nguardrails: [\"no dark patterns\", \"WCAG AA floor\"]\ndesign_ref: ./DESIGN.md\n---\n\n## Essence & North Star\n…prose sections carry the full depth: voice pillars specified as ✔/✘\nexample pairs, messaging frameworks, experience architecture…\n```\n\n## What brand.md adds over DESIGN.md's model\n\n1. **Versioning** — the document version is monotonic; every bump appends to a `Provenance & Change Log` section recording what changed and why. Brands evolve; the soul keeps its history.\n2. **Per-claim provenance** — every front-matter claim carries an origin tag as a YAML comment:\n   - `@owner` — stated by the human; highest authority\n   - `@agent` — proposed by a definition agent, owner-approved\n   - `@data` — derived from the brand's own analytics; carries a freshness window and a re-derivation query\n   - `@research` — externally researched (competitive/market claims); carries a citation and research date\n\n   Provenance is what makes the document trustworthy enough to sit underneath every automated creative act.\n\n## Library\n\n```ts\nimport { parseBrandMd, distillBrandContext, lintBrandMd } from \"@avant-garde/brand-md\";\n\nconst doc = parseBrandMd(raw);          // front matter + sections (provenance-preserving)\nconst ctx = distillBrandContext(doc);   // the compact per-turn subset for agent instructions (~3KB)\nconst findings = lintBrandMd(doc);      // missing-essence, unowned-claim, duplicate-heading, …\n```\n\nThe distilled context is designed to be injected into an agent's system prompt on every turn — voice, AI interaction rules, copy formulas, guardrails, and the primary persona's weighted decision hierarchy — with the full prose loadable on demand.\n\n## The worked example\n\n[`examples/arthaus/`](./examples/arthaus/) contains a complete Brand Soul manifest produced by the definition pipeline (compose research brief → deep research → owner-iterated strategy → generative visual exploration):\n\n| File | Role |\n|---|---|\n| `research-brief.md` | The competitive deep-research contract |\n| `brand.md` | The soul (v2 — includes a real version bump with change log) |\n| `design-exploration-prompts.md` | The visual-discovery prompt pack (per-surface prompts + diversity axes) |\n| `DESIGN.md` | The body — a conforming Google-spec DESIGN.md |\n\n## Status\n\n`brand.md/v0` — draft, extracted from a production pipeline (Marketing OS). The spec will move fast; expect breaking changes before v1. Apache-2.0.\n","readmeFilename":"README.md","_rev":"1-242083f45ad349d9531f1bda0507c812"}