Skip to content

Inicio rápido

1) Instalación

sh
dotnet tool install -g coders

Detalles de instalación/uso

Inicializar workspace

Ejecuta coders init para generar la configuración predeterminada y un conjunto de ejemplos .jssp.

  • Sin -f|--force, se detiene si existe config.yml.
  • -v|--verbose amplía los logs de consola al nivel de información.
  • --force sobrescribe los archivos existentes con la nueva plantilla.

Los valores predeterminados de config.yml son:

yaml
llmOptions:
  # Proveedor LLM a usar
  provider: "ollama"
  # Nombre del modelo usado en el build
  model: "gpt-oss-safeguard:20b"
  # Endpoint LLM y credenciales
  url: "http://localhost:11434"
  apiKey: "OLLAMA_API_KEY"
  timeoutSeconds: 300
  stream: true
entry: main.jssp
projects: []

llmOptions gestiona proveedor, modelo, endpoint, autenticación, timeout y streaming para llamadas LLM. projects define las salidas por plataforma; agrega entradas con coders platform add y luego edítalas.

Gestión de plataformas

  • coders platform list [-v]: muestra las claves de plataforma registradas y la información de destino/idioma por defecto.
  • coders platform add <platform> [-v]: añade la configuración de proyecto predeterminada de la plataforma indicada a config.yml. Edita la entrada/la ruta de salida y las opciones según sea necesario.
  • coders platform remove <platform> [-v]: subcomando reservado.

Build de fuentes

coders build <platform> [-v] analiza .jssp y genera código para la plataforma indicada.

  • platform debe coincidir con una clave declarada en projects de config.yml.
  • Si falta config.yml, el build se detiene; si falta el archivo de entrada, ocurre un error.
  • El directorio de salida se crea automáticamente si no existe.

Extracción de prompts

coders extract <target> <platform> [-o|--output <path>] [-v] extrae prompts y otros recursos.

  • target es el objetivo de extracción (p. ej. prompt) y platform es la clave de plataforma.
  • Puedes cambiar el directorio de salida con --output; si no se especifica, se usa la ubicación actual.

Flujo típico

sh
coders init
coders platform add <platform>
coders build <platform> -v

Tras la inicialización, agrega la plataforma requerida a la configuración y ejecuta el build con la misma clave.

2) Inicializar workspace

sh
coders init

Archivos base generados:

  • config.yml
  • main.jssp

3) Agregar plataformas

sh
coders platform add springboot
coders platform add reactjs
coders platform add mysql

Se agregan entradas projects a config.yml.

4) Escribir DSL

Escribe el DSL de Coders en main.jssp.

js
domain Email string(320);

table user {
  user_id int64 auto;
  email Email unique;
  key(user_id);
}

5) Build

sh
coders build springboot

Los resultados se generan en outPath de config.yml.

Ejemplos de build por plataforma

sh
coders build springboot
coders build reactjs
coders build mysql

Cada plataforma se genera en un directorio de salida separado según la configuración de projects.

Construir varias plataformas en una sola ejecución

Repite las claves de plataforma o agrúpalas en un script.

sh
coders build springboot
coders build reactjs
coders build mysql

El CLI actual no tiene opción de build en lote multi-plataforma, por lo que se ejecutan de forma secuencial.

6) Extracción de prompts (opcional)

sh
coders extract prompt springboot

Útil para verificar reglas de transformación específicas por plataforma.

Checklist

  • ¿La plataforma está registrada en projects de config.yml?
  • ¿Existe el archivo entry?
  • ¿Los ajustes de LLM (llmOptions) son correctos?

Errores comunes

  • Omitir la clave de plataforma al ejecutar coders build
  • entry es distinto de main.jssp y no se actualizó
  • El nombre del proveedor/modelo LLM no coincide con el servicio real