Flujo de trabajo basado en especificaciones
Define los requisitos antes de escribir código.
Bienvenidos. Esta es la página principal de todo lo relacionado con OpenSpec.
OpenSpec te ayuda a ti y a tu asistente de codificación de IA a acordar qué construir antes de escribir cualquier código. Tú describes el cambio, la IA redacta una especificación corta y una lista de tareas, ambos miran el mismo plan y luego se realiza el trabajo. No más descubrimientos a mitad del camino de que la IA construyó algo incorrecto.
Si no lees nada más, lee estas dos páginas:
/opsx:propose (pista: en tu chat de IA, no en la terminal). Esto confunde a casi todo el mundo una vez.La segunda es más importante de lo que parece. OpenSpec tiene dos mitades: una herramienta de línea de comandos que ejecutas en tu terminal y comandos slash que le das a tu asistente de IA. Saber cuál es cuál te ahorra el momento de confusión más común.
El mejor hábito para desarrollar primero: cuando no estás seguro de qué construir, comienza con
/opsx:explore. Es un compañero de pensamiento sin riesgos que lee tu código, sopesa las opciones y refina una idea vaga en un plan concreto antes de que exista cualquier artefacto o código. La guía Explore First lo demuestra.
Soy completamente nuevo. Empieza con Getting Started y luego echa un vistazo a los Core Concepts at a Glance. Cuando algo te parezca misterioso, la FAQ y el Glossary están cerca.
Tengo un problema pero no tengo un plan. Este es el caso común, y tiene una respuesta dedicada: Explore First. Usa /opsx:explore para pensarlo con la IA antes de comprometerte con nada.
Tengo una base de código grande existente. No documentas todo. Using OpenSpec in an Existing Project muestra cómo empezar en código real (brownfield) sin ahogar el océano.
Solo quiero que funcione. Install, ejecuta openspec init y luego lee How Commands Work para que tu primer comando slash aterrice en el lugar correcto.
Aprendo por ejemplo. La página Examples & Recipes recorre cambios reales de principio a fin: una pequeña característica, una corrección de errores, un refactor, una exploración.
Vengo del flujo de trabajo antiguo. La Migration Guide explica qué cambió y por qué, y promete que tu trabajo existente está seguro.
Quiero adaptarlo al proceso de mi equipo. Customization cubre la configuración del proyecto, esquemas personalizados y contexto compartido.
Algo está roto. Troubleshooting recopila los fallos reales que experimentan las personas, con soluciones.
| Doc | Lo que te proporciona |
|---|---|
| Getting Started | Instalar, inicializar y ejecutar tu primer cambio de principio a fin |
| Explore First | Usar /opsx:explore para pensar en una idea antes de comprometerte |
| How Commands Work | Dónde se ejecutan los comandos slash, qué significa "modo interactivo", terminal vs chat |
| Core Concepts at a Glance | Todo el modelo mental en una página: especificaciones, cambios, deltas, archivo |
| Installation | npm, pnpm, yarn, bun, Nix y cómo verificar que funcionó |
| Doc | Lo que te proporciona |
|---|---|
| Workflows | Patrones comunes y cuándo recurrir a cada comando |
| Examples & Recipes | Recorridos completos de cambios reales, copias y pegas |
| Using OpenSpec in an Existing Project | Adoptar OpenSpec en una base de código brownfield grande |
| Editing & Iterating on a Change | Actualizar artefactos, retroceder, conciliar ediciones manuales |
| Commands | Referencia para cada comando slash /opsx:* |
| CLI | Referencia para cada comando de terminal openspec |
| Doc | Lo que te proporciona |
|---|---|
| Concepts | La explicación detallada de especificaciones, cambios, artefactos, esquemas y archivo |
| OPSX Workflow | Por qué el flujo de trabajo es fluido en lugar de bloqueado por fases, además de una inmersión arquitectónica |
| Glossary | Cada término definido en un solo lugar |
| Doc | Lo que te proporciona |
|---|---|
| Customization | Configuración del proyecto, esquemas personalizados y contexto compartido |
| Multi-Language | Generar artefactos en idiomas distintos al inglés |
| Supported Tools | Las 25+ herramientas de IA con las que se integra OpenSpec, y dónde aterrizan los archivos |
| Doc | Lo que te proporciona |
|---|---|
| FAQ | Respuestas rápidas a las preguntas más comunes |
| Troubleshooting | Soluciones concretas para fallos concretos |
| Migration Guide | Cómo pasar del flujo de trabajo heredado a OPSX |
| Doc | Lo que te proporciona |
|---|---|
| Stores: User Guide | Planificar en su propio repo cuando tu trabajo abarca varios repos o equipos |
| Agent Contract | Las interfaces CLI legibles por máquina que impulsan los agentes |
1. Install npm install -g @fission-ai/openspec@latest
2. Initialize cd your-project && openspec init
3. Explore (in your AI chat) /opsx:explore ← opcional, pero un gran hábito
4. Propose (in your AI chat) /opsx:propose add-dark-mode
5. Build (in your AI chat) /opsx:apply
6. Archive (in your AI chat) /opsx:archiveLos pasos 1 y 2 se realizan en tu terminal. El resto ocurre en el chat de tu asistente de IA. Esa división es la única cosa que vale la pena memorizar, y How Commands Work explica exactamente por qué. El paso 3 es opcional, pero empezar con /opsx:explore cuando no estás seguro es el hábito más valioso para formar.
openspec feedback "your message" envía comentarios directamente desde tu terminal (abre un problema en GitHub).¿Encontraste algo incorrecto, desactualizado o confuso en esta documentación? Eso es un error. Abre un problema o un PR. Las mejoras en la documentación son algunas de las contribuciones más valiosas que puedes hacer.