Development repository for a Python CLI (cec) and Cursor skill that
collect Cursor agent session artifacts into shareable bundles, then inspect
and redact them in an offline, localhost-only browser viewer (cec view).
| Audience | Read |
|---|---|
| End users (zip, marketplace, PyPI long description) | tool/README.md — install, verify, cec view, examples. scripts/package.py copies it to the root README.md inside release zips (with link rewrites). |
Contributors (this file + docs/development/) |
Clone this repo, use uv against tool/, run tests, refresh vendored assets, build distributables. |
PyPI / wheel metadata uses the same file (tool/pyproject.toml → readme = "README.md").
git clone <this-repo-url> cursor-evidence-collector
cd cursor-evidence-collector
uv sync --project tool --group dev
uv run --project tool pytest
uv run --project tool cec discover --jsonEnd-user install (uv, release zip + wheels/, skill bootstrap) is in
tool/README.md.
Stdlib-only scripts; run from the repository root with Python 3.11+.
Refresh vendored viewer assets (HTMX, Alpine CSP, Open Props, Mermaid,
KaTeX). Requires network; SHA-256 pins live in scripts/vendor-manifest.json.
Update tool/view/static/THIRD_PARTY_NOTICES.md when versions change.
python3 scripts/vendor_refresh.pyBuild a release zip (skill drop-in + offline wheelhouse):
stages dist/cursor-evidence-collector-<version>/ with SKILL.md, tool/,
wheels/*.whl (project + all runtime deps), DIST_INFO.json, then runs an
offline smoke test (uv venv + uv pip install --no-index --find-links wheels/ + cec --help).
Zips the tree; root README.md is copied from tool/README.md with path adjustments.
python3 scripts/package.py
python3 scripts/package.py --no-zip
python3 scripts/package.py --skip-smoke # not recommended| Path | Role |
|---|---|
tool/ |
cec CLI and viewer (what release zips ship, minus dev paths) |
specs/ |
Numbered feature specs, plans, and contracts (design history) |
docs/ |
Bundle layout, schema notes, contributor docs |
SKILL.md |
Cursor skill entrypoint |
.cursor/skills/ |
Project-local agent command definitions |
.specify/ |
Local Spec Kit templates and hooks |
Release zips built by scripts/package.py include only the skill + tool
artefacts; they omit specs/, .cursor/, and .specify/.
- Distributable user guide:
tool/README.md - Docs index (pointers):
docs/distributable/README.md - Skill behaviour:
SKILL.md - Bundle layout contract:
docs/bundle-layout.md - Contributor planning:
docs/development/plan.md