Fivccliche

A production-ready, multi-user backend framework designed specifically for AI agents. Built with FastAPI and SQLModel for high-performance, type-safe async operations that handle concurrent AI agent requests at scale.

✨ Features

AI Agent Backend - Purpose-built for multi-user AI agent interactions and orchestration
FastAPI - Modern, fast web framework for building high-performance APIs with Python 3.10+
SQLModel - SQL ORM combining SQLAlchemy and Pydantic for type-safe database operations
Async/Await - Full async support for handling concurrent AI agent requests at scale
Type Safety - Built-in type hints with Pydantic 2.0 validation for reliable data handling
Multi-User Support - Designed for managing multiple AI agents with proper isolation and access control
Scheduled Tasks - APScheduler-based per-module scheduled job support, wired through IModule.mount
Testing - Pytest with async support for comprehensive test coverage
Code Quality - Black, Ruff, and MyPy configured for professional code standards
Package Management - uv for fast, reliable dependency management

🚀 Quick Start

Prerequisites

Python 3.10 or higher
uv package manager (install)

Installation

# Clone the repository
git clone https://github.com/MindFiv/FivcCliche.git
cd FivcCliche

# Install production dependencies
uv pip install -e .

# Or install with development tools
uv pip install -e ".[dev]"

Using the CLI

The easiest way to run FivcCliche is using the built-in CLI:

# Start the server
python -m fivccliche.cli run

# Show project information
python -m fivccliche.cli info

# Clean temporary files and cache
python -m fivccliche.cli clean

# Initialize configuration
python -m fivccliche.cli setup

Visit http://localhost:8000/docs for interactive API documentation.

Configuration APIs

Authenticated users can manage user-scoped AI agent resources under /configs/. Superusers create global configs (user_uuid = null) that regular users can read but not update or delete.

/configs/embeddings/ - embedding provider/model configs
/configs/models/ - LLM provider/model configs with id, description, provider, model, api_key, base_url, temperature, max_tokens, optional nullable enable_thinking, user_uuid, updated_at, and updated_user_uuid fields. enable_thinking = null leaves provider behavior unchanged, true enables provider-supported thinking output, and false disables it.
/configs/agents/ - agent configs that compose models, tools, and skills
/configs/tools/ - tool configs, including MCP/function transports
/configs/skills/ - reusable skill configs and resources
/configs/questions/ - reusable user question configs with id, question, optional answer, is_active, user_uuid, updated_at, and updated_user_uuid fields; list with ?is_active=true or ?is_active=false to filter by active state

python -m fivccliche.cli migrate creates missing tables but does not alter existing tables. Existing databases created before user_llm.enable_thinking was added need a manual nullable boolean column on user_llm or a table rebuild.

CLI Options

# Custom host and port
python -m fivccliche.cli run --host 127.0.0.1 --port 9000

# Production mode (no auto-reload)
python -m fivccliche.cli run --no-reload

# Test configuration without running
python -m fivccliche.cli run --dry-run

# Verbose output
python -m fivccliche.cli run --verbose

📚 Documentation

For detailed information, see the documentation in the docs/ folder:

Getting Started - Comprehensive tutorial with examples
Scheduled Tasks - Per-module APScheduler integration
Setup Summary - Installation and project structure
Migration Plan - Technical migration details
Completion Summary - What was accomplished

🛠️ Development

CLI Commands

make format  # Format code with Black
make lint    # Lint with Ruff
make check   # Run all checks (format, lint, type check)

Run Tests

pytest
pytest -v --cov=src  # With coverage

Code Quality

black src/ tests/      # Format code
ruff check src/ tests/ # Lint code
mypy src/              # Type check

Project Structure

fivccliche/
├── pyproject.toml              # Project configuration
├── src/
│   └── fivccliche/
│       ├── __init__.py
│       ├── cli.py              # CLI implementation
│       ├── services/
│       ├── utils/
│       ├── settings/
│       └── modules/
├── tests/                      # Add your tests here
└── docs/                       # Documentation

📦 Dependencies

Production Core: FastAPI, SQLModel, Uvicorn, Pydantic, SQLAlchemy, APScheduler

CLI & Output: Typer, Rich, python-dotenv

Component System: fivcglue, fivcplayground

Development: Pytest, Black, Ruff, MyPy, Coverage

See pyproject.toml for complete dependency list and versions.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

👤 Author

Charlie Zhang (sunnypig2002@gmail.com)

🔗 Links

Repository: https://github.com/MindFiv/FivcCliche
FastAPI: https://fastapi.tiangolo.com/
SQLModel: https://sqlmodel.tiangolo.com/
Pydantic: https://docs.pydantic.dev/

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fivccliche-0.1.76.tar.gz (117.0 kB view details)

Uploaded Aug 8, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

fivccliche-0.1.76-py3-none-any.whl (63.7 kB view details)

Uploaded Aug 8, 2026 Python 3

File details

Details for the file fivccliche-0.1.76.tar.gz.

File metadata

Download URL: fivccliche-0.1.76.tar.gz
Upload date: Aug 8, 2026
Size: 117.0 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: uv/0.5.10

File hashes

Hashes for fivccliche-0.1.76.tar.gz
Algorithm	Hash digest
SHA256	`443f883143e16d5b1d1e26cfc207999eafc108258aaa63dc2518cf130569999b`
MD5	`256f244fda451b19d1a618d1dea8ac99`
BLAKE2b-256	`1049c070d12a4a57174c0ce804b94df897b3ce3fa50213678a215dee02986559`

See more details on using hashes here.

File details

Details for the file fivccliche-0.1.76-py3-none-any.whl.

File metadata

Download URL: fivccliche-0.1.76-py3-none-any.whl
Upload date: Aug 8, 2026
Size: 63.7 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: uv/0.5.10

File hashes

Hashes for fivccliche-0.1.76-py3-none-any.whl
Algorithm	Hash digest
SHA256	`dff784a1bbe8f9acad32b83c748bf20c84c90ad0d38475df23a302c4a44f3991`
MD5	`d63a097da839bdd60efde288ce694c76`
BLAKE2b-256	`50a59d191b9685813b2ba56780813b3e9bb125a722e74f2799005804ad859813`