34 lines
1.1 KiB
Markdown
34 lines
1.1 KiB
Markdown
# AGENTS.md
|
|
|
|
This repository is a portable Codex operations kit.
|
|
|
|
## Goal
|
|
|
|
Keep Codex fast, cheap, and reusable across machines by separating:
|
|
|
|
- small persistent instructions
|
|
- portable memory notes
|
|
- heavyweight transient session data
|
|
|
|
## Working Rules
|
|
|
|
- Treat this repo as the source of truth for reusable Codex setup.
|
|
- Keep `AGENTS.md` files short. Put durable user context in `memory/*.md`, not in giant prompt files.
|
|
- Prefer scripts in `scripts/` for install, audit, export, and maintenance tasks.
|
|
- Never copy secrets, auth tokens, or large SQLite/session databases into Git.
|
|
- Default to dry-run behavior for cleanup scripts unless the user explicitly asks to apply changes.
|
|
|
|
## Key Paths
|
|
|
|
- `README.md`: setup and rollout guide
|
|
- `docs/research.md`: research findings with source links
|
|
- `templates/`: portable Codex home templates
|
|
- `memory/`: durable cross-machine memory notes
|
|
- `scripts/`: audit, install, export, and maintenance tooling
|
|
|
|
## Validation
|
|
|
|
- Shell scripts should pass `bash -n`.
|
|
- Python scripts should pass `python3 -m py_compile`.
|
|
- Prefer idempotent scripts so re-running them is safe.
|