Instalación
Instala@fire-spark/cli desde npm. Necesitas Node.js 22 o superior. No tienes que clonar este repositorio.
--help y -h muestran los comandos y las flags, y terminan. La documentación que estás leyendo es la página que la ayuda enlaza. Está aquí: FireSpark Doctor.
Comandos
Si falta el YAML cuando arranca
run, list, show o init, la CLI lo crea y te pregunta solo lo que falta. No tienes que correr init antes.
Configuración
Los datos operativos viven en un YAML, por ejemplo.bembos.doctor.yml, o en las flags. No van en channel-manifest.json. El channel builder descarta las claves que no conoce, y un rebuild las borraría.
La CLI puede leer la identidad desde apps/<slug>/src/channel-manifest.json si tienes el repo del canal: channel_id, name, template, templateVersion y sdkVersion. Un canal que nunca se desplegó puede quedarse solo con esa identidad.
Un canal con deployed: true necesita la URL pública, la URL del dashboard, la URL de la API, store_id, fulfillment_id, el modo de pago (cash o sandbox), la URL del receptor de webhooks y la ruta de evidencia. Las credenciales de prueba van en el entorno (FIRESPARK_DOCTOR_CUSTOMER_EMAIL y FIRESPARK_DOCTOR_CUSTOMER_PASSWORD), no en el comando ni en el YAML.
Si el archivo ya existe y a un canal desplegado le falta uno de esos datos, firespark doctor run se detiene antes de cualquier check. El error nombra el campo y el canal. La CLI no inventa una URL ni un id. Ese preflight es CLI-01 y no se puede arreglar con --fix.
Orden de prueba
ORD-01 crea una orden de prueba (POST /orders y luego place) solo cuando nombras ese id:
SDK-06 crea una orden cash (POST /orders) y no hace place, solo cuando nombras SDK-06. PAY-07 y CHK-01 hacen place de una orden cash igual que ORD-01, solo cuando nombras ese id. Un firespark doctor run sin esos ids no crea ninguna orden. El pago tiene que ser cash o sandbox (efectivo cuenta como cash). Si falta el pago, merchant_id u otro campo que la orden necesita, el check falla y nombra ese campo y el canal. No llama a la API ni se une al realtime. Cuando la orden está completa, se une al canal realtime del cliente antes de place, envía un pago cash y espera un order.changed con checkout_state released. Si llega failed, o si pasa FIRESPARK_DOCTOR_TIMEOUT_MS, el check falla. --fix no crea la orden, no se suscribe y no inventa una URL o un id. No existen las flags --live ni --groups.
Flags
Filtros:--channel, --platform, --required, --area, --verification (Determinística o Mezcla). No existe un filtro --fixable.
--fix intenta corregir los checks que en el catálogo dicen que se pueden arreglar. Sin --fix, la CLI solo informa.
Destino: --url, --dashboard-url, --api-url, --merchant-id, --env, --store-id, --channel-id, --fulfillment-id, --payment, --receiver, --evidence, --format, --strict, --config.