SDK y CLI
Fóir publica dos paquetes de npm: un cliente tipado para tu aplicación y una herramienta de línea de comandos para scripts y CI.
El cliente tipado
El cliente tipado de @foir/sdk envía GraphQL al mismo endpoint que cualquier otro cliente y escribe el documento por ti. Una llamada tipada es una petición. Por defecto devuelve todos los campos escalares del modelo, y pick, omit e include ajustan la selección.
Sus tipos vienen de foir types y se generan por clave, así que una operación que la clave no puede realizar no está en el tipo.
Dónde se ejecuta el cliente
El cliente usa solo fetch y no guarda estado a nivel de módulo. La documentación lo cubre en Hydrogen, los loaders de React Router, TanStack Start y los runtimes de edge. Otros puntos de entrada del mismo paquete gestionan las sesiones de tus usuarios, las actualizaciones en vivo y los medios.
Qué cubre la CLI
@foir/cli instala el comando foir. Sus grupos de comandos cubren registros, modelos, locales, medios, búsqueda, despliegues, publicaciones, la caché, las claves de API, tus usuarios y sus roles, organizaciones, operaciones, hooks, programaciones, secretos, proveedores de inicio de sesión, exportación y generación de tipos. También aplica tu archivo de configuración con un push. La referencia de la CLI lista los comandos, y la referencia de intents en la documentación muestra qué acciones de la plataforma tienen uno.
Salida e inicio de sesión para scripts
Cada comando imprime una tabla por defecto y puede imprimir JSON, JSON Lines o solo ids, para encadenarlo con pipes. Las cargas vienen de un indicador, un archivo o stdin. Inicias sesión desde el navegador, con un flujo de código de dispositivo para SSH, contenedores y CI, o defines una clave de API en el entorno para ejecuciones sin interfaz.
Lee el detalle
La guía del SDK cubre cómo instalar el cliente tipado, generar sus tipos y hacer llamadas, y la CLI tiene su propia referencia.