Spooling
Resources
Back to spooling.ai

Contributing

How to contribute a provider parser, fix a bug, or improve these docs.

The OSS engine lives at sashimiboi/spooling. The marketing site (and these docs) live at parsed-analytics/spool-landing.

Bug reports

Use GitHub Issues. Include:

  • spool --version
  • Output of spooling init (provider table) so we know what's installed
  • The exact command and a minimal reproduction
  • A snippet of the relevant log if you can capture one

For security-sensitive issues, don't use Issues. See Security.

Adding a provider parser

Spool parses sessions from any AI coding tool whose data lives on disk. To add a new one:

  1. Drop a module under spooling/providers/<your_provider>.py that subclasses Provider.
  2. Implement default_data_path, is_available, discover_session_files, and parse_session_file.
  3. The parsed session must yield ParsedSession objects with role-tagged ParsedMessage lists. Look at spooling/providers/kiro.py for a JSON-file-based parser, spooling/providers/cursor.py for a SQLite-based one.
  4. Register it in spooling/providers/__init__.py so spooling init picks it up.
  5. Add a doc page under docs/providers/<your-provider>.mdx.

Open a PR with the parser plus the doc page. Include a sanitized sample session file in tests/fixtures/<your-provider>/ so the parser is testable.

Improving these docs

These docs live at docs/ in the spool-landing repo. Edit the MDX, open a PR. Mintlify auto-deploys from main so changes go live ~30 seconds after merge.

Style

  • No em-dashes anywhere, including code comments and commit messages.
  • "GUI" not "Web UI".
  • For commit messages, follow the surrounding pattern (feat(scope): summary, fix: …). No Claude or AI attribution.

On this page