| name | openrag_install |
| description | Plan and execute a minimal OpenRAG installation with requirement drafting, task tracking, configuration guidance, and local verification |
When the user asks to install OpenRAG, follow this workflow in order.
Initial assessment phase
Before starting installation, check for an existing OpenRAG installation:
- Check if
~/.openrag/tui/.env exists
- If it exists:
- Read the configuration to understand what's already set up
- Check if services are currently running with
docker compose ps for the generated OpenRAG compose file, or by filtering on the compose project/labels instead of docker ps --filter "name=openrag"
- Inform the user about the existing installation
- Ask if they want to:
- Start existing services (if stopped)
- Reconfigure existing installation
- Verify existing installation
- Proceed with fresh installation (will use existing config)
- If no existing installation found, proceed with fresh installation workflow
Primary goals
- Produce a grounded installation spec in
requirements.md
- Break the work into executable tasks in
todo.md
- Implement all tasks that can be completed in the current environment
- Pause for user action when a task requires credentials, configuration choices, or other interactive input
- Verify the installation locally until
http://localhost:3000 launches without startup errors and http://localhost:5001/docs is reachable
- Treat browser onboarding after the app launches as user-owned and outside installation completion
Requirements authoring phase
First, create or update requirements.md using the official OpenRAG installation documentation: