@wmoriah/shield-core
v1.0.0
Published
NPM Installer CLI for SHIELD Orchestrator (Profile-First Architecture)
Readme
SHIELD ORCHESTRATOR
Class: SYSTEM | Versioned: yes | Retention: permanent
🎨 Convenção Visual (Core vs Local)
Para facilitar a identificação imediata do que é versionado (Core) e o que é privado (Local), adotamos a seguinte convenção de pastas:
- Pastas Comuns (Sem prefixo): Pertencem ao Core/Git. Devem ser mantidas limpas e genéricas (ex:
core/,builder/,tools/). - Pastas
@local(Prefixadas): São diretórios estritamente Privados/Locais. Estão no.gitignoree nunca serão enviadas ao GitHub.@local-sandbox/(testes rápidos, memória temporária e rascunhos)@local-references/(materiais de pesquisa externa)
SHIELD é um motor de orquestração multi-agente profile-first independente.
Inspirado na robustez de sistemas como AIOX e BMAD, o SHIELD evoluiu para um ecossistema autônomo. Mantemos referências a estes sistemas como diretrizes de engenharia, garantindo que nosso motor incorpore as melhores práticas de mercado sem herdar as limitações legadas.
Por que o SHIELD existe?
A maioria das stacks de automação de IA falha em produção porque mistura:
- Lógica de plataforma reutilizável.
- Regras de negócio específicas do cliente/perfil.
- Scripts de execução temporários.
O SHIELD mantém estas preocupações separadas, rastreáveis e escaláveis.
Conceitos Fundamentais
- Jarvis: Interface de entrada que recebe diretrizes de missão em linguagem natural.
- Fury: Orquestrador central que realiza o planejamento e a execução dentro do runtime HELICARRIER.
- Agnosticismo de Protocolo: Adaptadores independentes que permitem interação com diversos ambientes sob um contrato único.
- Evidência Total: Cada etapa emite provas de execução e rastreabilidade de handoff.
- Profile-First: Cada organização define seu próprio modelo de governança sem depender de modificações no
core.
Nomenclatura Oficial
- Sistema/Framework:
SHIELD - Motor de Runtime:
HELICARRIER - Interface de Intake:
JARVIS - Orquestrador de Missão:
FURY
Modelo Multi-Empresa (Profile-First)
core/: Lógica compartilhada da plataforma (imutável por perfil).profiles/<seu_perfil>/: Modelo operacional da sua empresa.profiles/<seu_perfil>/projects/<seu_projeto>/: Execução de missões específicas.
Você não precisa reescrever o framework para adaptá-lo a uma nova empresa; basta criar um novo profile.
Quick Start (5 minutos)
1. Validar Baseline
python3 -m unittest discover -s tests/orchestrator -p 'test_*.py'
python3 tools/validate_manifests.py2. Executar Missão de Teste (Safe)
python3 tools/jarvis_say.py \
"Executar uma missão de teste com handoffs visíveis" \
--project projeto-exemplo \
--stage operations-audit \
--pillar operations \
--dry-run \
--agent-llm-mode mock3. Modo Conversacional (Jarvis)
jarvis onDica: Na raiz do repositório, diga "novo cliente..." para iniciar o assistente de criação de projeto.
Estrutura do Repositório
core/: Componentes reutilizáveis (agentes, workflows, orchestrator).profiles/: Camada de perfis (ex:Usuario) e instâncias de projeto.tools/: Utilitários operativos via CLI.docs/: Documentação curada e técnica.operations/: Evidências de execução e registros históricos.
📚 Documentação & Inteligência
- 🎴 Agentes: Índice completo dos 31 agentes e atributos TCG.
- ⚙️ Workflows: Processos operacionais e governança de squads.
- 🛠️ Ferramentas: Arsenal de scripts e utilitários.
- 🧠 Diretriz Mestra: A "alma" da inteligência do sistema.
Mergulho Técnico (Deep Dive)
- Quickstart | Arquitetura | Operações
- Ciclo Operacional
- Guia de Perfis | Nomenclatura
- Mapa do Repositório
Licença
Este projeto é licenciado sob a MIT License. Veja o arquivo LICENSE para detalhes.
