mirror of
https://github.com/furyhawk/agent_delta.git
synced 2026-07-21 10:15:36 +00:00
67 lines
1.8 KiB
Markdown
67 lines
1.8 KiB
Markdown
# AGENTS.md
|
|
|
|
This file provides guidance for AI coding agents (Codex, Copilot, Cursor, Zed, OpenCode).
|
|
|
|
## Project Overview
|
|
|
|
**agent_delta** - FastAPI application generated with [Full-Stack AI Agent Template](https://github.com/vstorm-co/full-stack-ai-agent-template).
|
|
|
|
**Stack:** FastAPI + Pydantic v2, PostgreSQL
|
|
, JWT + API Key auth, Redis
|
|
, pydantic_deep (openai), RAG (qdrant), Next.js 15 (i18n)
|
|
|
|
## Commands
|
|
|
|
```bash
|
|
# Run server
|
|
cd backend && uv run uvicorn app.main:app --reload
|
|
|
|
# Tests & lint
|
|
pytest
|
|
ruff check . --fix && ruff format .
|
|
|
|
# Migrations
|
|
uv run alembic upgrade head
|
|
uv run alembic revision --autogenerate -m "Description"
|
|
|
|
# RAG
|
|
uv run agent_delta rag-ingest /path/to/file.pdf --collection docs
|
|
uv run agent_delta rag-search "query" --collection docs
|
|
|
|
# Sync Sources
|
|
uv run agent_delta cmd rag-sources
|
|
uv run agent_delta cmd rag-source-add
|
|
uv run agent_delta cmd rag-source-sync
|
|
```
|
|
|
|
## Project Structure
|
|
|
|
```
|
|
backend/app/
|
|
├── api/routes/v1/ # Endpoints
|
|
├── services/ # Business logic
|
|
├── repositories/ # Data access
|
|
├── schemas/ # Pydantic models
|
|
├── db/models/ # DB models
|
|
├── agents/ # AI agents
|
|
├── rag/ # RAG (embeddings, vector store, ingestion)
|
|
│ └── connectors/ # Sync source connectors
|
|
└── commands/ # CLI commands
|
|
```
|
|
|
|
## Key Conventions
|
|
|
|
- `db.flush()` in repositories, not `commit()`
|
|
- Services raise `NotFoundError`, `AlreadyExistsError`
|
|
- Separate `Create`, `Update`, `Response` schemas
|
|
- Commands auto-discovered from `app/commands/`
|
|
- Document ingestion via CLI and API upload
|
|
- Sync sources: configurable connectors with scheduled sync
|
|
|
|
## More Info
|
|
|
|
- `docs/architecture.md` - Architecture details
|
|
- `docs/adding_features.md` - How to add features
|
|
- `docs/testing.md` - Testing guide
|
|
- `docs/patterns.md` - Code patterns
|