Skip to content

Latest commit

 

History

History
48 lines (34 loc) · 1.73 KB

File metadata and controls

48 lines (34 loc) · 1.73 KB

AGENTS.md

Tux is an all-in-one open source Discord bot for the All Things Linux community.

Stack: Python 3.13.2+ • discord.py • PostgreSQL • SQLModel • uv • Docker

Quick reference

Task Command
Install deps uv sync
Config examples uv run config generate
DB + migrate uv run db init / uv run db dev
Quality uv run dev all
Tests uv run test quick / uv run test all
Run bot uv run tux start
Validate Cursor content uv run ai validate-rules

Cursor rules and commands

Project standards live in .cursor/rules/*.mdc and workflows in .cursor/commands/.

uv run ai validate-rules

Docs: Creating Cursor Rules · Creating Cursor Commands

Domain-specific detail (database, testing, modules, security, docs) is in .cursor/rules/, not repeated here.

Detailed instructions

Topic File
Setup and repository layout .agents/setup.md
CLI commands (dev, test, db, docs, troubleshooting) .agents/commands.md
Workflow, Docker Compose, commits, PRs .agents/workflow.md
Standards summary, patterns, cache, security .agents/patterns.md

Resources