Skip to content

Build AI methods with your coding agent, then run them anywhere: as an MCP for chatbots, as a webapp for people, or via API for your software.

docs: document keyword-only check/fix make targets in agent rules

Louis Choquel70aac1b59cde
diff --git a/AGENTS.md b/AGENTS.md
index 5e73763fa..0abde3faa 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -20,6 +20,17 @@
Always fix any issues reported by these tools before proceeding.
+### Keyword-only arguments check
+
+ Non-subject function parameters across `pipelex/` source must be keyword-only (a bare `*` after the subject). The convention is mechanically enforced and already runs as part of `make agent-check`, but you can invoke it on its own:
+
+ ```bash
+ make check-keyword-only # alias: make cko — read-only gate; hard-blocks on any violation
+ make fix-keyword-only # alias: make fko — auto-insert a bare * for mechanically-fixable violations
+ ```
+
+ `check-keyword-only` owns the pass/fail gate; `fix-keyword-only` rewrites what it can and reports the shapes it can't fix mechanically (resolve those by hand). See [`docs/contribute/keyword-only-arguments.md`](docs/contribute/keyword-only-arguments.md) for the full convention.
+
### Cleaning Derived Files
If you need to clean derived files and caches, typically after you erased files or moved tests, the linters can get confused, the pytest collection can be off...
diff --git a/CLAUDE.md b/CLAUDE.md
index bc13c4171..646101c02 100644
--- a/CLAUDE.md
+++ b/CLAUDE.md
@@ -20,6 +20,17 @@
Always fix any issues reported by these tools before proceeding.
+### Keyword-only arguments check
+
+ Non-subject function parameters across `pipelex/` source must be keyword-only (a bare `*` after the subject). The convention is mechanically enforced and already runs as part of `make agent-check`, but you can invoke it on its own:
+
+ ```bash
+ make check-keyword-only # alias: make cko — read-only gate; hard-blocks on any violation
+ make fix-keyword-only # alias: make fko — auto-insert a bare * for mechanically-fixable violations
+ ```
+
+ `check-keyword-only` owns the pass/fail gate; `fix-keyword-only` rewrites what it can and reports the shapes it can't fix mechanically (resolve those by hand). See [`docs/contribute/keyword-only-arguments.md`](docs/contribute/keyword-only-arguments.md) for the full convention.
+
### Cleaning Derived Files
If you need to clean derived files and caches, typically after you erased files or moved tests, the linters can get confused, the pytest collection can be off...
diff --git a/pipelex/kit/agent_rules/codex_commands.md b/pipelex/kit/agent_rules/codex_commands.md
index 378ccd7e9..9a54ae1fc 100644
--- a/pipelex/kit/agent_rules/codex_commands.md
+++ b/pipelex/kit/agent_rules/codex_commands.md
@@ -18,6 +18,17 @@
Always fix any issues reported by these tools before proceeding.
+## Keyword-only arguments check
+
+ Non-subject function parameters across `pipelex/` source must be keyword-only (a bare `*` after the subject). The convention is mechanically enforced and already runs as part of `make agent-check`, but you can invoke it on its own:
+
+ ```bash
+ make check-keyword-only # alias: make cko — read-only gate; hard-blocks on any violation
+ make fix-keyword-only # alias: make fko — auto-insert a bare * for mechanically-fixable violations
+ ```
+
+ `check-keyword-only` owns the pass/fail gate; `fix-keyword-only` rewrites what it can and reports the shapes it can't fix mechanically (resolve those by hand). See [`docs/contribute/keyword-only-arguments.md`](docs/contribute/keyword-only-arguments.md) for the full convention.
+
## Cleaning Derived Files
If you need to clean derived files and caches, typically after you erased files or moved tests, the linters can get confused, the pytest collection can be off...
diff --git a/pipelex/kit/agent_rules/commands.md b/pipelex/kit/agent_rules/commands.md
index 424017c2e..ae05e9bf9 100644
--- a/pipelex/kit/agent_rules/commands.md
+++ b/pipelex/kit/agent_rules/commands.md
@@ -18,6 +18,17 @@
Always fix any issues reported by these tools before proceeding.
+## Keyword-only arguments check
+
+ Non-subject function parameters across `pipelex/` source must be keyword-only (a bare `*` after the subject). The convention is mechanically enforced and already runs as part of `make agent-check`, but you can invoke it on its own:
+
+ ```bash
+ make check-keyword-only # alias: make cko — read-only gate; hard-blocks on any violation
+ make fix-keyword-only # alias: make fko — auto-insert a bare * for mechanically-fixable violations
+ ```
+
+ `check-keyword-only` owns the pass/fail gate; `fix-keyword-only` rewrites what it can and reports the shapes it can't fix mechanically (resolve those by hand). See [`docs/contribute/keyword-only-arguments.md`](docs/contribute/keyword-only-arguments.md) for the full convention.
+
## Cleaning Derived Files
If you need to clean derived files and caches, typically after you erased files or moved tests, the linters can get confused, the pytest collection can be off...