diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..78f65d0 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,43 @@ +# AGENTS.md + +Lightweight web screenshot tool driving a local Chrome over CDP, with DOM analysis. Used by BBOT. + +## Toolchain + +| Concern | This repository | +|---|---| +| Language | Python, `python` in `[tool.poetry.dependencies]` of pyproject.toml | +| Package manager | poetry. Not yet on uv, see toolchain.md | +| Lint and format | ruff, version in the poetry dev group of pyproject.toml | +| Tests | pytest | + +## Setup + +```bash +poetry install +``` + +## Tests + +Tests drive a real Chrome or Chromium found on PATH (`possible_chrome_binaries` in `webcap/browser.py`). Without one they fail with `Chrome executable not found`. + +```bash +poetry run pytest +``` + +## Standards + +Org-wide, in [blacklanternsecurity/.github/standards](https://github.com/blacklanternsecurity/.github/tree/main/standards). Read the one your task touches, not all of them. + +| Document | Read it when | +|---|---| +| [principles.md](https://github.com/blacklanternsecurity/.github/blob/main/standards/principles.md) | Always | +| [toolchain.md](https://github.com/blacklanternsecurity/.github/blob/main/standards/toolchain.md) | Touching dependencies, linting, formatting, or language versions | +| [git.md](https://github.com/blacklanternsecurity/.github/blob/main/standards/git.md) | Branching, commit messages, opening or reviewing a pull request | +| [rfc.md](https://github.com/blacklanternsecurity/.github/blob/main/standards/rfc.md) | A change needs agreement before work starts, or an RFC is ending | +| [testing.md](https://github.com/blacklanternsecurity/.github/blob/main/standards/testing.md) | Writing or changing tests, or anything that has them | +| [ci.md](https://github.com/blacklanternsecurity/.github/blob/main/standards/ci.md) | Touching a workflow, an action pin, or a permissions block | +| [releases.md](https://github.com/blacklanternsecurity/.github/blob/main/standards/releases.md) | Versioning, tagging, or publishing | +| [repository-setup.md](https://github.com/blacklanternsecurity/.github/blob/main/standards/repository-setup.md) | Creating a repository, or auditing one | + +Never restate a standard here. If this file and a standard disagree, the standard wins and this file is the bug. diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..dc366f8 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1 @@ +See @AGENTS.md.