Initial commit: add config_manager module with ConfigParameter and ConfigManager
This commit is contained in:
32
AGENTS.md
Normal file
32
AGENTS.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# komAI Agent Guidelines
|
||||
|
||||
## Entry Point
|
||||
```
|
||||
python -m app.komAI
|
||||
```
|
||||
|
||||
## Architecture
|
||||
- `app/` - application entry point (komAI.py expected)
|
||||
- `src/` - source code, `src/__init__.py` exposes centralized API
|
||||
- `config/` - YAML configuration; `config/global.yaml` is the main config
|
||||
- `modules/` - pluggable modules, configured via `global.modules`
|
||||
- `log/` - runtime logs
|
||||
- `tests/` - standalone unit tests (executable from CLI)
|
||||
|
||||
## Config System
|
||||
- Modules register parameters at initialization
|
||||
- Save config: `from src import save_config; save_config()`
|
||||
|
||||
## Logging
|
||||
- All console output is duplicated to log files
|
||||
- Log config in `config/global.yaml` (level, file, path)
|
||||
|
||||
## Env Vars (see `.env.example`)
|
||||
- `KOMAI_CONFIG` - path to config file (optional)
|
||||
- `LOGGING_LOG_PATH`, `LOGGING_LOG_FILE`, `LOGGING_LEVEL`
|
||||
|
||||
## Requirements
|
||||
- Python >3.10
|
||||
|
||||
## No Code Yet
|
||||
This repo is a scaffold. No `.py` source files exist yet. Do not assume any modules, classes, or APIs are implemented.
|
||||
Reference in New Issue
Block a user