amelia AGENTS.md

A project instruction file for Amelia, a Python backend and dashboard project. It explains where source code and tests live, how to run the project, and the naming, typing, formatting, and testing conventions.

In plain words
What is it for?
Use it when adding features, fixing bugs, organizing modules, running checks, or writing unit, integration, end-to-end, and performance tests for Amelia.
Why use it?
It helps a coding agent find the right files and use the project's expected development commands. It also reduces inconsistent code and missed tests across backend and dashboard work.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/existential-birds/amelia/agents-md
Clone the repo
git clone --depth 1 https://github.com/existential-birds/amelia

Made for: Codex, OpenCode.

Per session 573 This file is loaded in full into every session.
When invoked 573 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00573 $0.00573
Opus 5 $0.00287 $0.00287
Sonnet 5 $0.00115 $0.00115
Haiku 4.5 $0.00057 $0.00057

Measured 2d ago against content hash 07dd31d0b468, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

amelia AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 35 lines

How it starts

The opening of the file, as written. The whole thing — 35 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Repository Guidelines

Project Structure & Module Organization

  • Source lives in amelia/ (agents, drivers, trackers, CLI entry in main.py; shared utils in core/).
  • Tests mirror modules in tests/ (unit/, integration/, e2e/, perf/).
  • Docs and design notes: docs/ and specs/; top-level configs: data-model.md, pyproject.toml. Runtime config in ~/.amelia/amelia.db.

Build, Test, and Development Commands

  • Install deps: uv sync (uses pyproject.toml/uv.lock).
  • Run CLI locally: uv run amelia --help or uv run amelia start PROJ-123 --profile dev.
  • Lint: uv run ruff check .; format (if needed): uv run ruff format ..
  • Type check: uv run mypy . (strict).
  • Tests: fast loop uv run pytest tests/unit; full suite uv run pytest; scope with -k "pattern".

Coding Style & Naming Conventions

  • Python 3.12; prefer full type hints and dataclasses/TypedDicts where appropriate.
  • Line length 100; avoid disabling E501 unless unavoidable.
  • Imports follow Ruff isort order: future, stdlib, third-party, first-party (amelia), local.
  • Naming: modules/functions snake_case; classes PascalCase; constants UPPER_SNAKE.

Testing Guidelines

  • Framework: pytest (asyncio_mode = auto); mark async tests with @pytest.mark.asyncio.
  • Name tests test_<behavior>_<condition> and place next to the code path (e.g., amelia/core/state.pytests/unit/core/test_state.py).
  • Add unit coverage for new logic; include integration/e2e when touching workflows or drivers.

Commit & Pull Request Guidelines

  • Commits: concise imperative subject (e.g., Add driver timeout handling).
  • Before PR: run uv run ruff check ., uv run mypy ., and relevant uv run pytest scope; note expected failures.
  • PRs: state problem, approach, tests executed; link issue/ticket and include screenshots if UX-facing (CLI output acceptable).

Security & Configuration Tips

  • Repository runs locally; keep secrets out of code and logs. Use env vars (e.g., OPENROUTER_API_KEY) for secrets.
  • Validate driver/tracker inputs at boundaries; avoid writing tokens to logs or files.
  • Treat data-model.md and config files as source of truth; update docs when interfaces change.

Read the full file on GitHub · 35 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 35 lines · 573 tokens per session scan A 07dd31d0b468

Subscribe to this mod's changes

amelia AGENTS.md is an instructions file published in the GitHub repository existential-birds/amelia (21 stars, last pushed 22d ago), licensed Apache-2.0. It adds 573 tokens to every session, about $0.0029 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.