Update docs: add repo URL, refresh AGENTS.md and README, remove stale READMEs
This commit is contained in:
33
AGENTS.md
33
AGENTS.md
@@ -1,11 +1,17 @@
|
||||
# komAI Agent Guidelines
|
||||
|
||||
## Репозиторий
|
||||
|
||||
https://git.komisar.gin.by/komisar/komAI
|
||||
|
||||
## 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
|
||||
@@ -14,19 +20,34 @@ python -m app.komAI
|
||||
- `tests/` - standalone unit tests (executable from CLI)
|
||||
|
||||
## Config System
|
||||
- Modules register parameters at initialization
|
||||
- Save config: `from src import save_config; save_config()`
|
||||
|
||||
Modules register parameters at initialization via `config.register()`.
|
||||
|
||||
Access global config:
|
||||
```python
|
||||
import src.utils.config_manager
|
||||
config = src.utils.config_manager.config
|
||||
```
|
||||
|
||||
Save config: `config.save()`
|
||||
|
||||
## Logging
|
||||
- All console output is duplicated to log files
|
||||
- Log config in `config/global.yaml` (level, file, path)
|
||||
|
||||
All console output is duplicated to log files. Configure in `config/global.yaml`.
|
||||
|
||||
## 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.
|
||||
## Module Development
|
||||
|
||||
When creating new modules:
|
||||
- Register parameters with `config.register(name=..., val=..., cat="module_name", ...)`
|
||||
- Use categories to organize params
|
||||
- All param changes trigger validators if set
|
||||
- Use `getall()` / `getrawall()` for nested param groups
|
||||
Reference in New Issue
Block a user