circuitforge-core/docs/modules/index.md

Module Reference

All circuitforge-core modules live under the circuitforge_core package. Each is independently importable.

Module	Import	Status	One-line summary
db	circuitforge_core.db	Stable	SQLite connection factory + migration runner
llm	circuitforge_core.llm	Stable	LLM router with fallback chain
tiers	circuitforge_core.tiers	Stable	@require_tier() decorator, BYOK unlock
config	circuitforge_core.config	Stable	Env-driven settings, .env loader
hardware	circuitforge_core.hardware	Stable	GPU/CPU detection, VRAM profile generation
documents	circuitforge_core.documents	Stable	Document ingestion → StructuredDocument
affiliates	circuitforge_core.affiliates	Stable	wrap_url() with opt-out + BYOK user IDs
preferences	circuitforge_core.preferences	Stable	Dot-path preference store over local YAML
tasks	circuitforge_core.tasks	Stable	VRAM-aware background task scheduler
manage	circuitforge_core.manage	Stable	manage.sh scaffolding, Docker + native
resources	circuitforge_core.resources	Stable	VRAM allocation + eviction engine
text	circuitforge_core.text	Stable	Text normalization, chunking utilities
stt	circuitforge_core.stt	Stub	Speech-to-text router
tts	circuitforge_core.tts	Stub	Text-to-speech router
pipeline	circuitforge_core.pipeline	Stub	StagingDB base class
vision	circuitforge_core.vision	Stub	Vision router base class
wizard	circuitforge_core.wizard	Stub	First-run wizard base class