aisix-archived AGENTS.md

AGENTS.md

For AI coding assistants (OpenCode, Cursor, Copilot, etc.): This file is the primary context source for AI assistants working on this codebase. Use it to understand project structure, coding conventions, and build commands.

For human contributors: See CONTRIBUTING.md for the contribution guide.

Project Overview

Rust-based AI gateway proxy supporting OpenAI, Anthropic, Gemini, and DeepSeek APIs. Built with Axum for HTTP, Tokio for async runtime, and etcd for configuration storage.

Includes a React-based admin UI (in ui/) for managing models, API keys, and a playground for testing chat completions.

Build, Lint, and Test Commands

Build

cargo build           # Debug build
cargo build --release # Release build

Run

RUST_LOG=info cargo run

UI Development

cd ui
pnpm install --frozen-lockfile    # Install dependencies
pnpm dev        # Start dev server
pnpm build      # Build for production
pnpm lint       # Run ESLint
pnpm format     # Format with Prettier
pnpm typecheck  # Type check without emit
pnpm preview    # Preview production build

Lint

cargo clippy --all-targets --all-features --locked -- -D warnings

Clippy warnings are treated as errors. Fix all warnings before committing.

Test

cargo test                             # Run all tests
cargo test --verbose                   # Run tests with verbose output
cargo test --test api                  # Run specific test file (tests/api.rs)
cargo test test_crud                   # Run specific test by name
cargo test --test admin::models_api    # Run tests in specific module
cargo test -- --nocapture              # Show test output

E2E Test

pnpm -C tests install --frozen-lockfile  # Install e2e dependencies
pnpm -C tests test                       # Run all e2e tests

Format

cargo fmt          # Format all code
cargo fmt -- --check  # Check formatting without changes