Back to Zeroclaw

Filesystem

docs/book/src/channels/filesystem.md

0.8.31.9 KB
Original Source

Filesystem

The filesystem channel watches one or more paths and feeds each change into the agent loop or the SOP engine. It is gated by the channel-filesystem build feature (default on).

This is a SOP event source. For trigger syntax and path matching, see SOP Fan-In: Filesystem. This page covers what is watched and the safety scoping.

Configuration

The full field list, derived from the live schema. For a basic watcher you set paths.

{{#config-fields channels.filesystem}}

Full field reference: config reference.

Scoping what is watched

paths lists the roots to watch; recursive controls whether subdirectories are included. include and exclude globs narrow which paths emit events, and events narrows by change kind. debounce_ms and settle_ms collapse bursts of rapid changes into a single settled event.

Safety

The broad system roots /, /home, /etc, /var, /proc, /sys, /dev, and /tmp are rejected at config validation unless allow_broad_roots is set. Symlink event paths are rejected before any metadata, hash, or content read by default; follow_symlinks opts in but still requires the canonical target to resolve inside a watched root.

Troubleshooting

SymptomLikely causeFix
Listener does not starta broad root was rejected at validationNarrow paths away from the broad roots, or set allow_broad_roots
Change ignoredexcluded by glob, or outside events kindsCheck include, exclude, and events against the changed file
SOP not startingtrigger path glob does not matchVerify the trigger path matches and the file is in watch scope

See also