DocsGPT AGENTS.md

AGENTS.md

• Read CONTRIBUTING.md before making non-trivial changes.
• For day-to-day development and feature work, follow the development-environment workflow rather than defaulting to setup.sh / setup.ps1.
• Avoid using the setup scripts during normal feature work unless the user explicitly asks for them. Users configure .env usually.
• Try to follow red/green TDD

Check existing dev prerequisites first

For feature work, do not assume the environment needs to be recreated.

• Check whether the user already has a Python virtual environment such as venv/ or .venv/.
• Check whether Postgres is already running and reachable via POSTGRES_URI (the canonical user-data store).
• Check whether Redis is already running.
• Reuse what is already working. Do not stop or recreate Postgres, Redis, or the Python environment unless the task is environment setup or troubleshooting.

MongoDB is not required for the default install. It is only needed if the user opts into the Mongo vector-store backend (VECTOR_STORE=mongodb) or is running the one-shot scripts/db/backfill.py to migrate existing user data from the legacy Mongo-based install. In those cases, pymongo is available as an optional extra, not a core dependency.

Normal local development commands

Use these commands once the dev prerequisites above are satisfied.

Backend

source .venv/bin/activate  # macOS/Linux
uv pip install -r application/requirements.txt  # or: pip install -r application/requirements.txt

Run the API. For local dev, prefer the ASGI entrypoint under uvicorn — it serves the whole app, matches production, and hot-reloads:

uvicorn application.asgi:asgi_app --host 0.0.0.0 --port 7091 --reload

flask --app application/app.py run --host=0.0.0.0 --port=7091 is a faster inner loop (quick startup, the Werkzeug interactive debugger), but it serves only the WSGI Flask app and omits the routes mounted on the ASGI shell in application/asgi.py: