example/README.md

Shipflow — ejemplo de uso #

Comandos reales del CLI ship, tomados del README. Se ejecutan desde la raíz de tu proyecto Flutter/Dart.

Instalar #

dart pub global activate shipflow
ship --version       # verifica la instalación → imprime "ship 0.1.0"
ship --help          # (opcional) lista todos los subcomandos

Generar .ship.yaml desde tu proyecto #

ship init --template config

Lee tu pubspec.yaml y escanea el sistema de archivos en busca de tus capas. Abre .ship.yaml y resuelve los # PLACEHOLDER (los campos que Shipflow no pudo detectar).

Ejecutar el primer análisis #

ship analyze --gate domain --format human

Para proyectos grandes, el reporte HTML navegable:

ship analyze --gate full --format html -o ship-reports/

Otros comandos útiles #

ship match color "#0066CC"                                       # resolver un color contra tu catálogo de tokens
ship scaffold auth --layer presentation --style riverpod_manual  # generar un scaffold de feature
ship inventory --output widget_inventory.json                    # inventariar widgets a JSON

(Opcional) Pipeline ticket → MR con tu agente de IA #

ship install-commands --platform claude   # instala los prompts /ship-* en tu agente

Los siguientes son slash-commands que se invocan dentro de tu CLI de IA, no en la terminal:

/ship-complete-config       # enriquece .ship.yaml desde el grafo del código
/ship-pipeline DEV-1234     # ejecuta TICKET → MR de punta a punta