aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 8 insertions, 1 deletions
diff --git a/README.md b/README.md
index c33a5f2..8067f83 100644
--- a/README.md
+++ b/README.md
@@ -23,10 +23,14 @@ An agent given raw `notmuch`/`mbsync` access can do anything, including mangle t
No installer, just copy files into place:
```bash
-cp mailctl.py ~/bin/ # executable
+cp mailctl.py mailrules.py ~/bin/ # executable, plus the module it imports
cp -r mail-organize ~/.claude/skills/ # Claude Code skill, in its own dir
```
+`mailrules.py` is copied beside `mailctl.py`, not instead of it: `mailctl rules`
+imports it, and Python resolves that import from the directory the script lives
+in. Copying only `mailctl.py` leaves every command failing at startup.
+
The skill invokes the tool at `~/bin/mailctl.py`; keep that path.
## Configuration
@@ -69,6 +73,9 @@ mailctl tag "<query>" --account NAME [--add TAG]... [--remove TAG]...
[--apply] [--confirm-destructive]
mailctl draft --account NAME --to ADDR --subject TEXT
[--cc ADDR] [--body TEXT | --body-file PATH]
+mailctl rules list [--enabled-only] # shared tagging rules, read-only
+mailctl rules show <id>
+mailctl rules dry-run [<id>] # what each rule matches now
```
Reads default to global scope (all accounts) when `--account` is omitted. `tag` refuses to run without either `--account NAME` or `--all-accounts`.