initial commit

AGENTS.md

@@ -0,0 +1,40 @@
+# AGENTS.md
+
+## Purpose
+
+This repository hosts a small self-hosted scratch service (pastebin-like) written in Go.
+
+Key product constraints:
+- All routes are unauthenticated by design.
+- One upload creates one scratch.
+- For multiple files, users must upload a single archive file.
+- Scratch data is stored gzip-compressed on disk transparently.
+
+## Project layout
+
+- `cmd/pastebin`: service entrypoint
+- `internal/config`: config loading and validation
+- `internal/http`: HTTP handlers and middleware
+- `internal/storage`: filesystem storage and metadata index
+- `internal/cleanup`: expiration cleanup worker
+- `web/templates`, `web/static`: UI assets
+
+## API routes
+
+- `POST /api/scratch`
+- `GET /api/scratch/{id}`
+- `GET /s/{id}`
+- `GET /raw/{id}`
+
+## Build and test
+
+Use `make help` as the source of truth for available build/test targets and descriptions.
+
+## Coding conventions
+
+- Keep changes minimal and focused.
+- Preserve unauthenticated behavior unless explicitly requested.
+- Keep limits/operator controls configurable via config.
+- Maintain write-route protections (allowlist and rate limiting).
+- Keep storage behavior transparent for clients (compression is internal).
+- Add or update tests for behavior changes.