dbcrust: Instructions file for Codex

AGENTS.md - Development Guide for DBCrust

This file provides guidance for agentic coding tools working with the DBCrust codebase.

Build/Lint/Test Commands

Core Build Commands

# Install Bun-managed GUI dependencies
mise run gui:install

# Build the project (development)
mise run build:dev

# Build optimized release version
mise run build

# Build GUI frontend only
mise run gui:build-frontend

# Build the Tauri GUI
mise run gui:build

# Build Python package (development)
mise run py:dev

# Build Python wheel
mise run py:build

# Install Python package
pip install -e ./python

Testing Commands

# Run all tests
mise run test

# Run tests with output
cargo test -- --nocapture

# Run specific test
cargo test test_name

# Run tests for specific module
cargo test --lib module_name

# Run Python interface tests (pure-Python Django toolkit suite)
mise run py:test

Linting and Formatting

# Format code
mise run fmt

# Lint with clippy (critical issues only)
mise run lint

# Run the standard validation suite
mise run check

# Git hooks are managed by hk (config: hk.pkl)
hk check --all

Code Style Guidelines

General Principles

• Modular Design: Single responsibility per module
• Async/Await: Use throughout for database operations
• Error Handling: Use thiserror for custom error types with user-friendly messages
• User Interaction: MANDATORY - Use inquire crate for ALL user prompts (Select, Confirm, Text, MultiSelect)
• NEVER use manual stdin/stdout prompting or println! for interactive input

Naming Conventions

• Structs/Enums: PascalCase (e.g., Database, Command, Config)
• Functions/Methods: snake_case (e.g., connect_to_database, parse_command)
• Variables: snake_case (e.g., connection_url, config_path)
• Constants: SCREAMING_SNAKE_CASE (e.g., DEFAULT_TIMEOUT)
• Modules: snake_case (e.g., database, commands, config)

Imports and Dependencies

• Group imports: std, external crates, local modules
• Use explicit imports, avoid glob imports (use::*)
• Keep dependency features minimal and explicit
• CRITICAL: Never remove the strum crate dependency (essential for enum iteration)