Imported from bheliker/explor_codex (
AGENTS.md). Install upstream withnpx skills add bheliker/explor_codex. Copyright stays with the author.
AGENTS.md
This file is the local instruction scratchpad for future Codex work in this repository.
Environment
- Use
uvfor dependency management and command execution. - Install dependencies with
uv sync.
Commands
- Run the app:
uv run flask --app 'app:create_app()' run --debug - Run tests:
uv run pytest - Run lint:
uv run ruff check . - Check formatting:
uv run ruff format --check . - Format code:
uv run ruff format . - Run type checks:
uv run mypy app tests - Migration verification DBs live under
./.codex-tmp/migration-dbs/ - Migrate the DB:
sqlite+pysqlite:////Users/bheliker/Documents/_Projects/explor/explor_codex/.codex-tmp/migration-dbs/*.dbuv run flask --app 'app:create_app()' db upgradeDATABASE_URL=sqlite+pysqlite:////Users/bheliker/Documents/_Projects/explor/explor_codex/.codex-tmp/migration-dbs/<task>.db uv run flask --app 'app:create_app()' db upgrade
Code Layout
- Application code lives in
app/ - Tests live in
tests/ - Templates belong in
templates/ - Static assets belong in
static/
Expectations
- Assume you are not alone in the codebase and work on branches, not main.
- Keep changes minimal and targeted.
- Add or update tests for behavior changes.
- Run tests, lint, and mypy before finishing substantive changes.
- Read
WORKLOG.mdat the start of a new session before planning work. - Append a concise dated entry to
WORKLOG.mdafter each substantive session covering what was investigated, what changed, what was decided, and why. - work autonomously, on a new branch, commit as you go without approval, and only when a merge is needed to main ask me for approval.
- Run to completion before asking for help unless blocked by a hard failure.
- Make commits as useful checkpoints after each major phase.
- Use the configured disposable database for migrations.
- Run the full test suite after each major batch of changes.
- If a migration fails, diagnose and continue until the codebase and migrations are consistent.
- Leave a final summary with:
- commits made
- migrations applied
- failing tests, if any
- manual follow-ups
Commit Workflow
- After each code change, propose a git commit title and body.
git addcommands are always ok as part of a commit
- Wait for explicit user approval before running
git addorgit commit.- If Agents are running independently of the User, create and commit to a branch and only ask permission to merge into main when the feature or task is complete and working on the branch.
- Only create the commit or merge after the user approves the proposed message.
Project goals
Architecture notes
- Use metric system as backend truth for all real world measurements, convert to "imperial" only as needed in frontend display.
Working notes
- Prefer short, specific instructions over long general advice.
- Prefer repo-local migration verification databases over shared
/tmp. - Update this file as the project evolves.