saltar al contenido principal
Explorar la documentación

syncanix init

Descubre tu API, construye el catálogo de capacidades y lo sube, con enriquecimiento por IA sujeto a consentimiento.

init es el comando que más usarás. Analiza tu proyecto, convierte tu API en un catálogo de capacidades y lo sube a tu espacio de trabajo.

npx syncanix init

Opciones

-f, --framework <name>
Fuerza un framework concreto en lugar de detectarlo automáticamente. Acepta cualquier framework compatible con Syncanix, por ejemplo nestjs, express, fastapi, django o laravel.
--env <env>
Apunta al entorno de development (predeterminado) o production al subir el catálogo.
--offline
Escribe el catálogo localmente sin subirlo.
-y, --yes
Acepta los valores por defecto y omite las preguntas: el enriquecimiento usa tus claves de proveedor locales cuando están definidas, y se omite en caso contrario.
--byok-key <key>
Usa tu propia clave de proveedor de LLM para el enriquecimiento, en lugar de las claves de tu entorno.
--byok-provider <provider>
El proveedor de BYOK: anthropic u openai. Se infiere del formato de la clave si se omite.
--force
Continúa más allá del límite de coste del enriquecimiento, aceptando el gasto estimado.
--reset-consent
Borra el consentimiento de enriquecimiento guardado para que init vuelva a preguntar.
--init-config
Regenera los archivos iniciales .syncanix.yaml y .syncanixignore (sobrescribe los existentes).
--graphql-endpoint <url>
Introspecciona un endpoint de GraphQL en ejecución para tipar las mutaciones code-first.
--telemetry
Activa la telemetría de uso anónima (desactivada por defecto).

Qué hace

  1. Detecta tus frameworksAnaliza el proyecto e informa de cada framework que reconoce, no solo del principal.
  2. Extrae capacidadesLee tus rutas y construye una lista estructurada de capacidades, con sus entradas y efectos.
  3. Aplica .syncanixignoreDescarta todo lo que coincida con tus reglas de exclusión antes de escribirlo, enriquecerlo o subirlo.
  4. Pregunta por el enriquecimiento con IAMuestra una estimación de coste y pregunta cómo quieres proceder antes de enviar texto de código a un proveedor.
  5. Escribe el catálogoGuarda un archivo .syncanix/catalog.json determinista que puedes revisar y versionar.
  6. Lo subeEnvía el catálogo a tu espacio de trabajo, salvo que hayas pasado --offline o aún no tengas clave de API.

Estático por defecto

El descubrimiento lee tu código; nunca lo ejecuta, y ningún dato de producción sale de tu máquina. Lo único que puede enviarse es el catálogo estructurado, y el enriquecimiento con IA solo ocurre con tu consentimiento explícito.

El enriquecimiento con IA redacta títulos y descripciones más claros para tus capacidades. Antes de enviar nada, la CLI muestra exactamente qué se enviaría (identificadores de capacidad, métodos y rutas, nombres de argumentos y un breve extracto del manejador con los secretos redactados) y qué no (archivos de código, tus datos, secretos, cualquier cosa ignorada). Luego eliges un modo:

Claves locales
Usa las claves de Anthropic y OpenAI que ya tienes en tu entorno local, con retención de datos cero aplicada. El enriquecimiento se ejecuta desde tu máquina: no hay ningún servicio de enriquecimiento alojado por Syncanix.
BYOK
Usa tu propia clave de proveedor; el texto del manejador va directamente de tu máquina al proveedor, y Syncanix nunca lo ve.
Omitir
Sin enriquecimiento: entrega solo los metadatos del extractor y enriquece más tarde desde el panel.

Próximos pasos