swarm repositories / source
aboutsummaryrefslogtreecommitdiff
path: root/AGENTS.md
diff options
context:
space:
mode:
Diffstat (limited to 'AGENTS.md')
-rw-r--r--AGENTS.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/AGENTS.md b/AGENTS.md
new file mode 100644
index 0000000..f02a0dc
--- /dev/null
+++ b/AGENTS.md
@@ -0,0 +1,10 @@
+# AGENTS.md
+
+## Scripting Policy
+
+- For easy, cheap, standalone Python scripts in this repo, use `uv` inline script metadata.
+- Use the `#!/usr/bin/env -S uv run --script` shebang.
+- Add a PEP 723 inline TOML block with `requires-python` and `dependencies`.
+- Keep dependency pins exact when a script has non-stdlib Python dependencies.
+- Use common sense. Do not force this onto heavy or specialized runtimes, bespoke project environments, or scripts that intentionally run inside a dedicated external environment.
+- In particular, avoid slapping `uv` metadata onto heavyweight OCR/runtime entrypoints just to satisfy the rule mechanically.