mcpField
B
brandfy-setup

brandfy-setup

github.com/promovawebAgent workflows13157 installsUpdated 2w ago
Repository

About brandfy-setup

brandfy-setup is an agent skill for preparing a project’s Brandfy workspace and governance files. It preserves existing content, records missing information explicitly, and checks that setup is repeatable.

Key features

  1. 01Creates only missing setup files
  2. 02Migrates legacy manual to BRAND.md
  3. 03Updates the Brandfy block in AGENTS.md
  4. 04Checks setup for repeatability

Use cases

  1. 01Preparing a project for Brandfy work
  2. 02Migrating a legacy brand manual
  3. 03Checking an existing setup for incomplete configuration

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/promovaweb/brandfy --skill brandfy-setup

After installing, type/brandfy-setupin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

agents/
openai.yaml
references/
agents-consumer.md
scripts/
setup.mjs

Details

From the project README

Configurar o Brandfy

Protocolo operacional

  • Plano e progresso: criar um plano visível e atualizar o estado após a inspeção, a configuração e a validação.
  • Fontes de verdade: ler o AGENTS.md do projeto, os arquivos existentes em .brandfy/ e a referência agents-consumer.md.
  • Escopo e idempotência: preservar configurações e artefatos existentes. O setup só cria arquivos ausentes, migra o manual legado para BRAND.md e substitui apenas o bloco Brandfy no AGENTS.md.
  • Validação: executar o setup com --check depois da escrita e revisar o git diff.
  • Resumo final: informar arquivos criados, arquivos preservados, validações e pendências.

Fluxo

  1. Localizar a raiz do projeto e ler suas instruções.

  2. Executar:

    node <caminho-da-skill>/scripts/setup.mjs --project .

  3. Abrir .brandfy/config.yaml e ajustar nome, país, idioma, destino e fase da marca com o usuário.

  4. Quando o briefing ainda estiver incompleto, usar $brandfy-entrevista para conduzir a descoberta e preencher os arquivos sem inventar respostas.

  5. Preencher .brandfy/brief.md apenas com fatos confirmados. Manter lacunas explícitas, com pergunta e responsável.

  6. Conferir o bloco delimitado por brandfy:consumer no AGENTS.md.

  7. Executar:

    node <caminho-da-skill>/scripts/setup.mjs --project . --check

Depois do setup, abra .brandfy/config.yaml, BRAND.md e brand/README.md para confirmar o destino, o guia e o índice. Um segundo uso deve terminar sem alterações, e qualquer diferença indica configuração incompleta ou bloco do agente antigo.

Em um projeto antigo, o manual que ainda estiver em brand/README.md passa para BRAND.md; uma cópia anterior fica em brand/archive/ quando necessário.

Raciocínio do especialista

Tratar o setup como preparação de governança, não como criação da marca. Confirmar responsáveis por respostas e aprovações, localização das comprovações, arquivos canônicos e forma de resolver pendências. Uma estrutura completa com informação fraca continua sendo um projeto incompleto.

Comments

Markdown supported