Skip to content

Latest commit

 

History

History
16 lines (13 loc) · 1.69 KB

AGENTS.md

File metadata and controls

16 lines (13 loc) · 1.69 KB

feedbai — agent notes

Zero-dependency Node (>=22) CLI. Run npm test before committing.

  • src/cli.js — arg parsing; src/commands/<name>.js — one file per command, home.js is bare feedbai (onboarding or status + new feedback).
  • src/feedback.js — parallel fetch + --since last cursors; src/format.js — md/json/ndjson.
  • src/project.js, src/discover.js, src/edit.js — detect the project, find channel links in the repo, edit feedbai.config.json.
  • Output is agent-first: every message should say what to do next, with copy-pasteable commands.
  • src/config.js — global + nearest project config, merged by id; accounts resolved per source.
  • src/providers/<type>.js — one module per channel (Matrix, Bluesky, GitHub Discussions…); core code never names a platform. Adding one: docs/channels/adding-a-channel.md; test/providers.test.js checks the contract.
  • site/ — the website and docs (Astro + Starlight, its own dependencies; the CLI stays zero-dependency). Docs are the repo's Markdown, listed in site/docs.mjs.
  • All user-facing strings live in src/locales/<lang>.json and go through t().
  • Secrets are never stored in configs: accounts hold env var names; values live in ~/.config/feedbai/secrets.env (0600).
  • Trust boundaries (SECURITY.md): project configs and messages are untrusted. A project config never picks accounts; private rooms reach issues only via mayFile; user text in issues goes through inert, every item through clean. Keep new code inside these rules and add a test when touching them. Personal data: PRIVACY.md.

To use feedbai on a project, see skills/feedbai/SKILL.md.