6119
My
mysis / files
mysis / AGENTS.md
1.1 KB
1# Project info for agents: 2 3Design is at `documentation/architecture/DESIGN.md`. This is the USER's vision and is **only to be editted when explicitly asked**. 4 5If the code/comment/other document is contradictory to the design document stop and warn the USER. 6 7Use YAGNI **always**. When coding, when writting documentation. 8 9Keep documentation concise and factual. No documentation file should be more than 500 lines, most should be at around ~200. 10 11## Quick reference: 12 13- The config, credentials, and database are in the app's data folder: `~/.config/mysis`. 14- The app config is in `./config.toml`. 15- `cmd/main.go` is the orchestrator and entrypoint. It can then run in interactive mode with TUI or non-interactive mode with cli. 16- Project has a strict rule of separation of concerns. Shared functionality and data access is shared no matter what display mode the app is using. Ex: `llm/loop.go` is one core functionaly shared by both displays. 17- Makefile commands: `lint`, `test`, `run`, `build`. Always prefer these to lint, test, run and build the app. 18- Linter: golangci-lint with strict config. Must pass with 0 issues.