Local files

Set one directory tree under connectors.file.path in serenity.yml. Keep that directory outside your brain repository to avoid ingesting generated memory as new source material.

connectors:
  file:
    path: /absolute/path/to/notes

Run serenity sync after edits. Files must be unchanged for two seconds. This is a polling workflow, not a continuous watcher.

Git repository documentation

The Git connector accepts multiple connectors.git_repo entries. It imports README files and documentation under docs/ at HEAD. It is not a whole-codebase code index.

Use the repository connector configuration reference for the exact entry schema and polling behavior.

Gmail via IMAP

Gmail with an app password is the certified mailbox setup. Enable Google account 2-Step Verification and create an app password, then authenticate:

serenity connectors auth imap --email you@gmail.com

The password is stored in your operating-system keychain; only the email address is written to the brain configuration. The terminal prompt may echo input, so use the documented password-manager pipe if you need to avoid visible input.

The connector polls one account’s INBOX per brain. OAuth, multiple simultaneous accounts, and other mailbox providers are not certified by this guide. Re-run authentication to replace a revoked app password.

Check the setup

serenity connectors status
serenity sync
serenity status

sync imports sources. extract separately turns sources into claims after models are configured.

References: connector documentation.

Ask about Serenity