Vibecode Scribe
track this build5 phases, 15 steps, beginner friendly0%KINDA · weekend project
The core loop is buildable, but a dependable replacement becomes a real weekend or multi-day project. For Scribe, capture a browser workflow and produce editable step-by-step documentation. The hard boundary is automatic capture quality, redaction, team libraries, integrations, and sharing, plus capture polish, hosting, and collaboration.
the project pack5 files · written for this build, step by step
You are building a lean indie version of Scribe. Create the following project files first, then implement the application by following them. Keep the files updated as decisions change. Do not collapse this into a single README or prompt. ===== README.md ===== # Scribe · indie build Build an explicit screenshot-to-guide editor with a small browser capture helper. Estimated effort: **multi-day**. Work `BUILD_PLAN.md` top to bottom · every phase ends in a check that has to pass before the next one starts. ## Stack | Part | Choice | Why | | --- | --- | --- | | Runtime | Python 3.12+ and Flask | A small local HTTP application with readable server-side handlers and no JavaScript build pipeline. | | Storage | SQLite through Python sqlite3 | Local ownership with explicit transactions and a portable backup path. | | Interface | Jinja HTML templates, CSS and vanilla JavaScript | Implement the specified screens directly with labelled controls and progressive enhancement. | | Verification | Python unittest and browser acceptance fixtures | Check invariants and the actual user workflow before the next phase. | | Focused libraries | Pillow | Use these only for the specific file, parsing or provider operations named in the phases; freeze tested versions. | ## Before you start Have every one of these ready. The plan assumes them from step one. - [ ] **Python 3.12 or newer and a terminal** · Python is free; this local prototype requires no hosting subscription. - Why: The local backend, tests and storage use Python. - Get it: Install Python from python.org. Open a terminal in a new empty project folder. On Windows, use py -3 where this guide says python if python is not on PATH; on macOS/Linux use python3 if needed. Create .venv and activate it before installing packages. - Verify: python --version reports 3.12+ and python -c "import sqlite3" succeeds. - [ ] **A current desktop browser and text editor** · No paid service required for this local step. - Why: You need to view the local interface and edit generated project files. - Get it: Use an installed Chrome, Firefox or Edge browser. Open the empty project folder in your editor; open the terminal there, not in this catalog repository. - Verify: You can create a text file in the project folder and open browser developer tools. - [ ] **Scribe acceptance sample** · No paid service required for this local step. - Why: This fixture makes the first end-to-end check reproducible. - Get it: Create synthetic sample data before implementation: A three-step dummy browser form containing a fake secret that must be redacted before export. Save it under fixtures/ with the expected results in fixtures/README.md; use no real credentials or customer records. - Verify: The fixture files and expected outcomes exist and can be inspected without a vendor account. - [ ] **Confirm the bounded replacement** · No paid service required for this local step. - Why: The full commercial product is larger than this guide. - Get it: The deliverable is an explicit screenshot-to-guide editor with a small browser capture helper. Read every exclusion below. Indie mode runs locally; any public or shared use requires the product access and deployment gates first. - Verify: You can name the primary workflow and the vendor features this version deliberately leaves out. - [ ] **Chromium extension development mode** · No paid account required. - Why: The optional capture helper uses Chromium activeTab. - Get it: Open chrome://extensions, enable Developer mode and use Load unpacked on the generated extension/ folder. Use only dummy pages for the first captures. - Verify: The toolbar action captures the active dummy tab after a deliberate click. ## Quick start ```sh python -m venv .venv python -m pip install Flask Flask-WTF python-dotenv waitress tzdata Pillow python -m pip freeze > requirements.txt python -m flask --app app run --host 127.0.0.1 ``` Then copy `.env.example` to `.env` and fill in the values it documents. ## Honest limits This build deliberately does not replace: - Interactive replay, video generation and cross-application recording are outside this guide builder. - This is an explicit screenshot-to-guide editor with a small browser capture helper; full Scribe feature parity, vendor hosting and support are not included. - automatic capture quality, redaction, team libraries, integrations, and sharing - instant hosted sharing - viewer analytics - team libraries - cross-device capture If one of those is essential to you, that is the reason to keep paying for Scribe, and the README should say so rather than pretend. ===== BRIEF.md ===== # Build brief · Scribe The one-shot brief this plan expands. `BUILD_PLAN.md` (or `MILESTONES.md`) is the same sequence broken into steps and checks; where the two disagree, the plan wins. Build me an explicit screenshot-to-guide editor with a small browser capture helper as a bounded replacement for Scribe. Build it in phases in the order below. Do not write the whole product in one pass. Finish the current phase, run its Done when checks, fix failures, then continue. Indie mode completes Phases 1-5. Phase 6 is required before shared or public deployment. ### Stack (fixed, do not substitute) - Runtime: Python 3.12+ and Flask. A small local HTTP application with readable server-side handlers and no JavaScript build pipeline. - Storage: SQLite through Python sqlite3. Local ownership with explicit transactions and a portable backup path. - Interface: Jinja HTML templates, CSS and vanilla JavaScript. Implement the specified screens directly with labelled controls and progressive enhancement. - Verification: Python unittest and browser acceptance fixtures. Check invariants and the actual user workflow before the next phase. - Focused libraries: Pillow. Use these only for the specific file, parsing or provider operations named in the phases; freeze tested versions. ### Data model (create this before Phase 1) - guides(id,title) - steps(id,guide_id,position,title,instruction,image_path) - redactions(id,step_id,x,y,w,h) - captures(id,guide_id,url,at,approved) - Use stable ids and explicit relationships; add auxiliary tables named by the phases before those phases use them. - Acceptance fixture: A three-step dummy browser form containing a fake secret that must be redacted before export. ### Prerequisites and configuration - Python 3.12 or newer and a terminal: Install Python from python.org. Open a terminal in a new empty project folder. On Windows, use py -3 where this guide says python if python is not on PATH; on macOS/Linux use python3 if needed. Create .venv and activate it before installing packages. Verify: python --version reports 3.12+ and python -c "import sqlite3" succeeds. Cost: Python is free; this local prototype requires no hosting subscription. - A current desktop browser and text editor: Use an installed Chrome, Firefox or Edge browser. Open the empty project folder in your editor; open the terminal there, not in this catalog repository. Verify: You can create a text file in the project folder and open browser developer tools. Cost: No paid service required for this local step. - Scribe acceptance sample: Create synthetic sample data before implementation: A three-step dummy browser form containing a fake secret that must be redacted before export. Save it under fixtures/ with the expected results in fixtures/README.md; use no real credentials or customer records. Verify: The fixture files and expected outcomes exist and can be inspected without a vendor account. Cost: No paid service required for this local step. - Confirm the bounded replacement: The deliverable is an explicit screenshot-to-guide editor with a small browser capture helper. Read every exclusion below. Indie mode runs locally; any public or shared use requires the product access and deployment gates first. Verify: You can name the primary workflow and the vendor features this version deliberately leaves out. Cost: No paid service required for this local step. - Chromium extension development mode: Open chrome://extensions, enable Developer mode and use Load unpacked on the generated extension/ folder. Use only dummy pages for the first captures. Verify: The toolbar action captures the active dummy tab after a deliberate click. Cost: No paid account required. - Configuration: DATA_DIR, SECRET_KEY, APP_MODE, SITE_URL. Ship .env.example, replace placeholders and exclude secrets from git. ### Phase 1 · Local foundation and data contract Build: Create the runnable local foundation for an explicit screenshot-to-guide editor with a small browser capture helper, including the real schema and acceptance fixture. - Run the venv command first, then stop and activate it before running the remaining commands. Use your OS instructions: Windows .venv\Scripts\activate.bat in cmd, or .venv\Scripts\Activate.ps1 in PowerShell; macOS/Linux source .venv/bin/activate. Then install the listed packages. Create app.py exposing app, load .env with python-dotenv, and add a /healthz route. Freeze tested dependency versions to requirements.txt. Create .env manually from .env.example; replace SECRET_KEY before launch. Commands, after creating the named files: `python -m venv .venv`; `python -m pip install Flask Flask-WTF python-dotenv waitress tzdata Pillow`; `python -m pip freeze > requirements.txt`; `python -m flask --app app run --host 127.0.0.1`. - For database-backed state create schema.sql and db.py using this model: guides(id,title); steps(id,guide_id,position,title,instruction,image_path); redactions(id,step_id,x,y,w,h); captures(id,guide_id,url,at,approved). Add the auxiliary relationships explicitly used in later phases; use stable ids, foreign keys, parameterized values and transactions. For canonical files use atomic replacement and hashes instead. Implement python manage.py init and python manage.py seed to create only synthetic data: A three-step dummy browser form containing a fake secret that must be redacted before export. Re-running init must not erase data. Commands, after creating the named files: `python manage.py init`; `python manage.py seed`. - Install Flask-WTF CSRF protection for forms and same-origin fetches, validate Host and Origin against SITE_URL, bound inputs and escape output. Deliberately public intake endpoints get bounded validation and rate limits; signed provider webhooks use signature checks instead of browser CSRF tokens. All other admin routes stay local until product authentication exists. When a later phase tests viewer/member permissions, implement the users, hashed passwords, expiring server sessions and role checks in this foundation first; product mode must never use a fabricated identity from request input. Add error, empty, keyboard-focus and retry states now. - Trap: The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. Done when: The documented start command serves /healthz and the initial screen at http://127.0.0.1:5000. Restarting preserves the seeded records or canonical files; running init again deletes nothing. A cross-origin state-changing request to an admin route is refused. Do not build yet: Do not start user-triggered capture until these checks pass. ### Phase 2 · User-triggered capture Build: User-triggered capture for Scribe: Build a Chromium extension with activeTab and a toolbar action that captures only after a user click. - Build a Chromium extension with activeTab and a toolbar action that captures only after a user click. - Download a capture bundle for manual import into the local editor; include URL only after stripping query and fragment. - Use A three-step dummy browser form containing a fake secret that must be redacted before export. Check: Opening a page without clicking Capture creates no screenshot. Then check: The extension requests no all-sites or background browsing permission. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: Do not record form values, keystrokes or passwords to generate instructions. Done when: Opening a page without clicking Capture creates no screenshot. The extension requests no all-sites or background browsing permission. Do not build yet: Do not start editable steps and redaction until these checks pass. ### Phase 3 · Editable steps and redaction Build: Editable steps and redaction for Scribe: Import captures as ordered steps with user-written instructions and keyboard reorder controls. - Import captures as ordered steps with user-written instructions and keyboard reorder controls. - Provide rectangle redaction baked into a new image; remove original secret-bearing pixels from the export asset. - Use A three-step dummy browser form containing a fake secret that must be redacted before export. Check: Reordering changes step numbers while keeping images paired with their instructions. Then check: The exported image cannot reveal the fake secret by deleting an overlay. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: A CSS blur or annotation layer is not permanent redaction. Done when: Reordering changes step numbers while keeping images paired with their instructions. The exported image cannot reveal the fake secret by deleting an overlay. Do not build yet: Do not start portable guide delivery until these checks pass. ### Phase 4 · Portable guide delivery Build: Portable guide delivery for Scribe: Generate self-contained HTML with local images and print styles; export a Markdown plus assets bundle. - Generate self-contained HTML with local images and print styles; export a Markdown plus assets bundle. - Add a final review screen showing all screenshots, URLs and text before the user exports. - Use A three-step dummy browser form containing a fake secret that must be redacted before export. Check: The exported HTML opens offline with all three steps and images. Then check: No original unredacted capture is included in the share bundle. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: Interactive replay, video generation and cross-application recording are outside this guide builder. Done when: The exported HTML opens offline with all three steps and images. No original unredacted capture is included in the share bundle. Do not build yet: Do not start portable delivery and clean-start proof until these checks pass. ### Phase 5 · Portable delivery and clean-start proof Build: Finish the Scribe replacement with a documented first-run path and a recoverable export. - Document prerequisites, every configuration variable, data locations and the three domain workflows: User-triggered capture; Editable steps and redaction; Portable guide delivery. Include the exclusions, actual costs and source check date 2026-09-05. Commands shown earlier that reference project files are files the builder must implement before running them. - Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for scribe. Restore into a separate empty directory or isolated deployment, with all outbound actions and schedules disabled. Recreate this proof: A three-step dummy browser form containing a fake secret that must be redacted before export. Compare ids/counts and open the result before recording the restore date. Never test a restore over the only live copy. - Use a new folder and only README instructions to reach the fixture outcome. Install from requirements.txt, initialize storage, run the tests and exercise the UI at 375px and 1280px; use keyboard-only controls and inspect browser errors. Record exactly what passed; do not mark unrun checks complete. Commands, after creating the named files: `python -m pip install -r requirements.txt`; `python -m unittest discover -s test`. - Trap: Export without an import or restore rehearsal is not verified portability. Done when: A new folder reaches the documented fixture outcome using only README instructions. A backup restored in isolation preserves the proof data and can be opened. Do not build yet: Do not start operate and share with access controls until these checks pass. ### Phase 6 · Operate and share with access controls (product-builder only) Build: Product-builder only: make an explicit screenshot-to-guide editor with a small browser capture helper operable for its stated audience before allowing remote access. - Add owner/member/viewer authorization as appropriate, password hashes through Werkzeug, expiring server-side sessions, CSRF and login rate limits. Add users, sessions and audit schema migrations plus an owner-init command prompting securely for its password. Enforce ownership on every private read/write/download and fail closed when product setup is incomplete. Existing learner or admin identities must use this same boundary. - Serve app:app with Waitress on loopback behind Caddy HTTPS. Configure trusted proxy headers narrowly, Secure/HttpOnly/SameSite cookies, upload limits, request ids and structured logs without private content. Run background jobs as a separate supervised process when the domain workflow requires them. Commands, after creating the named files: `waitress-serve --listen=127.0.0.1:5000 app:app`. - Add a scheduled encrypted off-host backup using this procedure: Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for scribe. Monitor health, disk space, failed jobs and backup age. Stop the service to test an alert; rehearse recovery with outbound effects disabled and record recovery time. Rotate any exposed credentials and require reconciliation before resuming queues. - Trap: Product mode is additional engineering, not a switch that makes a local prototype production-ready. Done when: An unauthenticated visitor cannot read private records, download private files or mutate the admin surface. A viewer cannot mutate data by making a direct request, and guessed ids cannot cross ownership boundaries. Stopping the service triggers the configured alert and the latest off-host backup restores the fixture in isolation. Do not build yet: Do not add new providers or vendor-scale features until the release gates are recorded. ### Out of scope (and why) - Interactive replay, video generation and cross-application recording are outside this guide builder. - This is an explicit screenshot-to-guide editor with a small browser capture helper; full Scribe feature parity, vendor hosting and support are not included. - automatic capture quality, redaction, team libraries, integrations, and sharing: retain the paid product if this capability is essential; it is outside this bounded build. - instant hosted sharing: retain the paid product if this capability is essential; it is outside this bounded build. - viewer analytics: retain the paid product if this capability is essential; it is outside this bounded build. - team libraries: retain the paid product if this capability is essential; it is outside this bounded build. - cross-device capture: retain the paid product if this capability is essential; it is outside this bounded build. ### README must contain - Exact install, configure, initialize, start, test and recovery commands for a clean folder. - The schema, fixture, acceptance results, private data locations and export format. - Every prerequisite and secret source, actual running costs and deliberately excluded capabilities. - An honest distinction between tests actually run and checks still awaiting real credentials or deployment. - Dependency documentation reviewed 2026-09-05: https://flask.palletsprojects.com/en/stable/installation/ ; https://docs.python.org/3/library/sqlite3.html ; https://flask-wtf.readthedocs.io/en/1.2.x/csrf/ ; https://docs.pylonsproject.org/projects/waitress/en/stable/usage.html ; https://developer.chrome.com/docs/extensions/develop/concepts/activeTab. Recheck before upgrading; freeze the versions actually tested. ===== AGENTS.md ===== # Agent instructions · Scribe indie build - Read `README.md` and `BUILD_PLAN.md` before writing code. The stack is fixed: Python 3.12+ and Flask, SQLite through Python sqlite3, Jinja HTML templates, CSS and vanilla JavaScript, Python unittest and browser acceptance fixtures, Pillow. Do not substitute. - Work one phase at a time, in order. Do not start a phase until every "Done when" item of the previous one passes. - Prefer the fewest moving parts that satisfy the step. No frameworks, services or dependencies the plan does not name. - Secrets live in `.env`, never in source or logs. Keep `.env.example` current when a variable is introduced. - Do not invent cryptography, security guarantees, APIs or compliance claims. - Add a focused test for every destructive, security-sensitive or data-loss path the plan names. - Run the project checks before declaring a phase complete, and record any deliberate shortcut in the README under "Tradeoffs". ## Known traps - The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. - Do not record form values, keystrokes or passwords to generate instructions. - A CSS blur or annotation layer is not permanent redaction. - Interactive replay, video generation and cross-application recording are outside this guide builder. - Export without an import or restore rehearsal is not verified portability. ===== BUILD_PLAN.md ===== # Build plan · Scribe Build an explicit screenshot-to-guide editor with a small browser capture helper. Phases are in dependency order. Each ends in a "Done when" list; treat an unticked item as a blocker, not a note. ## Phase 1 · Local foundation and data contract Create the runnable local foundation for an explicit screenshot-to-guide editor with a small browser capture helper, including the real schema and acceptance fixture. ### Steps 1. Create and start the local application Run the venv command first, then stop and activate it before running the remaining commands. Use your OS instructions: Windows .venv\Scripts\activate.bat in cmd, or .venv\Scripts\Activate.ps1 in PowerShell; macOS/Linux source .venv/bin/activate. Then install the listed packages. Create app.py exposing app, load .env with python-dotenv, and add a /healthz route. Freeze tested dependency versions to requirements.txt. Create .env manually from .env.example; replace SECRET_KEY before launch. Files: `app.py`, `requirements.txt`, `.env.example`, `.gitignore` ```sh python -m venv .venv python -m pip install Flask Flask-WTF python-dotenv waitress tzdata Pillow python -m pip freeze > requirements.txt python -m flask --app app run --host 127.0.0.1 ``` 2. Implement storage and seed the named fixture For database-backed state create schema.sql and db.py using this model: guides(id,title); steps(id,guide_id,position,title,instruction,image_path); redactions(id,step_id,x,y,w,h); captures(id,guide_id,url,at,approved). Add the auxiliary relationships explicitly used in later phases; use stable ids, foreign keys, parameterized values and transactions. For canonical files use atomic replacement and hashes instead. Implement python manage.py init and python manage.py seed to create only synthetic data: A three-step dummy browser form containing a fake secret that must be redacted before export. Re-running init must not erase data. Files: `schema.sql`, `db.py`, `manage.py`, `fixtures/README.md` ```sh python manage.py init python manage.py seed ``` 3. Protect the local request boundary Install Flask-WTF CSRF protection for forms and same-origin fetches, validate Host and Origin against SITE_URL, bound inputs and escape output. Deliberately public intake endpoints get bounded validation and rate limits; signed provider webhooks use signature checks instead of browser CSRF tokens. All other admin routes stay local until product authentication exists. When a later phase tests viewer/member permissions, implement the users, hashed passwords, expiring server sessions and role checks in this foundation first; product mode must never use a fabricated identity from request input. Add error, empty, keyboard-focus and retry states now. Files: `app.py`, `templates/base.html`, `test/test_foundation.py` ### Done when - [ ] The documented start command serves /healthz and the initial screen at http://127.0.0.1:5000. - [ ] Restarting preserves the seeded records or canonical files; running init again deletes nothing. - [ ] A cross-origin state-changing request to an admin route is refused. ### Watch out - The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. ## Phase 2 · User-triggered capture User-triggered capture for Scribe: Build a Chromium extension with activeTab and a toolbar action that captures only after a user click. ### Steps 1. Build a Chromium extension with activeTab and a toolbar action that captures only after a user click. Build a Chromium extension with activeTab and a toolbar action that captures only after a user click. Files: `features/user_triggered_capture.py`, `templates/user_triggered_capture.html` 2. Download a capture bundle for manual import into the local editor; include URL only after stripping query and fragment. Download a capture bundle for manual import into the local editor; include URL only after stripping query and fragment. Files: `features/user_triggered_capture.py` 3. Exercise the acceptance fixture Use A three-step dummy browser form containing a fake secret that must be redacted before export. Check: Opening a page without clicking Capture creates no screenshot. Then check: The extension requests no all-sites or background browsing permission. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_user_triggered_capture.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] Opening a page without clicking Capture creates no screenshot. - [ ] The extension requests no all-sites or background browsing permission. ### Watch out - Do not record form values, keystrokes or passwords to generate instructions. ## Phase 3 · Editable steps and redaction Editable steps and redaction for Scribe: Import captures as ordered steps with user-written instructions and keyboard reorder controls. ### Steps 1. Import captures as ordered steps with user-written instructions and keyboard reorder controls. Import captures as ordered steps with user-written instructions and keyboard reorder controls. Files: `features/editable_steps_and_redaction.py`, `templates/editable_steps_and_redaction.html` 2. Provide rectangle redaction baked into a new image; remove original secret-bearing pixels from the export asset. Provide rectangle redaction baked into a new image; remove original secret-bearing pixels from the export asset. Files: `features/editable_steps_and_redaction.py` 3. Exercise the acceptance fixture Use A three-step dummy browser form containing a fake secret that must be redacted before export. Check: Reordering changes step numbers while keeping images paired with their instructions. Then check: The exported image cannot reveal the fake secret by deleting an overlay. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_editable_steps_and_redaction.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] Reordering changes step numbers while keeping images paired with their instructions. - [ ] The exported image cannot reveal the fake secret by deleting an overlay. ### Watch out - A CSS blur or annotation layer is not permanent redaction. ## Phase 4 · Portable guide delivery Portable guide delivery for Scribe: Generate self-contained HTML with local images and print styles; export a Markdown plus assets bundle. ### Steps 1. Generate self-contained HTML with local images and print styles; export a Markdown plus assets bundle. Generate self-contained HTML with local images and print styles; export a Markdown plus assets bundle. Files: `features/portable_guide_delivery.py`, `templates/portable_guide_delivery.html` 2. Add a final review screen showing all screenshots, URLs and text before the user exports. Add a final review screen showing all screenshots, URLs and text before the user exports. Files: `features/portable_guide_delivery.py` 3. Exercise the acceptance fixture Use A three-step dummy browser form containing a fake secret that must be redacted before export. Check: The exported HTML opens offline with all three steps and images. Then check: No original unredacted capture is included in the share bundle. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_portable_guide_delivery.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] The exported HTML opens offline with all three steps and images. - [ ] No original unredacted capture is included in the share bundle. ### Watch out - Interactive replay, video generation and cross-application recording are outside this guide builder. ## Phase 5 · Portable delivery and clean-start proof Finish the Scribe replacement with a documented first-run path and a recoverable export. ### Steps 1. Write the user-facing runbook Document prerequisites, every configuration variable, data locations and the three domain workflows: User-triggered capture; Editable steps and redaction; Portable guide delivery. Include the exclusions, actual costs and source check date 2026-09-05. Commands shown earlier that reference project files are files the builder must implement before running them. Files: `README.md`, `.env.example` 2. Create and rehearse a recoverable backup Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for scribe. Restore into a separate empty directory or isolated deployment, with all outbound actions and schedules disabled. Recreate this proof: A three-step dummy browser form containing a fake secret that must be redacted before export. Compare ids/counts and open the result before recording the restore date. Never test a restore over the only live copy. Files: `OPERATIONS.md`, `scripts/backup.py` 3. Reproduce the first-run experience Use a new folder and only README instructions to reach the fixture outcome. Install from requirements.txt, initialize storage, run the tests and exercise the UI at 375px and 1280px; use keyboard-only controls and inspect browser errors. Record exactly what passed; do not mark unrun checks complete. Files: `README.md`, `verification.md` ```sh python -m pip install -r requirements.txt python -m unittest discover -s test ``` ### Done when - [ ] A new folder reaches the documented fixture outcome using only README instructions. - [ ] A backup restored in isolation preserves the proof data and can be opened. ### Watch out - Export without an import or restore rehearsal is not verified portability. ## Not in this build - Interactive replay, video generation and cross-application recording are outside this guide builder. - This is an explicit screenshot-to-guide editor with a small browser capture helper; full Scribe feature parity, vendor hosting and support are not included. - automatic capture quality, redaction, team libraries, integrations, and sharing - instant hosted sharing - viewer analytics - team libraries - cross-device capture ## After v1, if you want it - Extend portable guide delivery only after the fixture and recovery checks pass. - Before adding another integration, document its credentials, limits, cost and failure behavior with primary-source links. ===== .env.example ===== # Copy to .env and fill in. Never commit .env; this file documents it. # Required. A new private folder this application creates on first run; never serve it as static files. DATA_DIR=./data/scribe # Required · secret. Generate with python -c "import secrets; print(secrets.token_hex(32))" and save only in .env. SECRET_KEY=replace-with-a-random-secret # Required. Use indie for loopback-only personal work. Product mode must refuse to start until owner login and the deployment gates are configured. APP_MODE=indie # Required. The origin used for local forms and links; replace with the chosen HTTPS origin in product mode. SITE_URL=http://127.0.0.1:5000
You are building a lean indie version of Scribe. Create the following project files first, then implement the application by following them. Keep the files updated as decisions change. Do not collapse this into a single README or prompt. ===== README.md ===== # Scribe · indie build Build an explicit screenshot-to-guide editor with a small browser capture helper. Estimated effort: **multi-day**. Work `BUILD_PLAN.md` top to bottom · every phase ends in a check that has to pass before the next one starts. ## Stack | Part | Choice | Why | | --- | --- | --- | | Runtime | Python 3.12+ and Flask | A small local HTTP application with readable server-side handlers and no JavaScript build pipeline. | | Storage | SQLite through Python sqlite3 | Local ownership with explicit transactions and a portable backup path. | | Interface | Jinja HTML templates, CSS and vanilla JavaScript | Implement the specified screens directly with labelled controls and progressive enhancement. | | Verification | Python unittest and browser acceptance fixtures | Check invariants and the actual user workflow before the next phase. | | Focused libraries | Pillow | Use these only for the specific file, parsing or provider operations named in the phases; freeze tested versions. | ## Before you start Have every one of these ready. The plan assumes them from step one. - [ ] **Python 3.12 or newer and a terminal** · Python is free; this local prototype requires no hosting subscription. - Why: The local backend, tests and storage use Python. - Get it: Install Python from python.org. Open a terminal in a new empty project folder. On Windows, use py -3 where this guide says python if python is not on PATH; on macOS/Linux use python3 if needed. Create .venv and activate it before installing packages. - Verify: python --version reports 3.12+ and python -c "import sqlite3" succeeds. - [ ] **A current desktop browser and text editor** · No paid service required for this local step. - Why: You need to view the local interface and edit generated project files. - Get it: Use an installed Chrome, Firefox or Edge browser. Open the empty project folder in your editor; open the terminal there, not in this catalog repository. - Verify: You can create a text file in the project folder and open browser developer tools. - [ ] **Scribe acceptance sample** · No paid service required for this local step. - Why: This fixture makes the first end-to-end check reproducible. - Get it: Create synthetic sample data before implementation: A three-step dummy browser form containing a fake secret that must be redacted before export. Save it under fixtures/ with the expected results in fixtures/README.md; use no real credentials or customer records. - Verify: The fixture files and expected outcomes exist and can be inspected without a vendor account. - [ ] **Confirm the bounded replacement** · No paid service required for this local step. - Why: The full commercial product is larger than this guide. - Get it: The deliverable is an explicit screenshot-to-guide editor with a small browser capture helper. Read every exclusion below. Indie mode runs locally; any public or shared use requires the product access and deployment gates first. - Verify: You can name the primary workflow and the vendor features this version deliberately leaves out. - [ ] **Chromium extension development mode** · No paid account required. - Why: The optional capture helper uses Chromium activeTab. - Get it: Open chrome://extensions, enable Developer mode and use Load unpacked on the generated extension/ folder. Use only dummy pages for the first captures. - Verify: The toolbar action captures the active dummy tab after a deliberate click. ## Quick start ```sh python -m venv .venv python -m pip install Flask Flask-WTF python-dotenv waitress tzdata Pillow python -m pip freeze > requirements.txt python -m flask --app app run --host 127.0.0.1 ``` Then copy `.env.example` to `.env` and fill in the values it documents. ## Honest limits This build deliberately does not replace: - Interactive replay, video generation and cross-application recording are outside this guide builder. - This is an explicit screenshot-to-guide editor with a small browser capture helper; full Scribe feature parity, vendor hosting and support are not included. - automatic capture quality, redaction, team libraries, integrations, and sharing - instant hosted sharing - viewer analytics - team libraries - cross-device capture If one of those is essential to you, that is the reason to keep paying for Scribe, and the README should say so rather than pretend. ===== BRIEF.md ===== # Build brief · Scribe The one-shot brief this plan expands. `BUILD_PLAN.md` (or `MILESTONES.md`) is the same sequence broken into steps and checks; where the two disagree, the plan wins. Build me an explicit screenshot-to-guide editor with a small browser capture helper as a bounded replacement for Scribe. Build it in phases in the order below. Do not write the whole product in one pass. Finish the current phase, run its Done when checks, fix failures, then continue. Indie mode completes Phases 1-5. Phase 6 is required before shared or public deployment. ### Stack (fixed, do not substitute) - Runtime: Python 3.12+ and Flask. A small local HTTP application with readable server-side handlers and no JavaScript build pipeline. - Storage: SQLite through Python sqlite3. Local ownership with explicit transactions and a portable backup path. - Interface: Jinja HTML templates, CSS and vanilla JavaScript. Implement the specified screens directly with labelled controls and progressive enhancement. - Verification: Python unittest and browser acceptance fixtures. Check invariants and the actual user workflow before the next phase. - Focused libraries: Pillow. Use these only for the specific file, parsing or provider operations named in the phases; freeze tested versions. ### Data model (create this before Phase 1) - guides(id,title) - steps(id,guide_id,position,title,instruction,image_path) - redactions(id,step_id,x,y,w,h) - captures(id,guide_id,url,at,approved) - Use stable ids and explicit relationships; add auxiliary tables named by the phases before those phases use them. - Acceptance fixture: A three-step dummy browser form containing a fake secret that must be redacted before export. ### Prerequisites and configuration - Python 3.12 or newer and a terminal: Install Python from python.org. Open a terminal in a new empty project folder. On Windows, use py -3 where this guide says python if python is not on PATH; on macOS/Linux use python3 if needed. Create .venv and activate it before installing packages. Verify: python --version reports 3.12+ and python -c "import sqlite3" succeeds. Cost: Python is free; this local prototype requires no hosting subscription. - A current desktop browser and text editor: Use an installed Chrome, Firefox or Edge browser. Open the empty project folder in your editor; open the terminal there, not in this catalog repository. Verify: You can create a text file in the project folder and open browser developer tools. Cost: No paid service required for this local step. - Scribe acceptance sample: Create synthetic sample data before implementation: A three-step dummy browser form containing a fake secret that must be redacted before export. Save it under fixtures/ with the expected results in fixtures/README.md; use no real credentials or customer records. Verify: The fixture files and expected outcomes exist and can be inspected without a vendor account. Cost: No paid service required for this local step. - Confirm the bounded replacement: The deliverable is an explicit screenshot-to-guide editor with a small browser capture helper. Read every exclusion below. Indie mode runs locally; any public or shared use requires the product access and deployment gates first. Verify: You can name the primary workflow and the vendor features this version deliberately leaves out. Cost: No paid service required for this local step. - Chromium extension development mode: Open chrome://extensions, enable Developer mode and use Load unpacked on the generated extension/ folder. Use only dummy pages for the first captures. Verify: The toolbar action captures the active dummy tab after a deliberate click. Cost: No paid account required. - Configuration: DATA_DIR, SECRET_KEY, APP_MODE, SITE_URL. Ship .env.example, replace placeholders and exclude secrets from git. ### Phase 1 · Local foundation and data contract Build: Create the runnable local foundation for an explicit screenshot-to-guide editor with a small browser capture helper, including the real schema and acceptance fixture. - Run the venv command first, then stop and activate it before running the remaining commands. Use your OS instructions: Windows .venv\Scripts\activate.bat in cmd, or .venv\Scripts\Activate.ps1 in PowerShell; macOS/Linux source .venv/bin/activate. Then install the listed packages. Create app.py exposing app, load .env with python-dotenv, and add a /healthz route. Freeze tested dependency versions to requirements.txt. Create .env manually from .env.example; replace SECRET_KEY before launch. Commands, after creating the named files: `python -m venv .venv`; `python -m pip install Flask Flask-WTF python-dotenv waitress tzdata Pillow`; `python -m pip freeze > requirements.txt`; `python -m flask --app app run --host 127.0.0.1`. - For database-backed state create schema.sql and db.py using this model: guides(id,title); steps(id,guide_id,position,title,instruction,image_path); redactions(id,step_id,x,y,w,h); captures(id,guide_id,url,at,approved). Add the auxiliary relationships explicitly used in later phases; use stable ids, foreign keys, parameterized values and transactions. For canonical files use atomic replacement and hashes instead. Implement python manage.py init and python manage.py seed to create only synthetic data: A three-step dummy browser form containing a fake secret that must be redacted before export. Re-running init must not erase data. Commands, after creating the named files: `python manage.py init`; `python manage.py seed`. - Install Flask-WTF CSRF protection for forms and same-origin fetches, validate Host and Origin against SITE_URL, bound inputs and escape output. Deliberately public intake endpoints get bounded validation and rate limits; signed provider webhooks use signature checks instead of browser CSRF tokens. All other admin routes stay local until product authentication exists. When a later phase tests viewer/member permissions, implement the users, hashed passwords, expiring server sessions and role checks in this foundation first; product mode must never use a fabricated identity from request input. Add error, empty, keyboard-focus and retry states now. - Trap: The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. Done when: The documented start command serves /healthz and the initial screen at http://127.0.0.1:5000. Restarting preserves the seeded records or canonical files; running init again deletes nothing. A cross-origin state-changing request to an admin route is refused. Do not build yet: Do not start user-triggered capture until these checks pass. ### Phase 2 · User-triggered capture Build: User-triggered capture for Scribe: Build a Chromium extension with activeTab and a toolbar action that captures only after a user click. - Build a Chromium extension with activeTab and a toolbar action that captures only after a user click. - Download a capture bundle for manual import into the local editor; include URL only after stripping query and fragment. - Use A three-step dummy browser form containing a fake secret that must be redacted before export. Check: Opening a page without clicking Capture creates no screenshot. Then check: The extension requests no all-sites or background browsing permission. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: Do not record form values, keystrokes or passwords to generate instructions. Done when: Opening a page without clicking Capture creates no screenshot. The extension requests no all-sites or background browsing permission. Do not build yet: Do not start editable steps and redaction until these checks pass. ### Phase 3 · Editable steps and redaction Build: Editable steps and redaction for Scribe: Import captures as ordered steps with user-written instructions and keyboard reorder controls. - Import captures as ordered steps with user-written instructions and keyboard reorder controls. - Provide rectangle redaction baked into a new image; remove original secret-bearing pixels from the export asset. - Use A three-step dummy browser form containing a fake secret that must be redacted before export. Check: Reordering changes step numbers while keeping images paired with their instructions. Then check: The exported image cannot reveal the fake secret by deleting an overlay. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: A CSS blur or annotation layer is not permanent redaction. Done when: Reordering changes step numbers while keeping images paired with their instructions. The exported image cannot reveal the fake secret by deleting an overlay. Do not build yet: Do not start portable guide delivery until these checks pass. ### Phase 4 · Portable guide delivery Build: Portable guide delivery for Scribe: Generate self-contained HTML with local images and print styles; export a Markdown plus assets bundle. - Generate self-contained HTML with local images and print styles; export a Markdown plus assets bundle. - Add a final review screen showing all screenshots, URLs and text before the user exports. - Use A three-step dummy browser form containing a fake secret that must be redacted before export. Check: The exported HTML opens offline with all three steps and images. Then check: No original unredacted capture is included in the share bundle. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: Interactive replay, video generation and cross-application recording are outside this guide builder. Done when: The exported HTML opens offline with all three steps and images. No original unredacted capture is included in the share bundle. Do not build yet: Do not start portable delivery and clean-start proof until these checks pass. ### Phase 5 · Portable delivery and clean-start proof Build: Finish the Scribe replacement with a documented first-run path and a recoverable export. - Document prerequisites, every configuration variable, data locations and the three domain workflows: User-triggered capture; Editable steps and redaction; Portable guide delivery. Include the exclusions, actual costs and source check date 2026-09-05. Commands shown earlier that reference project files are files the builder must implement before running them. - Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for scribe. Restore into a separate empty directory or isolated deployment, with all outbound actions and schedules disabled. Recreate this proof: A three-step dummy browser form containing a fake secret that must be redacted before export. Compare ids/counts and open the result before recording the restore date. Never test a restore over the only live copy. - Use a new folder and only README instructions to reach the fixture outcome. Install from requirements.txt, initialize storage, run the tests and exercise the UI at 375px and 1280px; use keyboard-only controls and inspect browser errors. Record exactly what passed; do not mark unrun checks complete. Commands, after creating the named files: `python -m pip install -r requirements.txt`; `python -m unittest discover -s test`. - Trap: Export without an import or restore rehearsal is not verified portability. Done when: A new folder reaches the documented fixture outcome using only README instructions. A backup restored in isolation preserves the proof data and can be opened. Do not build yet: Do not start operate and share with access controls until these checks pass. ### Phase 6 · Operate and share with access controls (product-builder only) Build: Product-builder only: make an explicit screenshot-to-guide editor with a small browser capture helper operable for its stated audience before allowing remote access. - Add owner/member/viewer authorization as appropriate, password hashes through Werkzeug, expiring server-side sessions, CSRF and login rate limits. Add users, sessions and audit schema migrations plus an owner-init command prompting securely for its password. Enforce ownership on every private read/write/download and fail closed when product setup is incomplete. Existing learner or admin identities must use this same boundary. - Serve app:app with Waitress on loopback behind Caddy HTTPS. Configure trusted proxy headers narrowly, Secure/HttpOnly/SameSite cookies, upload limits, request ids and structured logs without private content. Run background jobs as a separate supervised process when the domain workflow requires them. Commands, after creating the named files: `waitress-serve --listen=127.0.0.1:5000 app:app`. - Add a scheduled encrypted off-host backup using this procedure: Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for scribe. Monitor health, disk space, failed jobs and backup age. Stop the service to test an alert; rehearse recovery with outbound effects disabled and record recovery time. Rotate any exposed credentials and require reconciliation before resuming queues. - Trap: Product mode is additional engineering, not a switch that makes a local prototype production-ready. Done when: An unauthenticated visitor cannot read private records, download private files or mutate the admin surface. A viewer cannot mutate data by making a direct request, and guessed ids cannot cross ownership boundaries. Stopping the service triggers the configured alert and the latest off-host backup restores the fixture in isolation. Do not build yet: Do not add new providers or vendor-scale features until the release gates are recorded. ### Out of scope (and why) - Interactive replay, video generation and cross-application recording are outside this guide builder. - This is an explicit screenshot-to-guide editor with a small browser capture helper; full Scribe feature parity, vendor hosting and support are not included. - automatic capture quality, redaction, team libraries, integrations, and sharing: retain the paid product if this capability is essential; it is outside this bounded build. - instant hosted sharing: retain the paid product if this capability is essential; it is outside this bounded build. - viewer analytics: retain the paid product if this capability is essential; it is outside this bounded build. - team libraries: retain the paid product if this capability is essential; it is outside this bounded build. - cross-device capture: retain the paid product if this capability is essential; it is outside this bounded build. ### README must contain - Exact install, configure, initialize, start, test and recovery commands for a clean folder. - The schema, fixture, acceptance results, private data locations and export format. - Every prerequisite and secret source, actual running costs and deliberately excluded capabilities. - An honest distinction between tests actually run and checks still awaiting real credentials or deployment. - Dependency documentation reviewed 2026-09-05: https://flask.palletsprojects.com/en/stable/installation/ ; https://docs.python.org/3/library/sqlite3.html ; https://flask-wtf.readthedocs.io/en/1.2.x/csrf/ ; https://docs.pylonsproject.org/projects/waitress/en/stable/usage.html ; https://developer.chrome.com/docs/extensions/develop/concepts/activeTab. Recheck before upgrading; freeze the versions actually tested. ===== AGENTS.md ===== # Agent instructions · Scribe indie build - Read `README.md` and `BUILD_PLAN.md` before writing code. The stack is fixed: Python 3.12+ and Flask, SQLite through Python sqlite3, Jinja HTML templates, CSS and vanilla JavaScript, Python unittest and browser acceptance fixtures, Pillow. Do not substitute. - Work one phase at a time, in order. Do not start a phase until every "Done when" item of the previous one passes. - Prefer the fewest moving parts that satisfy the step. No frameworks, services or dependencies the plan does not name. - Secrets live in `.env`, never in source or logs. Keep `.env.example` current when a variable is introduced. - Do not invent cryptography, security guarantees, APIs or compliance claims. - Add a focused test for every destructive, security-sensitive or data-loss path the plan names. - Run the project checks before declaring a phase complete, and record any deliberate shortcut in the README under "Tradeoffs". ## Known traps - The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. - Do not record form values, keystrokes or passwords to generate instructions. - A CSS blur or annotation layer is not permanent redaction. - Interactive replay, video generation and cross-application recording are outside this guide builder. - Export without an import or restore rehearsal is not verified portability. ===== BUILD_PLAN.md ===== # Build plan · Scribe Build an explicit screenshot-to-guide editor with a small browser capture helper. Phases are in dependency order. Each ends in a "Done when" list; treat an unticked item as a blocker, not a note. ## Phase 1 · Local foundation and data contract Create the runnable local foundation for an explicit screenshot-to-guide editor with a small browser capture helper, including the real schema and acceptance fixture. ### Steps 1. Create and start the local application Run the venv command first, then stop and activate it before running the remaining commands. Use your OS instructions: Windows .venv\Scripts\activate.bat in cmd, or .venv\Scripts\Activate.ps1 in PowerShell; macOS/Linux source .venv/bin/activate. Then install the listed packages. Create app.py exposing app, load .env with python-dotenv, and add a /healthz route. Freeze tested dependency versions to requirements.txt. Create .env manually from .env.example; replace SECRET_KEY before launch. Files: `app.py`, `requirements.txt`, `.env.example`, `.gitignore` ```sh python -m venv .venv python -m pip install Flask Flask-WTF python-dotenv waitress tzdata Pillow python -m pip freeze > requirements.txt python -m flask --app app run --host 127.0.0.1 ``` 2. Implement storage and seed the named fixture For database-backed state create schema.sql and db.py using this model: guides(id,title); steps(id,guide_id,position,title,instruction,image_path); redactions(id,step_id,x,y,w,h); captures(id,guide_id,url,at,approved). Add the auxiliary relationships explicitly used in later phases; use stable ids, foreign keys, parameterized values and transactions. For canonical files use atomic replacement and hashes instead. Implement python manage.py init and python manage.py seed to create only synthetic data: A three-step dummy browser form containing a fake secret that must be redacted before export. Re-running init must not erase data. Files: `schema.sql`, `db.py`, `manage.py`, `fixtures/README.md` ```sh python manage.py init python manage.py seed ``` 3. Protect the local request boundary Install Flask-WTF CSRF protection for forms and same-origin fetches, validate Host and Origin against SITE_URL, bound inputs and escape output. Deliberately public intake endpoints get bounded validation and rate limits; signed provider webhooks use signature checks instead of browser CSRF tokens. All other admin routes stay local until product authentication exists. When a later phase tests viewer/member permissions, implement the users, hashed passwords, expiring server sessions and role checks in this foundation first; product mode must never use a fabricated identity from request input. Add error, empty, keyboard-focus and retry states now. Files: `app.py`, `templates/base.html`, `test/test_foundation.py` ### Done when - [ ] The documented start command serves /healthz and the initial screen at http://127.0.0.1:5000. - [ ] Restarting preserves the seeded records or canonical files; running init again deletes nothing. - [ ] A cross-origin state-changing request to an admin route is refused. ### Watch out - The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. ## Phase 2 · User-triggered capture User-triggered capture for Scribe: Build a Chromium extension with activeTab and a toolbar action that captures only after a user click. ### Steps 1. Build a Chromium extension with activeTab and a toolbar action that captures only after a user click. Build a Chromium extension with activeTab and a toolbar action that captures only after a user click. Files: `features/user_triggered_capture.py`, `templates/user_triggered_capture.html` 2. Download a capture bundle for manual import into the local editor; include URL only after stripping query and fragment. Download a capture bundle for manual import into the local editor; include URL only after stripping query and fragment. Files: `features/user_triggered_capture.py` 3. Exercise the acceptance fixture Use A three-step dummy browser form containing a fake secret that must be redacted before export. Check: Opening a page without clicking Capture creates no screenshot. Then check: The extension requests no all-sites or background browsing permission. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_user_triggered_capture.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] Opening a page without clicking Capture creates no screenshot. - [ ] The extension requests no all-sites or background browsing permission. ### Watch out - Do not record form values, keystrokes or passwords to generate instructions. ## Phase 3 · Editable steps and redaction Editable steps and redaction for Scribe: Import captures as ordered steps with user-written instructions and keyboard reorder controls. ### Steps 1. Import captures as ordered steps with user-written instructions and keyboard reorder controls. Import captures as ordered steps with user-written instructions and keyboard reorder controls. Files: `features/editable_steps_and_redaction.py`, `templates/editable_steps_and_redaction.html` 2. Provide rectangle redaction baked into a new image; remove original secret-bearing pixels from the export asset. Provide rectangle redaction baked into a new image; remove original secret-bearing pixels from the export asset. Files: `features/editable_steps_and_redaction.py` 3. Exercise the acceptance fixture Use A three-step dummy browser form containing a fake secret that must be redacted before export. Check: Reordering changes step numbers while keeping images paired with their instructions. Then check: The exported image cannot reveal the fake secret by deleting an overlay. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_editable_steps_and_redaction.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] Reordering changes step numbers while keeping images paired with their instructions. - [ ] The exported image cannot reveal the fake secret by deleting an overlay. ### Watch out - A CSS blur or annotation layer is not permanent redaction. ## Phase 4 · Portable guide delivery Portable guide delivery for Scribe: Generate self-contained HTML with local images and print styles; export a Markdown plus assets bundle. ### Steps 1. Generate self-contained HTML with local images and print styles; export a Markdown plus assets bundle. Generate self-contained HTML with local images and print styles; export a Markdown plus assets bundle. Files: `features/portable_guide_delivery.py`, `templates/portable_guide_delivery.html` 2. Add a final review screen showing all screenshots, URLs and text before the user exports. Add a final review screen showing all screenshots, URLs and text before the user exports. Files: `features/portable_guide_delivery.py` 3. Exercise the acceptance fixture Use A three-step dummy browser form containing a fake secret that must be redacted before export. Check: The exported HTML opens offline with all three steps and images. Then check: No original unredacted capture is included in the share bundle. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_portable_guide_delivery.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] The exported HTML opens offline with all three steps and images. - [ ] No original unredacted capture is included in the share bundle. ### Watch out - Interactive replay, video generation and cross-application recording are outside this guide builder. ## Phase 5 · Portable delivery and clean-start proof Finish the Scribe replacement with a documented first-run path and a recoverable export. ### Steps 1. Write the user-facing runbook Document prerequisites, every configuration variable, data locations and the three domain workflows: User-triggered capture; Editable steps and redaction; Portable guide delivery. Include the exclusions, actual costs and source check date 2026-09-05. Commands shown earlier that reference project files are files the builder must implement before running them. Files: `README.md`, `.env.example` 2. Create and rehearse a recoverable backup Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for scribe. Restore into a separate empty directory or isolated deployment, with all outbound actions and schedules disabled. Recreate this proof: A three-step dummy browser form containing a fake secret that must be redacted before export. Compare ids/counts and open the result before recording the restore date. Never test a restore over the only live copy. Files: `OPERATIONS.md`, `scripts/backup.py` 3. Reproduce the first-run experience Use a new folder and only README instructions to reach the fixture outcome. Install from requirements.txt, initialize storage, run the tests and exercise the UI at 375px and 1280px; use keyboard-only controls and inspect browser errors. Record exactly what passed; do not mark unrun checks complete. Files: `README.md`, `verification.md` ```sh python -m pip install -r requirements.txt python -m unittest discover -s test ``` ### Done when - [ ] A new folder reaches the documented fixture outcome using only README instructions. - [ ] A backup restored in isolation preserves the proof data and can be opened. ### Watch out - Export without an import or restore rehearsal is not verified portability. ## Not in this build - Interactive replay, video generation and cross-application recording are outside this guide builder. - This is an explicit screenshot-to-guide editor with a small browser capture helper; full Scribe feature parity, vendor hosting and support are not included. - automatic capture quality, redaction, team libraries, integrations, and sharing - instant hosted sharing - viewer analytics - team libraries - cross-device capture ## After v1, if you want it - Extend portable guide delivery only after the fixture and recovery checks pass. - Before adding another integration, document its credentials, limits, cost and failure behavior with primary-source links. ===== .env.example ===== # Copy to .env and fill in. Never commit .env; this file documents it. # Required. A new private folder this application creates on first run; never serve it as static files. DATA_DIR=./data/scribe # Required · secret. Generate with python -c "import secrets; print(secrets.token_hex(32))" and save only in .env. SECRET_KEY=replace-with-a-random-secret # Required. Use indie for loopback-only personal work. Product mode must refuse to start until owner login and the deployment gates are configured. APP_MODE=indie # Required. The origin used for local forms and links; replace with the chosen HTTPS origin in product mode. SITE_URL=http://127.0.0.1:5000
You are building a production product version of Scribe. Create the following project files first, then implement the application by following them. Keep the files updated as decisions change. Do not collapse this into a single README or prompt. ===== PRODUCT.md ===== # Scribe · product brief ## Problem The core loop is buildable, but a dependable replacement becomes a real weekend or multi-day project. For Scribe, capture a browser workflow and produce editable step-by-step documentation. The hard boundary is automatic capture quality, redaction, team libraries, integrations, and sharing, plus capture polish, hosting, and collaboration. ## Product outcome An operated version of an explicit screenshot-to-guide editor with a small browser capture helper, with authorized access, restore evidence and honest scope limits. ## Target user A builder who needs a maintainable product foundation, not a one-off demo. ## Required capabilities - macOS or Windows screen-recording permission - microphone permission - ffmpeg - local disk space ## Explicit non-goals for v1 - Interactive replay, video generation and cross-application recording are outside this guide builder. - This is an explicit screenshot-to-guide editor with a small browser capture helper; full Scribe feature parity, vendor hosting and support are not included. - automatic capture quality, redaction, team libraries, integrations, and sharing - instant hosted sharing - viewer analytics - team libraries - cross-device capture ## Success criteria - Opening a page without clicking Capture creates no screenshot. - Reordering changes step numbers while keeping images paired with their instructions. - The exported HTML opens offline with all three steps and images. - A private-data authorization check passes using a second identity. - An off-host restore drill has a date, observed result and recovery time in OPERATIONS.md. - README names the excluded vendor capabilities and actual provider/hosting costs. ===== BRIEF.md ===== # Build brief · Scribe The one-shot brief this plan expands. `BUILD_PLAN.md` (or `MILESTONES.md`) is the same sequence broken into steps and checks; where the two disagree, the plan wins. Build me an explicit screenshot-to-guide editor with a small browser capture helper as a bounded replacement for Scribe. Build it in phases in the order below. Do not write the whole product in one pass. Finish the current phase, run its Done when checks, fix failures, then continue. Indie mode completes Phases 1-5. Phase 6 is required before shared or public deployment. ### Stack (fixed, do not substitute) - Runtime: Python 3.12+ and Flask. A small local HTTP application with readable server-side handlers and no JavaScript build pipeline. - Storage: SQLite through Python sqlite3. Local ownership with explicit transactions and a portable backup path. - Interface: Jinja HTML templates, CSS and vanilla JavaScript. Implement the specified screens directly with labelled controls and progressive enhancement. - Verification: Python unittest and browser acceptance fixtures. Check invariants and the actual user workflow before the next phase. - Focused libraries: Pillow. Use these only for the specific file, parsing or provider operations named in the phases; freeze tested versions. ### Data model (create this before Phase 1) - guides(id,title) - steps(id,guide_id,position,title,instruction,image_path) - redactions(id,step_id,x,y,w,h) - captures(id,guide_id,url,at,approved) - Use stable ids and explicit relationships; add auxiliary tables named by the phases before those phases use them. - Acceptance fixture: A three-step dummy browser form containing a fake secret that must be redacted before export. ### Prerequisites and configuration - Python 3.12 or newer and a terminal: Install Python from python.org. Open a terminal in a new empty project folder. On Windows, use py -3 where this guide says python if python is not on PATH; on macOS/Linux use python3 if needed. Create .venv and activate it before installing packages. Verify: python --version reports 3.12+ and python -c "import sqlite3" succeeds. Cost: Python is free; this local prototype requires no hosting subscription. - A current desktop browser and text editor: Use an installed Chrome, Firefox or Edge browser. Open the empty project folder in your editor; open the terminal there, not in this catalog repository. Verify: You can create a text file in the project folder and open browser developer tools. Cost: No paid service required for this local step. - Scribe acceptance sample: Create synthetic sample data before implementation: A three-step dummy browser form containing a fake secret that must be redacted before export. Save it under fixtures/ with the expected results in fixtures/README.md; use no real credentials or customer records. Verify: The fixture files and expected outcomes exist and can be inspected without a vendor account. Cost: No paid service required for this local step. - Confirm the bounded replacement: The deliverable is an explicit screenshot-to-guide editor with a small browser capture helper. Read every exclusion below. Indie mode runs locally; any public or shared use requires the product access and deployment gates first. Verify: You can name the primary workflow and the vendor features this version deliberately leaves out. Cost: No paid service required for this local step. - Chromium extension development mode: Open chrome://extensions, enable Developer mode and use Load unpacked on the generated extension/ folder. Use only dummy pages for the first captures. Verify: The toolbar action captures the active dummy tab after a deliberate click. Cost: No paid account required. - Configuration: DATA_DIR, SECRET_KEY, APP_MODE, SITE_URL. Ship .env.example, replace placeholders and exclude secrets from git. ### Phase 1 · Local foundation and data contract Build: Create the runnable local foundation for an explicit screenshot-to-guide editor with a small browser capture helper, including the real schema and acceptance fixture. - Run the venv command first, then stop and activate it before running the remaining commands. Use your OS instructions: Windows .venv\Scripts\activate.bat in cmd, or .venv\Scripts\Activate.ps1 in PowerShell; macOS/Linux source .venv/bin/activate. Then install the listed packages. Create app.py exposing app, load .env with python-dotenv, and add a /healthz route. Freeze tested dependency versions to requirements.txt. Create .env manually from .env.example; replace SECRET_KEY before launch. Commands, after creating the named files: `python -m venv .venv`; `python -m pip install Flask Flask-WTF python-dotenv waitress tzdata Pillow`; `python -m pip freeze > requirements.txt`; `python -m flask --app app run --host 127.0.0.1`. - For database-backed state create schema.sql and db.py using this model: guides(id,title); steps(id,guide_id,position,title,instruction,image_path); redactions(id,step_id,x,y,w,h); captures(id,guide_id,url,at,approved). Add the auxiliary relationships explicitly used in later phases; use stable ids, foreign keys, parameterized values and transactions. For canonical files use atomic replacement and hashes instead. Implement python manage.py init and python manage.py seed to create only synthetic data: A three-step dummy browser form containing a fake secret that must be redacted before export. Re-running init must not erase data. Commands, after creating the named files: `python manage.py init`; `python manage.py seed`. - Install Flask-WTF CSRF protection for forms and same-origin fetches, validate Host and Origin against SITE_URL, bound inputs and escape output. Deliberately public intake endpoints get bounded validation and rate limits; signed provider webhooks use signature checks instead of browser CSRF tokens. All other admin routes stay local until product authentication exists. When a later phase tests viewer/member permissions, implement the users, hashed passwords, expiring server sessions and role checks in this foundation first; product mode must never use a fabricated identity from request input. Add error, empty, keyboard-focus and retry states now. - Trap: The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. Done when: The documented start command serves /healthz and the initial screen at http://127.0.0.1:5000. Restarting preserves the seeded records or canonical files; running init again deletes nothing. A cross-origin state-changing request to an admin route is refused. Do not build yet: Do not start user-triggered capture until these checks pass. ### Phase 2 · User-triggered capture Build: User-triggered capture for Scribe: Build a Chromium extension with activeTab and a toolbar action that captures only after a user click. - Build a Chromium extension with activeTab and a toolbar action that captures only after a user click. - Download a capture bundle for manual import into the local editor; include URL only after stripping query and fragment. - Use A three-step dummy browser form containing a fake secret that must be redacted before export. Check: Opening a page without clicking Capture creates no screenshot. Then check: The extension requests no all-sites or background browsing permission. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: Do not record form values, keystrokes or passwords to generate instructions. Done when: Opening a page without clicking Capture creates no screenshot. The extension requests no all-sites or background browsing permission. Do not build yet: Do not start editable steps and redaction until these checks pass. ### Phase 3 · Editable steps and redaction Build: Editable steps and redaction for Scribe: Import captures as ordered steps with user-written instructions and keyboard reorder controls. - Import captures as ordered steps with user-written instructions and keyboard reorder controls. - Provide rectangle redaction baked into a new image; remove original secret-bearing pixels from the export asset. - Use A three-step dummy browser form containing a fake secret that must be redacted before export. Check: Reordering changes step numbers while keeping images paired with their instructions. Then check: The exported image cannot reveal the fake secret by deleting an overlay. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: A CSS blur or annotation layer is not permanent redaction. Done when: Reordering changes step numbers while keeping images paired with their instructions. The exported image cannot reveal the fake secret by deleting an overlay. Do not build yet: Do not start portable guide delivery until these checks pass. ### Phase 4 · Portable guide delivery Build: Portable guide delivery for Scribe: Generate self-contained HTML with local images and print styles; export a Markdown plus assets bundle. - Generate self-contained HTML with local images and print styles; export a Markdown plus assets bundle. - Add a final review screen showing all screenshots, URLs and text before the user exports. - Use A three-step dummy browser form containing a fake secret that must be redacted before export. Check: The exported HTML opens offline with all three steps and images. Then check: No original unredacted capture is included in the share bundle. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: Interactive replay, video generation and cross-application recording are outside this guide builder. Done when: The exported HTML opens offline with all three steps and images. No original unredacted capture is included in the share bundle. Do not build yet: Do not start portable delivery and clean-start proof until these checks pass. ### Phase 5 · Portable delivery and clean-start proof Build: Finish the Scribe replacement with a documented first-run path and a recoverable export. - Document prerequisites, every configuration variable, data locations and the three domain workflows: User-triggered capture; Editable steps and redaction; Portable guide delivery. Include the exclusions, actual costs and source check date 2026-09-05. Commands shown earlier that reference project files are files the builder must implement before running them. - Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for scribe. Restore into a separate empty directory or isolated deployment, with all outbound actions and schedules disabled. Recreate this proof: A three-step dummy browser form containing a fake secret that must be redacted before export. Compare ids/counts and open the result before recording the restore date. Never test a restore over the only live copy. - Use a new folder and only README instructions to reach the fixture outcome. Install from requirements.txt, initialize storage, run the tests and exercise the UI at 375px and 1280px; use keyboard-only controls and inspect browser errors. Record exactly what passed; do not mark unrun checks complete. Commands, after creating the named files: `python -m pip install -r requirements.txt`; `python -m unittest discover -s test`. - Trap: Export without an import or restore rehearsal is not verified portability. Done when: A new folder reaches the documented fixture outcome using only README instructions. A backup restored in isolation preserves the proof data and can be opened. Do not build yet: Do not start operate and share with access controls until these checks pass. ### Phase 6 · Operate and share with access controls (product-builder only) Build: Product-builder only: make an explicit screenshot-to-guide editor with a small browser capture helper operable for its stated audience before allowing remote access. - Add owner/member/viewer authorization as appropriate, password hashes through Werkzeug, expiring server-side sessions, CSRF and login rate limits. Add users, sessions and audit schema migrations plus an owner-init command prompting securely for its password. Enforce ownership on every private read/write/download and fail closed when product setup is incomplete. Existing learner or admin identities must use this same boundary. - Serve app:app with Waitress on loopback behind Caddy HTTPS. Configure trusted proxy headers narrowly, Secure/HttpOnly/SameSite cookies, upload limits, request ids and structured logs without private content. Run background jobs as a separate supervised process when the domain workflow requires them. Commands, after creating the named files: `waitress-serve --listen=127.0.0.1:5000 app:app`. - Add a scheduled encrypted off-host backup using this procedure: Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for scribe. Monitor health, disk space, failed jobs and backup age. Stop the service to test an alert; rehearse recovery with outbound effects disabled and record recovery time. Rotate any exposed credentials and require reconciliation before resuming queues. - Trap: Product mode is additional engineering, not a switch that makes a local prototype production-ready. Done when: An unauthenticated visitor cannot read private records, download private files or mutate the admin surface. A viewer cannot mutate data by making a direct request, and guessed ids cannot cross ownership boundaries. Stopping the service triggers the configured alert and the latest off-host backup restores the fixture in isolation. Do not build yet: Do not add new providers or vendor-scale features until the release gates are recorded. ### Out of scope (and why) - Interactive replay, video generation and cross-application recording are outside this guide builder. - This is an explicit screenshot-to-guide editor with a small browser capture helper; full Scribe feature parity, vendor hosting and support are not included. - automatic capture quality, redaction, team libraries, integrations, and sharing: retain the paid product if this capability is essential; it is outside this bounded build. - instant hosted sharing: retain the paid product if this capability is essential; it is outside this bounded build. - viewer analytics: retain the paid product if this capability is essential; it is outside this bounded build. - team libraries: retain the paid product if this capability is essential; it is outside this bounded build. - cross-device capture: retain the paid product if this capability is essential; it is outside this bounded build. ### README must contain - Exact install, configure, initialize, start, test and recovery commands for a clean folder. - The schema, fixture, acceptance results, private data locations and export format. - Every prerequisite and secret source, actual running costs and deliberately excluded capabilities. - An honest distinction between tests actually run and checks still awaiting real credentials or deployment. - Dependency documentation reviewed 2026-09-05: https://flask.palletsprojects.com/en/stable/installation/ ; https://docs.python.org/3/library/sqlite3.html ; https://flask-wtf.readthedocs.io/en/1.2.x/csrf/ ; https://docs.pylonsproject.org/projects/waitress/en/stable/usage.html ; https://developer.chrome.com/docs/extensions/develop/concepts/activeTab. Recheck before upgrading; freeze the versions actually tested. ===== ARCHITECTURE.md ===== # Architecture · Scribe ## Stack | Part | Choice | Why | | --- | --- | --- | | Runtime | Python 3.12+ and Flask | A small local HTTP application with readable server-side handlers and no JavaScript build pipeline. | | Storage | SQLite through Python sqlite3 | Local ownership with explicit transactions and a portable backup path. | | Interface | Jinja HTML templates, CSS and vanilla JavaScript | Implement the specified screens directly with labelled controls and progressive enhancement. | | Verification | Python unittest and browser acceptance fixtures | Check invariants and the actual user workflow before the next phase. | | Focused libraries | Pillow | Use these only for the specific file, parsing or provider operations named in the phases; freeze tested versions. | ## Modules Each module has one owner concern and a documented way to replace it. | Module | Owns | How to replace it | | --- | --- | --- | | Data and identity | guides(id,title); steps(id,guide_id,position,title,instruction,image_path); redactions(id,step_id,x,y,w,h); captures(id,guide_id,url,at,approved) | Keep stable ids and a versioned repository interface; migrate storage behind it with a fixture round-trip. | | User-triggered capture | Build a Chromium extension with activeTab and a toolbar action that captures only after a user click. | Keep the acceptance contract: Opening a page without clicking Capture creates no screenshot. Replace only this module after replaying its fixture; preserve ids and existing records. | | Editable steps and redaction | Import captures as ordered steps with user-written instructions and keyboard reorder controls. | Keep the acceptance contract: Reordering changes step numbers while keeping images paired with their instructions. Replace only this module after replaying its fixture; preserve ids and existing records. | | Portable guide delivery | Generate self-contained HTML with local images and print styles; export a Markdown plus assets bundle. | Keep the acceptance contract: The exported HTML opens offline with all three steps and images. Replace only this module after replaying its fixture; preserve ids and existing records. | | Operations | Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for scribe. | Change host or backup destination only after an isolated restore and authorization check. | ## Configuration Every runtime setting is an environment variable documented in `.env.example`, validated at startup, with a safe local default wherever one exists. - `DATA_DIR` · required · A new private folder this application creates on first run; never serve it as static files. - `SECRET_KEY` · required, secret · Generate with python -c "import secrets; print(secrets.token_hex(32))" and save only in .env. - `APP_MODE` · required · Use indie for loopback-only personal work. Product mode must refuse to start until owner login and the deployment gates are configured. - `SITE_URL` · required · The origin used for local forms and links; replace with the chosen HTTPS origin in product mode. ## Production baseline - Security: least privilege, input validation at every boundary, secret redaction in logs, rate limits on abuse-prone paths, no invented security primitives. - Data: explicit schema and migrations, transactional writes where integrity matters, backup and restore procedures that have been exercised. - Integrations: adapters around third-party providers, idempotent webhook or job processing, bounded retries, timeouts. - Observability: structured logs with request or operation ids, an error-tracking hook, and health and readiness checks where a server exists. - Quality: unit tests for domain rules, integration tests at module boundaries, one end-to-end test of the critical path. ## Decision records For each dependency in the stack table, keep a short note: why it was chosen, its failure mode, and how it is replaced. Do not add infrastructure until a requirement in `PRODUCT.md` justifies it. ===== AGENTS.md ===== # Agent instructions · Scribe product build - Read `PRODUCT.md` and `ARCHITECTURE.md` before changing code. The stack is fixed: Python 3.12+ and Flask, SQLite through Python sqlite3, Jinja HTML templates, CSS and vanilla JavaScript, Python unittest and browser acceptance fixtures, Pillow. - Implement milestone by milestone from `MILESTONES.md`; keep each change reviewable and leave the application runnable at every commit. - Treat authentication, payments, encryption, imports, webhooks and destructive actions as high-risk boundaries when present. - Never invent cryptography or silently weaken a requirement to make a check pass. - Put every external service behind an interface with a deterministic fake for tests. - Add migrations and rollback or recovery notes for every persistent data change. - Log useful operational context without credentials, tokens, passwords or personal data. - Update documentation and run every check before completing a milestone. ## Known traps - The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. - Do not record form values, keystrokes or passwords to generate instructions. - A CSS blur or annotation layer is not permanent redaction. - Interactive replay, video generation and cross-application recording are outside this guide builder. - Export without an import or restore rehearsal is not verified portability. - Product mode is additional engineering, not a switch that makes a local prototype production-ready. ===== MILESTONES.md ===== # Delivery milestones · Scribe Estimated effort: **multi-day** for the indie phases; the production-only milestones add the trust and operability layer. ## M1 · Local foundation and data contract Create the runnable local foundation for an explicit screenshot-to-guide editor with a small browser capture helper, including the real schema and acceptance fixture. ### Steps 1. Create and start the local application Run the venv command first, then stop and activate it before running the remaining commands. Use your OS instructions: Windows .venv\Scripts\activate.bat in cmd, or .venv\Scripts\Activate.ps1 in PowerShell; macOS/Linux source .venv/bin/activate. Then install the listed packages. Create app.py exposing app, load .env with python-dotenv, and add a /healthz route. Freeze tested dependency versions to requirements.txt. Create .env manually from .env.example; replace SECRET_KEY before launch. Files: `app.py`, `requirements.txt`, `.env.example`, `.gitignore` ```sh python -m venv .venv python -m pip install Flask Flask-WTF python-dotenv waitress tzdata Pillow python -m pip freeze > requirements.txt python -m flask --app app run --host 127.0.0.1 ``` 2. Implement storage and seed the named fixture For database-backed state create schema.sql and db.py using this model: guides(id,title); steps(id,guide_id,position,title,instruction,image_path); redactions(id,step_id,x,y,w,h); captures(id,guide_id,url,at,approved). Add the auxiliary relationships explicitly used in later phases; use stable ids, foreign keys, parameterized values and transactions. For canonical files use atomic replacement and hashes instead. Implement python manage.py init and python manage.py seed to create only synthetic data: A three-step dummy browser form containing a fake secret that must be redacted before export. Re-running init must not erase data. Files: `schema.sql`, `db.py`, `manage.py`, `fixtures/README.md` ```sh python manage.py init python manage.py seed ``` 3. Protect the local request boundary Install Flask-WTF CSRF protection for forms and same-origin fetches, validate Host and Origin against SITE_URL, bound inputs and escape output. Deliberately public intake endpoints get bounded validation and rate limits; signed provider webhooks use signature checks instead of browser CSRF tokens. All other admin routes stay local until product authentication exists. When a later phase tests viewer/member permissions, implement the users, hashed passwords, expiring server sessions and role checks in this foundation first; product mode must never use a fabricated identity from request input. Add error, empty, keyboard-focus and retry states now. Files: `app.py`, `templates/base.html`, `test/test_foundation.py` ### Done when - [ ] The documented start command serves /healthz and the initial screen at http://127.0.0.1:5000. - [ ] Restarting preserves the seeded records or canonical files; running init again deletes nothing. - [ ] A cross-origin state-changing request to an admin route is refused. ### Watch out - The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. ## M2 · User-triggered capture User-triggered capture for Scribe: Build a Chromium extension with activeTab and a toolbar action that captures only after a user click. ### Steps 1. Build a Chromium extension with activeTab and a toolbar action that captures only after a user click. Build a Chromium extension with activeTab and a toolbar action that captures only after a user click. Files: `features/user_triggered_capture.py`, `templates/user_triggered_capture.html` 2. Download a capture bundle for manual import into the local editor; include URL only after stripping query and fragment. Download a capture bundle for manual import into the local editor; include URL only after stripping query and fragment. Files: `features/user_triggered_capture.py` 3. Exercise the acceptance fixture Use A three-step dummy browser form containing a fake secret that must be redacted before export. Check: Opening a page without clicking Capture creates no screenshot. Then check: The extension requests no all-sites or background browsing permission. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_user_triggered_capture.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] Opening a page without clicking Capture creates no screenshot. - [ ] The extension requests no all-sites or background browsing permission. ### Watch out - Do not record form values, keystrokes or passwords to generate instructions. ## M3 · Editable steps and redaction Editable steps and redaction for Scribe: Import captures as ordered steps with user-written instructions and keyboard reorder controls. ### Steps 1. Import captures as ordered steps with user-written instructions and keyboard reorder controls. Import captures as ordered steps with user-written instructions and keyboard reorder controls. Files: `features/editable_steps_and_redaction.py`, `templates/editable_steps_and_redaction.html` 2. Provide rectangle redaction baked into a new image; remove original secret-bearing pixels from the export asset. Provide rectangle redaction baked into a new image; remove original secret-bearing pixels from the export asset. Files: `features/editable_steps_and_redaction.py` 3. Exercise the acceptance fixture Use A three-step dummy browser form containing a fake secret that must be redacted before export. Check: Reordering changes step numbers while keeping images paired with their instructions. Then check: The exported image cannot reveal the fake secret by deleting an overlay. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_editable_steps_and_redaction.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] Reordering changes step numbers while keeping images paired with their instructions. - [ ] The exported image cannot reveal the fake secret by deleting an overlay. ### Watch out - A CSS blur or annotation layer is not permanent redaction. ## M4 · Portable guide delivery Portable guide delivery for Scribe: Generate self-contained HTML with local images and print styles; export a Markdown plus assets bundle. ### Steps 1. Generate self-contained HTML with local images and print styles; export a Markdown plus assets bundle. Generate self-contained HTML with local images and print styles; export a Markdown plus assets bundle. Files: `features/portable_guide_delivery.py`, `templates/portable_guide_delivery.html` 2. Add a final review screen showing all screenshots, URLs and text before the user exports. Add a final review screen showing all screenshots, URLs and text before the user exports. Files: `features/portable_guide_delivery.py` 3. Exercise the acceptance fixture Use A three-step dummy browser form containing a fake secret that must be redacted before export. Check: The exported HTML opens offline with all three steps and images. Then check: No original unredacted capture is included in the share bundle. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_portable_guide_delivery.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] The exported HTML opens offline with all three steps and images. - [ ] No original unredacted capture is included in the share bundle. ### Watch out - Interactive replay, video generation and cross-application recording are outside this guide builder. ## M5 · Portable delivery and clean-start proof Finish the Scribe replacement with a documented first-run path and a recoverable export. ### Steps 1. Write the user-facing runbook Document prerequisites, every configuration variable, data locations and the three domain workflows: User-triggered capture; Editable steps and redaction; Portable guide delivery. Include the exclusions, actual costs and source check date 2026-09-05. Commands shown earlier that reference project files are files the builder must implement before running them. Files: `README.md`, `.env.example` 2. Create and rehearse a recoverable backup Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for scribe. Restore into a separate empty directory or isolated deployment, with all outbound actions and schedules disabled. Recreate this proof: A three-step dummy browser form containing a fake secret that must be redacted before export. Compare ids/counts and open the result before recording the restore date. Never test a restore over the only live copy. Files: `OPERATIONS.md`, `scripts/backup.py` 3. Reproduce the first-run experience Use a new folder and only README instructions to reach the fixture outcome. Install from requirements.txt, initialize storage, run the tests and exercise the UI at 375px and 1280px; use keyboard-only controls and inspect browser errors. Record exactly what passed; do not mark unrun checks complete. Files: `README.md`, `verification.md` ```sh python -m pip install -r requirements.txt python -m unittest discover -s test ``` ### Done when - [ ] A new folder reaches the documented fixture outcome using only README instructions. - [ ] A backup restored in isolation preserves the proof data and can be opened. ### Watch out - Export without an import or restore rehearsal is not verified portability. ## M6 · Operate and share with access controls (production only) Product-builder only: make an explicit screenshot-to-guide editor with a small browser capture helper operable for its stated audience before allowing remote access. ### Steps 1. Establish owner access before exposure Add owner/member/viewer authorization as appropriate, password hashes through Werkzeug, expiring server-side sessions, CSRF and login rate limits. Add users, sessions and audit schema migrations plus an owner-init command prompting securely for its password. Enforce ownership on every private read/write/download and fail closed when product setup is incomplete. Existing learner or admin identities must use this same boundary. Files: `ARCHITECTURE.md`, `OPERATIONS.md` 2. Deploy a monitored service Serve app:app with Waitress on loopback behind Caddy HTTPS. Configure trusted proxy headers narrowly, Secure/HttpOnly/SameSite cookies, upload limits, request ids and structured logs without private content. Run background jobs as a separate supervised process when the domain workflow requires them. Files: `Caddyfile`, `OPERATIONS.md` ```sh waitress-serve --listen=127.0.0.1:5000 app:app ``` 3. Rehearse loss and recovery Add a scheduled encrypted off-host backup using this procedure: Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for scribe. Monitor health, disk space, failed jobs and backup age. Stop the service to test an alert; rehearse recovery with outbound effects disabled and record recovery time. Rotate any exposed credentials and require reconciliation before resuming queues. Files: `OPERATIONS.md`, `release-checklist.md` ### Done when - [ ] An unauthenticated visitor cannot read private records, download private files or mutate the admin surface. - [ ] A viewer cannot mutate data by making a direct request, and guessed ids cannot cross ownership boundaries. - [ ] Stopping the service triggers the configured alert and the latest off-host backup restores the fixture in isolation. ### Watch out - Product mode is additional engineering, not a switch that makes a local prototype production-ready. ===== OPERATIONS.md ===== # Operations · Scribe ## Backup Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for scribe. ## Restore Restore into a separate empty directory or isolated deployment, with all outbound actions and schedules disabled. Recreate this proof: A three-step dummy browser form containing a fake secret that must be redacted before export. Compare ids/counts and open the result before recording the restore date. Never test a restore over the only live copy. Do a restore drill before the first real user, and write the date here when it passes. ## Monitoring Check HTTP availability, free disk, backup age and domain failures for User-triggered capture, Editable steps and redaction, Portable guide delivery. Alert without logging private payloads. ## Incident checklist Pause outbound jobs and public intake as appropriate, preserve redacted diagnostics, restore an isolated verified backup, rotate affected credentials and reconcile uncertain effects before reopening. 1. Contain the issue without destroying evidence or user data. 2. Record the timeline and affected scope. 3. Rotate exposed secrets and revoke compromised sessions or credentials. 4. Restore from a verified backup when needed. 5. Document the root cause, the remediation and the regression test. ## Release gate - [ ] Opening a page without clicking Capture creates no screenshot. - [ ] Reordering changes step numbers while keeping images paired with their instructions. - [ ] The exported HTML opens offline with all three steps and images. - [ ] A private-data authorization check passes using a second identity. - [ ] An off-host restore drill has a date, observed result and recovery time in OPERATIONS.md. - [ ] README names the excluded vendor capabilities and actual provider/hosting costs. ## Launch constraint Do not market omitted Scribe capabilities as implemented. The non-goals in `PRODUCT.md` remain user-visible limitations until they are deliberately delivered. ===== .env.example ===== # Copy to .env and fill in. Never commit .env; this file documents it. # Required. A new private folder this application creates on first run; never serve it as static files. DATA_DIR=./data/scribe # Required · secret. Generate with python -c "import secrets; print(secrets.token_hex(32))" and save only in .env. SECRET_KEY=replace-with-a-random-secret # Required. Use indie for loopback-only personal work. Product mode must refuse to start until owner login and the deployment gates are configured. APP_MODE=indie # Required. The origin used for local forms and links; replace with the chosen HTTPS origin in product mode. SITE_URL=http://127.0.0.1:5000
README.md
# Scribe · indie build Build an explicit screenshot-to-guide editor with a small browser capture helper. Estimated effort: **multi-day**. Work `BUILD_PLAN.md` top to bottom · every phase ends in a check that has to pass before the next one starts. ## Stack | Part | Choice | Why | | --- | --- | --- | | Runtime | Python 3.12+ and Flask | A small local HTTP application with readable server-side handlers and no JavaScript build pipeline. | | Storage | SQLite through Python sqlite3 | Local ownership with explicit transactions and a portable backup path. | | Interface | Jinja HTML templates, CSS and vanilla JavaScript | Implement the specified screens directly with labelled controls and progressive enhancement. | | Verification | Python unittest and browser acceptance fixtures | Check invariants and the actual user workflow before the next phase. | | Focused libraries | Pillow | Use these only for the specific file, parsing or provider operations named in the phases; freeze tested versions. | ## Before you start Have every one of these ready. The plan assumes them from step one. - [ ] **Python 3.12 or newer and a terminal** · Python is free; this local prototype requires no hosting subscription. - Why: The local backend, tests and storage use Python. - Get it: Install Python from python.org. Open a terminal in a new empty project folder. On Windows, use py -3 where this guide says python if python is not on PATH; on macOS/Linux use python3 if needed. Create .venv and activate it before installing packages. - Verify: python --version reports 3.12+ and python -c "import sqlite3" succeeds. - [ ] **A current desktop browser and text editor** · No paid service required for this local step. - Why: You need to view the local interface and edit generated project files. - Get it: Use an installed Chrome, Firefox or Edge browser. Open the empty project folder in your editor; open the terminal there, not in this catalog repository. - Verify: You can create a text file in the project folder and open browser developer tools. - [ ] **Scribe acceptance sample** · No paid service required for this local step. - Why: This fixture makes the first end-to-end check reproducible. - Get it: Create synthetic sample data before implementation: A three-step dummy browser form containing a fake secret that must be redacted before export. Save it under fixtures/ with the expected results in fixtures/README.md; use no real credentials or customer records. - Verify: The fixture files and expected outcomes exist and can be inspected without a vendor account. - [ ] **Confirm the bounded replacement** · No paid service required for this local step. - Why: The full commercial product is larger than this guide. - Get it: The deliverable is an explicit screenshot-to-guide editor with a small browser capture helper. Read every exclusion below. Indie mode runs locally; any public or shared use requires the product access and deployment gates first. - Verify: You can name the primary workflow and the vendor features this version deliberately leaves out. - [ ] **Chromium extension development mode** · No paid account required. - Why: The optional capture helper uses Chromium activeTab. - Get it: Open chrome://extensions, enable Developer mode and use Load unpacked on the generated extension/ folder. Use only dummy pages for the first captures. - Verify: The toolbar action captures the active dummy tab after a deliberate click. ## Quick start ```sh python -m venv .venv python -m pip install Flask Flask-WTF python-dotenv waitress tzdata Pillow python -m pip freeze > requirements.txt python -m flask --app app run --host 127.0.0.1 ``` Then copy `.env.example` to `.env` and fill in the values it documents. ## Honest limits This build deliberately does not replace: - Interactive replay, video generation and cross-application recording are outside this guide builder. - This is an explicit screenshot-to-guide editor with a small browser capture helper; full Scribe feature parity, vendor hosting and support are not included. - automatic capture quality, redaction, team libraries, integrations, and sharing - instant hosted sharing - viewer analytics - team libraries - cross-device capture If one of those is essential to you, that is the reason to keep paying for Scribe, and the README should say so rather than pretend.
BRIEF.md
# Build brief · Scribe The one-shot brief this plan expands. `BUILD_PLAN.md` (or `MILESTONES.md`) is the same sequence broken into steps and checks; where the two disagree, the plan wins. Build me an explicit screenshot-to-guide editor with a small browser capture helper as a bounded replacement for Scribe. Build it in phases in the order below. Do not write the whole product in one pass. Finish the current phase, run its Done when checks, fix failures, then continue. Indie mode completes Phases 1-5. Phase 6 is required before shared or public deployment. ### Stack (fixed, do not substitute) - Runtime: Python 3.12+ and Flask. A small local HTTP application with readable server-side handlers and no JavaScript build pipeline. - Storage: SQLite through Python sqlite3. Local ownership with explicit transactions and a portable backup path. - Interface: Jinja HTML templates, CSS and vanilla JavaScript. Implement the specified screens directly with labelled controls and progressive enhancement. - Verification: Python unittest and browser acceptance fixtures. Check invariants and the actual user workflow before the next phase. - Focused libraries: Pillow. Use these only for the specific file, parsing or provider operations named in the phases; freeze tested versions. ### Data model (create this before Phase 1) - guides(id,title) - steps(id,guide_id,position,title,instruction,image_path) - redactions(id,step_id,x,y,w,h) - captures(id,guide_id,url,at,approved) - Use stable ids and explicit relationships; add auxiliary tables named by the phases before those phases use them. - Acceptance fixture: A three-step dummy browser form containing a fake secret that must be redacted before export. ### Prerequisites and configuration - Python 3.12 or newer and a terminal: Install Python from python.org. Open a terminal in a new empty project folder. On Windows, use py -3 where this guide says python if python is not on PATH; on macOS/Linux use python3 if needed. Create .venv and activate it before installing packages. Verify: python --version reports 3.12+ and python -c "import sqlite3" succeeds. Cost: Python is free; this local prototype requires no hosting subscription. - A current desktop browser and text editor: Use an installed Chrome, Firefox or Edge browser. Open the empty project folder in your editor; open the terminal there, not in this catalog repository. Verify: You can create a text file in the project folder and open browser developer tools. Cost: No paid service required for this local step. - Scribe acceptance sample: Create synthetic sample data before implementation: A three-step dummy browser form containing a fake secret that must be redacted before export. Save it under fixtures/ with the expected results in fixtures/README.md; use no real credentials or customer records. Verify: The fixture files and expected outcomes exist and can be inspected without a vendor account. Cost: No paid service required for this local step. - Confirm the bounded replacement: The deliverable is an explicit screenshot-to-guide editor with a small browser capture helper. Read every exclusion below. Indie mode runs locally; any public or shared use requires the product access and deployment gates first. Verify: You can name the primary workflow and the vendor features this version deliberately leaves out. Cost: No paid service required for this local step. - Chromium extension development mode: Open chrome://extensions, enable Developer mode and use Load unpacked on the generated extension/ folder. Use only dummy pages for the first captures. Verify: The toolbar action captures the active dummy tab after a deliberate click. Cost: No paid account required. - Configuration: DATA_DIR, SECRET_KEY, APP_MODE, SITE_URL. Ship .env.example, replace placeholders and exclude secrets from git. ### Phase 1 · Local foundation and data contract Build: Create the runnable local foundation for an explicit screenshot-to-guide editor with a small browser capture helper, including the real schema and acceptance fixture. - Run the venv command first, then stop and activate it before running the remaining commands. Use your OS instructions: Windows .venv\Scripts\activate.bat in cmd, or .venv\Scripts\Activate.ps1 in PowerShell; macOS/Linux source .venv/bin/activate. Then install the listed packages. Create app.py exposing app, load .env with python-dotenv, and add a /healthz route. Freeze tested dependency versions to requirements.txt. Create .env manually from .env.example; replace SECRET_KEY before launch. Commands, after creating the named files: `python -m venv .venv`; `python -m pip install Flask Flask-WTF python-dotenv waitress tzdata Pillow`; `python -m pip freeze > requirements.txt`; `python -m flask --app app run --host 127.0.0.1`. - For database-backed state create schema.sql and db.py using this model: guides(id,title); steps(id,guide_id,position,title,instruction,image_path); redactions(id,step_id,x,y,w,h); captures(id,guide_id,url,at,approved). Add the auxiliary relationships explicitly used in later phases; use stable ids, foreign keys, parameterized values and transactions. For canonical files use atomic replacement and hashes instead. Implement python manage.py init and python manage.py seed to create only synthetic data: A three-step dummy browser form containing a fake secret that must be redacted before export. Re-running init must not erase data. Commands, after creating the named files: `python manage.py init`; `python manage.py seed`. - Install Flask-WTF CSRF protection for forms and same-origin fetches, validate Host and Origin against SITE_URL, bound inputs and escape output. Deliberately public intake endpoints get bounded validation and rate limits; signed provider webhooks use signature checks instead of browser CSRF tokens. All other admin routes stay local until product authentication exists. When a later phase tests viewer/member permissions, implement the users, hashed passwords, expiring server sessions and role checks in this foundation first; product mode must never use a fabricated identity from request input. Add error, empty, keyboard-focus and retry states now. - Trap: The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. Done when: The documented start command serves /healthz and the initial screen at http://127.0.0.1:5000. Restarting preserves the seeded records or canonical files; running init again deletes nothing. A cross-origin state-changing request to an admin route is refused. Do not build yet: Do not start user-triggered capture until these checks pass. ### Phase 2 · User-triggered capture Build: User-triggered capture for Scribe: Build a Chromium extension with activeTab and a toolbar action that captures only after a user click. - Build a Chromium extension with activeTab and a toolbar action that captures only after a user click. - Download a capture bundle for manual import into the local editor; include URL only after stripping query and fragment. - Use A three-step dummy browser form containing a fake secret that must be redacted before export. Check: Opening a page without clicking Capture creates no screenshot. Then check: The extension requests no all-sites or background browsing permission. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: Do not record form values, keystrokes or passwords to generate instructions. Done when: Opening a page without clicking Capture creates no screenshot. The extension requests no all-sites or background browsing permission. Do not build yet: Do not start editable steps and redaction until these checks pass. ### Phase 3 · Editable steps and redaction Build: Editable steps and redaction for Scribe: Import captures as ordered steps with user-written instructions and keyboard reorder controls. - Import captures as ordered steps with user-written instructions and keyboard reorder controls. - Provide rectangle redaction baked into a new image; remove original secret-bearing pixels from the export asset. - Use A three-step dummy browser form containing a fake secret that must be redacted before export. Check: Reordering changes step numbers while keeping images paired with their instructions. Then check: The exported image cannot reveal the fake secret by deleting an overlay. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: A CSS blur or annotation layer is not permanent redaction. Done when: Reordering changes step numbers while keeping images paired with their instructions. The exported image cannot reveal the fake secret by deleting an overlay. Do not build yet: Do not start portable guide delivery until these checks pass. ### Phase 4 · Portable guide delivery Build: Portable guide delivery for Scribe: Generate self-contained HTML with local images and print styles; export a Markdown plus assets bundle. - Generate self-contained HTML with local images and print styles; export a Markdown plus assets bundle. - Add a final review screen showing all screenshots, URLs and text before the user exports. - Use A three-step dummy browser form containing a fake secret that must be redacted before export. Check: The exported HTML opens offline with all three steps and images. Then check: No original unredacted capture is included in the share bundle. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: Interactive replay, video generation and cross-application recording are outside this guide builder. Done when: The exported HTML opens offline with all three steps and images. No original unredacted capture is included in the share bundle. Do not build yet: Do not start portable delivery and clean-start proof until these checks pass. ### Phase 5 · Portable delivery and clean-start proof Build: Finish the Scribe replacement with a documented first-run path and a recoverable export. - Document prerequisites, every configuration variable, data locations and the three domain workflows: User-triggered capture; Editable steps and redaction; Portable guide delivery. Include the exclusions, actual costs and source check date 2026-09-05. Commands shown earlier that reference project files are files the builder must implement before running them. - Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for scribe. Restore into a separate empty directory or isolated deployment, with all outbound actions and schedules disabled. Recreate this proof: A three-step dummy browser form containing a fake secret that must be redacted before export. Compare ids/counts and open the result before recording the restore date. Never test a restore over the only live copy. - Use a new folder and only README instructions to reach the fixture outcome. Install from requirements.txt, initialize storage, run the tests and exercise the UI at 375px and 1280px; use keyboard-only controls and inspect browser errors. Record exactly what passed; do not mark unrun checks complete. Commands, after creating the named files: `python -m pip install -r requirements.txt`; `python -m unittest discover -s test`. - Trap: Export without an import or restore rehearsal is not verified portability. Done when: A new folder reaches the documented fixture outcome using only README instructions. A backup restored in isolation preserves the proof data and can be opened. Do not build yet: Do not start operate and share with access controls until these checks pass. ### Phase 6 · Operate and share with access controls (product-builder only) Build: Product-builder only: make an explicit screenshot-to-guide editor with a small browser capture helper operable for its stated audience before allowing remote access. - Add owner/member/viewer authorization as appropriate, password hashes through Werkzeug, expiring server-side sessions, CSRF and login rate limits. Add users, sessions and audit schema migrations plus an owner-init command prompting securely for its password. Enforce ownership on every private read/write/download and fail closed when product setup is incomplete. Existing learner or admin identities must use this same boundary. - Serve app:app with Waitress on loopback behind Caddy HTTPS. Configure trusted proxy headers narrowly, Secure/HttpOnly/SameSite cookies, upload limits, request ids and structured logs without private content. Run background jobs as a separate supervised process when the domain workflow requires them. Commands, after creating the named files: `waitress-serve --listen=127.0.0.1:5000 app:app`. - Add a scheduled encrypted off-host backup using this procedure: Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for scribe. Monitor health, disk space, failed jobs and backup age. Stop the service to test an alert; rehearse recovery with outbound effects disabled and record recovery time. Rotate any exposed credentials and require reconciliation before resuming queues. - Trap: Product mode is additional engineering, not a switch that makes a local prototype production-ready. Done when: An unauthenticated visitor cannot read private records, download private files or mutate the admin surface. A viewer cannot mutate data by making a direct request, and guessed ids cannot cross ownership boundaries. Stopping the service triggers the configured alert and the latest off-host backup restores the fixture in isolation. Do not build yet: Do not add new providers or vendor-scale features until the release gates are recorded. ### Out of scope (and why) - Interactive replay, video generation and cross-application recording are outside this guide builder. - This is an explicit screenshot-to-guide editor with a small browser capture helper; full Scribe feature parity, vendor hosting and support are not included. - automatic capture quality, redaction, team libraries, integrations, and sharing: retain the paid product if this capability is essential; it is outside this bounded build. - instant hosted sharing: retain the paid product if this capability is essential; it is outside this bounded build. - viewer analytics: retain the paid product if this capability is essential; it is outside this bounded build. - team libraries: retain the paid product if this capability is essential; it is outside this bounded build. - cross-device capture: retain the paid product if this capability is essential; it is outside this bounded build. ### README must contain - Exact install, configure, initialize, start, test and recovery commands for a clean folder. - The schema, fixture, acceptance results, private data locations and export format. - Every prerequisite and secret source, actual running costs and deliberately excluded capabilities. - An honest distinction between tests actually run and checks still awaiting real credentials or deployment. - Dependency documentation reviewed 2026-09-05: https://flask.palletsprojects.com/en/stable/installation/ ; https://docs.python.org/3/library/sqlite3.html ; https://flask-wtf.readthedocs.io/en/1.2.x/csrf/ ; https://docs.pylonsproject.org/projects/waitress/en/stable/usage.html ; https://developer.chrome.com/docs/extensions/develop/concepts/activeTab. Recheck before upgrading; freeze the versions actually tested.
AGENTS.md
# Agent instructions · Scribe indie build - Read `README.md` and `BUILD_PLAN.md` before writing code. The stack is fixed: Python 3.12+ and Flask, SQLite through Python sqlite3, Jinja HTML templates, CSS and vanilla JavaScript, Python unittest and browser acceptance fixtures, Pillow. Do not substitute. - Work one phase at a time, in order. Do not start a phase until every "Done when" item of the previous one passes. - Prefer the fewest moving parts that satisfy the step. No frameworks, services or dependencies the plan does not name. - Secrets live in `.env`, never in source or logs. Keep `.env.example` current when a variable is introduced. - Do not invent cryptography, security guarantees, APIs or compliance claims. - Add a focused test for every destructive, security-sensitive or data-loss path the plan names. - Run the project checks before declaring a phase complete, and record any deliberate shortcut in the README under "Tradeoffs". ## Known traps - The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. - Do not record form values, keystrokes or passwords to generate instructions. - A CSS blur or annotation layer is not permanent redaction. - Interactive replay, video generation and cross-application recording are outside this guide builder. - Export without an import or restore rehearsal is not verified portability.
BUILD_PLAN.md
# Build plan · Scribe Build an explicit screenshot-to-guide editor with a small browser capture helper. Phases are in dependency order. Each ends in a "Done when" list; treat an unticked item as a blocker, not a note. ## Phase 1 · Local foundation and data contract Create the runnable local foundation for an explicit screenshot-to-guide editor with a small browser capture helper, including the real schema and acceptance fixture. ### Steps 1. Create and start the local application Run the venv command first, then stop and activate it before running the remaining commands. Use your OS instructions: Windows .venv\Scripts\activate.bat in cmd, or .venv\Scripts\Activate.ps1 in PowerShell; macOS/Linux source .venv/bin/activate. Then install the listed packages. Create app.py exposing app, load .env with python-dotenv, and add a /healthz route. Freeze tested dependency versions to requirements.txt. Create .env manually from .env.example; replace SECRET_KEY before launch. Files: `app.py`, `requirements.txt`, `.env.example`, `.gitignore` ```sh python -m venv .venv python -m pip install Flask Flask-WTF python-dotenv waitress tzdata Pillow python -m pip freeze > requirements.txt python -m flask --app app run --host 127.0.0.1 ``` 2. Implement storage and seed the named fixture For database-backed state create schema.sql and db.py using this model: guides(id,title); steps(id,guide_id,position,title,instruction,image_path); redactions(id,step_id,x,y,w,h); captures(id,guide_id,url,at,approved). Add the auxiliary relationships explicitly used in later phases; use stable ids, foreign keys, parameterized values and transactions. For canonical files use atomic replacement and hashes instead. Implement python manage.py init and python manage.py seed to create only synthetic data: A three-step dummy browser form containing a fake secret that must be redacted before export. Re-running init must not erase data. Files: `schema.sql`, `db.py`, `manage.py`, `fixtures/README.md` ```sh python manage.py init python manage.py seed ``` 3. Protect the local request boundary Install Flask-WTF CSRF protection for forms and same-origin fetches, validate Host and Origin against SITE_URL, bound inputs and escape output. Deliberately public intake endpoints get bounded validation and rate limits; signed provider webhooks use signature checks instead of browser CSRF tokens. All other admin routes stay local until product authentication exists. When a later phase tests viewer/member permissions, implement the users, hashed passwords, expiring server sessions and role checks in this foundation first; product mode must never use a fabricated identity from request input. Add error, empty, keyboard-focus and retry states now. Files: `app.py`, `templates/base.html`, `test/test_foundation.py` ### Done when - [ ] The documented start command serves /healthz and the initial screen at http://127.0.0.1:5000. - [ ] Restarting preserves the seeded records or canonical files; running init again deletes nothing. - [ ] A cross-origin state-changing request to an admin route is refused. ### Watch out - The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. ## Phase 2 · User-triggered capture User-triggered capture for Scribe: Build a Chromium extension with activeTab and a toolbar action that captures only after a user click. ### Steps 1. Build a Chromium extension with activeTab and a toolbar action that captures only after a user click. Build a Chromium extension with activeTab and a toolbar action that captures only after a user click. Files: `features/user_triggered_capture.py`, `templates/user_triggered_capture.html` 2. Download a capture bundle for manual import into the local editor; include URL only after stripping query and fragment. Download a capture bundle for manual import into the local editor; include URL only after stripping query and fragment. Files: `features/user_triggered_capture.py` 3. Exercise the acceptance fixture Use A three-step dummy browser form containing a fake secret that must be redacted before export. Check: Opening a page without clicking Capture creates no screenshot. Then check: The extension requests no all-sites or background browsing permission. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_user_triggered_capture.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] Opening a page without clicking Capture creates no screenshot. - [ ] The extension requests no all-sites or background browsing permission. ### Watch out - Do not record form values, keystrokes or passwords to generate instructions. ## Phase 3 · Editable steps and redaction Editable steps and redaction for Scribe: Import captures as ordered steps with user-written instructions and keyboard reorder controls. ### Steps 1. Import captures as ordered steps with user-written instructions and keyboard reorder controls. Import captures as ordered steps with user-written instructions and keyboard reorder controls. Files: `features/editable_steps_and_redaction.py`, `templates/editable_steps_and_redaction.html` 2. Provide rectangle redaction baked into a new image; remove original secret-bearing pixels from the export asset. Provide rectangle redaction baked into a new image; remove original secret-bearing pixels from the export asset. Files: `features/editable_steps_and_redaction.py` 3. Exercise the acceptance fixture Use A three-step dummy browser form containing a fake secret that must be redacted before export. Check: Reordering changes step numbers while keeping images paired with their instructions. Then check: The exported image cannot reveal the fake secret by deleting an overlay. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_editable_steps_and_redaction.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] Reordering changes step numbers while keeping images paired with their instructions. - [ ] The exported image cannot reveal the fake secret by deleting an overlay. ### Watch out - A CSS blur or annotation layer is not permanent redaction. ## Phase 4 · Portable guide delivery Portable guide delivery for Scribe: Generate self-contained HTML with local images and print styles; export a Markdown plus assets bundle. ### Steps 1. Generate self-contained HTML with local images and print styles; export a Markdown plus assets bundle. Generate self-contained HTML with local images and print styles; export a Markdown plus assets bundle. Files: `features/portable_guide_delivery.py`, `templates/portable_guide_delivery.html` 2. Add a final review screen showing all screenshots, URLs and text before the user exports. Add a final review screen showing all screenshots, URLs and text before the user exports. Files: `features/portable_guide_delivery.py` 3. Exercise the acceptance fixture Use A three-step dummy browser form containing a fake secret that must be redacted before export. Check: The exported HTML opens offline with all three steps and images. Then check: No original unredacted capture is included in the share bundle. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_portable_guide_delivery.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] The exported HTML opens offline with all three steps and images. - [ ] No original unredacted capture is included in the share bundle. ### Watch out - Interactive replay, video generation and cross-application recording are outside this guide builder. ## Phase 5 · Portable delivery and clean-start proof Finish the Scribe replacement with a documented first-run path and a recoverable export. ### Steps 1. Write the user-facing runbook Document prerequisites, every configuration variable, data locations and the three domain workflows: User-triggered capture; Editable steps and redaction; Portable guide delivery. Include the exclusions, actual costs and source check date 2026-09-05. Commands shown earlier that reference project files are files the builder must implement before running them. Files: `README.md`, `.env.example` 2. Create and rehearse a recoverable backup Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for scribe. Restore into a separate empty directory or isolated deployment, with all outbound actions and schedules disabled. Recreate this proof: A three-step dummy browser form containing a fake secret that must be redacted before export. Compare ids/counts and open the result before recording the restore date. Never test a restore over the only live copy. Files: `OPERATIONS.md`, `scripts/backup.py` 3. Reproduce the first-run experience Use a new folder and only README instructions to reach the fixture outcome. Install from requirements.txt, initialize storage, run the tests and exercise the UI at 375px and 1280px; use keyboard-only controls and inspect browser errors. Record exactly what passed; do not mark unrun checks complete. Files: `README.md`, `verification.md` ```sh python -m pip install -r requirements.txt python -m unittest discover -s test ``` ### Done when - [ ] A new folder reaches the documented fixture outcome using only README instructions. - [ ] A backup restored in isolation preserves the proof data and can be opened. ### Watch out - Export without an import or restore rehearsal is not verified portability. ## Not in this build - Interactive replay, video generation and cross-application recording are outside this guide builder. - This is an explicit screenshot-to-guide editor with a small browser capture helper; full Scribe feature parity, vendor hosting and support are not included. - automatic capture quality, redaction, team libraries, integrations, and sharing - instant hosted sharing - viewer analytics - team libraries - cross-device capture ## After v1, if you want it - Extend portable guide delivery only after the fixture and recovery checks pass. - Before adding another integration, document its credentials, limits, cost and failure behavior with primary-source links.
.env.example
# Copy to .env and fill in. Never commit .env; this file documents it. # Required. A new private folder this application creates on first run; never serve it as static files. DATA_DIR=./data/scribe # Required · secret. Generate with python -c "import secrets; print(secrets.token_hex(32))" and save only in .env. SECRET_KEY=replace-with-a-random-secret # Required. Use indie for loopback-only personal work. Product mode must refuse to start until owner login and the deployment gates are configured. APP_MODE=indie # Required. The origin used for local forms and links; replace with the chosen HTTPS origin in product mode. SITE_URL=http://127.0.0.1:5000
PRODUCT.md
# Scribe · product brief ## Problem The core loop is buildable, but a dependable replacement becomes a real weekend or multi-day project. For Scribe, capture a browser workflow and produce editable step-by-step documentation. The hard boundary is automatic capture quality, redaction, team libraries, integrations, and sharing, plus capture polish, hosting, and collaboration. ## Product outcome An operated version of an explicit screenshot-to-guide editor with a small browser capture helper, with authorized access, restore evidence and honest scope limits. ## Target user A builder who needs a maintainable product foundation, not a one-off demo. ## Required capabilities - macOS or Windows screen-recording permission - microphone permission - ffmpeg - local disk space ## Explicit non-goals for v1 - Interactive replay, video generation and cross-application recording are outside this guide builder. - This is an explicit screenshot-to-guide editor with a small browser capture helper; full Scribe feature parity, vendor hosting and support are not included. - automatic capture quality, redaction, team libraries, integrations, and sharing - instant hosted sharing - viewer analytics - team libraries - cross-device capture ## Success criteria - Opening a page without clicking Capture creates no screenshot. - Reordering changes step numbers while keeping images paired with their instructions. - The exported HTML opens offline with all three steps and images. - A private-data authorization check passes using a second identity. - An off-host restore drill has a date, observed result and recovery time in OPERATIONS.md. - README names the excluded vendor capabilities and actual provider/hosting costs.
BRIEF.md
# Build brief · Scribe The one-shot brief this plan expands. `BUILD_PLAN.md` (or `MILESTONES.md`) is the same sequence broken into steps and checks; where the two disagree, the plan wins. Build me an explicit screenshot-to-guide editor with a small browser capture helper as a bounded replacement for Scribe. Build it in phases in the order below. Do not write the whole product in one pass. Finish the current phase, run its Done when checks, fix failures, then continue. Indie mode completes Phases 1-5. Phase 6 is required before shared or public deployment. ### Stack (fixed, do not substitute) - Runtime: Python 3.12+ and Flask. A small local HTTP application with readable server-side handlers and no JavaScript build pipeline. - Storage: SQLite through Python sqlite3. Local ownership with explicit transactions and a portable backup path. - Interface: Jinja HTML templates, CSS and vanilla JavaScript. Implement the specified screens directly with labelled controls and progressive enhancement. - Verification: Python unittest and browser acceptance fixtures. Check invariants and the actual user workflow before the next phase. - Focused libraries: Pillow. Use these only for the specific file, parsing or provider operations named in the phases; freeze tested versions. ### Data model (create this before Phase 1) - guides(id,title) - steps(id,guide_id,position,title,instruction,image_path) - redactions(id,step_id,x,y,w,h) - captures(id,guide_id,url,at,approved) - Use stable ids and explicit relationships; add auxiliary tables named by the phases before those phases use them. - Acceptance fixture: A three-step dummy browser form containing a fake secret that must be redacted before export. ### Prerequisites and configuration - Python 3.12 or newer and a terminal: Install Python from python.org. Open a terminal in a new empty project folder. On Windows, use py -3 where this guide says python if python is not on PATH; on macOS/Linux use python3 if needed. Create .venv and activate it before installing packages. Verify: python --version reports 3.12+ and python -c "import sqlite3" succeeds. Cost: Python is free; this local prototype requires no hosting subscription. - A current desktop browser and text editor: Use an installed Chrome, Firefox or Edge browser. Open the empty project folder in your editor; open the terminal there, not in this catalog repository. Verify: You can create a text file in the project folder and open browser developer tools. Cost: No paid service required for this local step. - Scribe acceptance sample: Create synthetic sample data before implementation: A three-step dummy browser form containing a fake secret that must be redacted before export. Save it under fixtures/ with the expected results in fixtures/README.md; use no real credentials or customer records. Verify: The fixture files and expected outcomes exist and can be inspected without a vendor account. Cost: No paid service required for this local step. - Confirm the bounded replacement: The deliverable is an explicit screenshot-to-guide editor with a small browser capture helper. Read every exclusion below. Indie mode runs locally; any public or shared use requires the product access and deployment gates first. Verify: You can name the primary workflow and the vendor features this version deliberately leaves out. Cost: No paid service required for this local step. - Chromium extension development mode: Open chrome://extensions, enable Developer mode and use Load unpacked on the generated extension/ folder. Use only dummy pages for the first captures. Verify: The toolbar action captures the active dummy tab after a deliberate click. Cost: No paid account required. - Configuration: DATA_DIR, SECRET_KEY, APP_MODE, SITE_URL. Ship .env.example, replace placeholders and exclude secrets from git. ### Phase 1 · Local foundation and data contract Build: Create the runnable local foundation for an explicit screenshot-to-guide editor with a small browser capture helper, including the real schema and acceptance fixture. - Run the venv command first, then stop and activate it before running the remaining commands. Use your OS instructions: Windows .venv\Scripts\activate.bat in cmd, or .venv\Scripts\Activate.ps1 in PowerShell; macOS/Linux source .venv/bin/activate. Then install the listed packages. Create app.py exposing app, load .env with python-dotenv, and add a /healthz route. Freeze tested dependency versions to requirements.txt. Create .env manually from .env.example; replace SECRET_KEY before launch. Commands, after creating the named files: `python -m venv .venv`; `python -m pip install Flask Flask-WTF python-dotenv waitress tzdata Pillow`; `python -m pip freeze > requirements.txt`; `python -m flask --app app run --host 127.0.0.1`. - For database-backed state create schema.sql and db.py using this model: guides(id,title); steps(id,guide_id,position,title,instruction,image_path); redactions(id,step_id,x,y,w,h); captures(id,guide_id,url,at,approved). Add the auxiliary relationships explicitly used in later phases; use stable ids, foreign keys, parameterized values and transactions. For canonical files use atomic replacement and hashes instead. Implement python manage.py init and python manage.py seed to create only synthetic data: A three-step dummy browser form containing a fake secret that must be redacted before export. Re-running init must not erase data. Commands, after creating the named files: `python manage.py init`; `python manage.py seed`. - Install Flask-WTF CSRF protection for forms and same-origin fetches, validate Host and Origin against SITE_URL, bound inputs and escape output. Deliberately public intake endpoints get bounded validation and rate limits; signed provider webhooks use signature checks instead of browser CSRF tokens. All other admin routes stay local until product authentication exists. When a later phase tests viewer/member permissions, implement the users, hashed passwords, expiring server sessions and role checks in this foundation first; product mode must never use a fabricated identity from request input. Add error, empty, keyboard-focus and retry states now. - Trap: The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. Done when: The documented start command serves /healthz and the initial screen at http://127.0.0.1:5000. Restarting preserves the seeded records or canonical files; running init again deletes nothing. A cross-origin state-changing request to an admin route is refused. Do not build yet: Do not start user-triggered capture until these checks pass. ### Phase 2 · User-triggered capture Build: User-triggered capture for Scribe: Build a Chromium extension with activeTab and a toolbar action that captures only after a user click. - Build a Chromium extension with activeTab and a toolbar action that captures only after a user click. - Download a capture bundle for manual import into the local editor; include URL only after stripping query and fragment. - Use A three-step dummy browser form containing a fake secret that must be redacted before export. Check: Opening a page without clicking Capture creates no screenshot. Then check: The extension requests no all-sites or background browsing permission. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: Do not record form values, keystrokes or passwords to generate instructions. Done when: Opening a page without clicking Capture creates no screenshot. The extension requests no all-sites or background browsing permission. Do not build yet: Do not start editable steps and redaction until these checks pass. ### Phase 3 · Editable steps and redaction Build: Editable steps and redaction for Scribe: Import captures as ordered steps with user-written instructions and keyboard reorder controls. - Import captures as ordered steps with user-written instructions and keyboard reorder controls. - Provide rectangle redaction baked into a new image; remove original secret-bearing pixels from the export asset. - Use A three-step dummy browser form containing a fake secret that must be redacted before export. Check: Reordering changes step numbers while keeping images paired with their instructions. Then check: The exported image cannot reveal the fake secret by deleting an overlay. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: A CSS blur or annotation layer is not permanent redaction. Done when: Reordering changes step numbers while keeping images paired with their instructions. The exported image cannot reveal the fake secret by deleting an overlay. Do not build yet: Do not start portable guide delivery until these checks pass. ### Phase 4 · Portable guide delivery Build: Portable guide delivery for Scribe: Generate self-contained HTML with local images and print styles; export a Markdown plus assets bundle. - Generate self-contained HTML with local images and print styles; export a Markdown plus assets bundle. - Add a final review screen showing all screenshots, URLs and text before the user exports. - Use A three-step dummy browser form containing a fake secret that must be redacted before export. Check: The exported HTML opens offline with all three steps and images. Then check: No original unredacted capture is included in the share bundle. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Commands, after creating the named files: `python -m unittest discover -s test`. - Trap: Interactive replay, video generation and cross-application recording are outside this guide builder. Done when: The exported HTML opens offline with all three steps and images. No original unredacted capture is included in the share bundle. Do not build yet: Do not start portable delivery and clean-start proof until these checks pass. ### Phase 5 · Portable delivery and clean-start proof Build: Finish the Scribe replacement with a documented first-run path and a recoverable export. - Document prerequisites, every configuration variable, data locations and the three domain workflows: User-triggered capture; Editable steps and redaction; Portable guide delivery. Include the exclusions, actual costs and source check date 2026-09-05. Commands shown earlier that reference project files are files the builder must implement before running them. - Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for scribe. Restore into a separate empty directory or isolated deployment, with all outbound actions and schedules disabled. Recreate this proof: A three-step dummy browser form containing a fake secret that must be redacted before export. Compare ids/counts and open the result before recording the restore date. Never test a restore over the only live copy. - Use a new folder and only README instructions to reach the fixture outcome. Install from requirements.txt, initialize storage, run the tests and exercise the UI at 375px and 1280px; use keyboard-only controls and inspect browser errors. Record exactly what passed; do not mark unrun checks complete. Commands, after creating the named files: `python -m pip install -r requirements.txt`; `python -m unittest discover -s test`. - Trap: Export without an import or restore rehearsal is not verified portability. Done when: A new folder reaches the documented fixture outcome using only README instructions. A backup restored in isolation preserves the proof data and can be opened. Do not build yet: Do not start operate and share with access controls until these checks pass. ### Phase 6 · Operate and share with access controls (product-builder only) Build: Product-builder only: make an explicit screenshot-to-guide editor with a small browser capture helper operable for its stated audience before allowing remote access. - Add owner/member/viewer authorization as appropriate, password hashes through Werkzeug, expiring server-side sessions, CSRF and login rate limits. Add users, sessions and audit schema migrations plus an owner-init command prompting securely for its password. Enforce ownership on every private read/write/download and fail closed when product setup is incomplete. Existing learner or admin identities must use this same boundary. - Serve app:app with Waitress on loopback behind Caddy HTTPS. Configure trusted proxy headers narrowly, Secure/HttpOnly/SameSite cookies, upload limits, request ids and structured logs without private content. Run background jobs as a separate supervised process when the domain workflow requires them. Commands, after creating the named files: `waitress-serve --listen=127.0.0.1:5000 app:app`. - Add a scheduled encrypted off-host backup using this procedure: Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for scribe. Monitor health, disk space, failed jobs and backup age. Stop the service to test an alert; rehearse recovery with outbound effects disabled and record recovery time. Rotate any exposed credentials and require reconciliation before resuming queues. - Trap: Product mode is additional engineering, not a switch that makes a local prototype production-ready. Done when: An unauthenticated visitor cannot read private records, download private files or mutate the admin surface. A viewer cannot mutate data by making a direct request, and guessed ids cannot cross ownership boundaries. Stopping the service triggers the configured alert and the latest off-host backup restores the fixture in isolation. Do not build yet: Do not add new providers or vendor-scale features until the release gates are recorded. ### Out of scope (and why) - Interactive replay, video generation and cross-application recording are outside this guide builder. - This is an explicit screenshot-to-guide editor with a small browser capture helper; full Scribe feature parity, vendor hosting and support are not included. - automatic capture quality, redaction, team libraries, integrations, and sharing: retain the paid product if this capability is essential; it is outside this bounded build. - instant hosted sharing: retain the paid product if this capability is essential; it is outside this bounded build. - viewer analytics: retain the paid product if this capability is essential; it is outside this bounded build. - team libraries: retain the paid product if this capability is essential; it is outside this bounded build. - cross-device capture: retain the paid product if this capability is essential; it is outside this bounded build. ### README must contain - Exact install, configure, initialize, start, test and recovery commands for a clean folder. - The schema, fixture, acceptance results, private data locations and export format. - Every prerequisite and secret source, actual running costs and deliberately excluded capabilities. - An honest distinction between tests actually run and checks still awaiting real credentials or deployment. - Dependency documentation reviewed 2026-09-05: https://flask.palletsprojects.com/en/stable/installation/ ; https://docs.python.org/3/library/sqlite3.html ; https://flask-wtf.readthedocs.io/en/1.2.x/csrf/ ; https://docs.pylonsproject.org/projects/waitress/en/stable/usage.html ; https://developer.chrome.com/docs/extensions/develop/concepts/activeTab. Recheck before upgrading; freeze the versions actually tested.
ARCHITECTURE.md
# Architecture · Scribe ## Stack | Part | Choice | Why | | --- | --- | --- | | Runtime | Python 3.12+ and Flask | A small local HTTP application with readable server-side handlers and no JavaScript build pipeline. | | Storage | SQLite through Python sqlite3 | Local ownership with explicit transactions and a portable backup path. | | Interface | Jinja HTML templates, CSS and vanilla JavaScript | Implement the specified screens directly with labelled controls and progressive enhancement. | | Verification | Python unittest and browser acceptance fixtures | Check invariants and the actual user workflow before the next phase. | | Focused libraries | Pillow | Use these only for the specific file, parsing or provider operations named in the phases; freeze tested versions. | ## Modules Each module has one owner concern and a documented way to replace it. | Module | Owns | How to replace it | | --- | --- | --- | | Data and identity | guides(id,title); steps(id,guide_id,position,title,instruction,image_path); redactions(id,step_id,x,y,w,h); captures(id,guide_id,url,at,approved) | Keep stable ids and a versioned repository interface; migrate storage behind it with a fixture round-trip. | | User-triggered capture | Build a Chromium extension with activeTab and a toolbar action that captures only after a user click. | Keep the acceptance contract: Opening a page without clicking Capture creates no screenshot. Replace only this module after replaying its fixture; preserve ids and existing records. | | Editable steps and redaction | Import captures as ordered steps with user-written instructions and keyboard reorder controls. | Keep the acceptance contract: Reordering changes step numbers while keeping images paired with their instructions. Replace only this module after replaying its fixture; preserve ids and existing records. | | Portable guide delivery | Generate self-contained HTML with local images and print styles; export a Markdown plus assets bundle. | Keep the acceptance contract: The exported HTML opens offline with all three steps and images. Replace only this module after replaying its fixture; preserve ids and existing records. | | Operations | Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for scribe. | Change host or backup destination only after an isolated restore and authorization check. | ## Configuration Every runtime setting is an environment variable documented in `.env.example`, validated at startup, with a safe local default wherever one exists. - `DATA_DIR` · required · A new private folder this application creates on first run; never serve it as static files. - `SECRET_KEY` · required, secret · Generate with python -c "import secrets; print(secrets.token_hex(32))" and save only in .env. - `APP_MODE` · required · Use indie for loopback-only personal work. Product mode must refuse to start until owner login and the deployment gates are configured. - `SITE_URL` · required · The origin used for local forms and links; replace with the chosen HTTPS origin in product mode. ## Production baseline - Security: least privilege, input validation at every boundary, secret redaction in logs, rate limits on abuse-prone paths, no invented security primitives. - Data: explicit schema and migrations, transactional writes where integrity matters, backup and restore procedures that have been exercised. - Integrations: adapters around third-party providers, idempotent webhook or job processing, bounded retries, timeouts. - Observability: structured logs with request or operation ids, an error-tracking hook, and health and readiness checks where a server exists. - Quality: unit tests for domain rules, integration tests at module boundaries, one end-to-end test of the critical path. ## Decision records For each dependency in the stack table, keep a short note: why it was chosen, its failure mode, and how it is replaced. Do not add infrastructure until a requirement in `PRODUCT.md` justifies it.
AGENTS.md
# Agent instructions · Scribe product build - Read `PRODUCT.md` and `ARCHITECTURE.md` before changing code. The stack is fixed: Python 3.12+ and Flask, SQLite through Python sqlite3, Jinja HTML templates, CSS and vanilla JavaScript, Python unittest and browser acceptance fixtures, Pillow. - Implement milestone by milestone from `MILESTONES.md`; keep each change reviewable and leave the application runnable at every commit. - Treat authentication, payments, encryption, imports, webhooks and destructive actions as high-risk boundaries when present. - Never invent cryptography or silently weaken a requirement to make a check pass. - Put every external service behind an interface with a deterministic fake for tests. - Add migrations and rollback or recovery notes for every persistent data change. - Log useful operational context without credentials, tokens, passwords or personal data. - Update documentation and run every check before completing a milestone. ## Known traps - The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. - Do not record form values, keystrokes or passwords to generate instructions. - A CSS blur or annotation layer is not permanent redaction. - Interactive replay, video generation and cross-application recording are outside this guide builder. - Export without an import or restore rehearsal is not verified portability. - Product mode is additional engineering, not a switch that makes a local prototype production-ready.
MILESTONES.md
# Delivery milestones · Scribe Estimated effort: **multi-day** for the indie phases; the production-only milestones add the trust and operability layer. ## M1 · Local foundation and data contract Create the runnable local foundation for an explicit screenshot-to-guide editor with a small browser capture helper, including the real schema and acceptance fixture. ### Steps 1. Create and start the local application Run the venv command first, then stop and activate it before running the remaining commands. Use your OS instructions: Windows .venv\Scripts\activate.bat in cmd, or .venv\Scripts\Activate.ps1 in PowerShell; macOS/Linux source .venv/bin/activate. Then install the listed packages. Create app.py exposing app, load .env with python-dotenv, and add a /healthz route. Freeze tested dependency versions to requirements.txt. Create .env manually from .env.example; replace SECRET_KEY before launch. Files: `app.py`, `requirements.txt`, `.env.example`, `.gitignore` ```sh python -m venv .venv python -m pip install Flask Flask-WTF python-dotenv waitress tzdata Pillow python -m pip freeze > requirements.txt python -m flask --app app run --host 127.0.0.1 ``` 2. Implement storage and seed the named fixture For database-backed state create schema.sql and db.py using this model: guides(id,title); steps(id,guide_id,position,title,instruction,image_path); redactions(id,step_id,x,y,w,h); captures(id,guide_id,url,at,approved). Add the auxiliary relationships explicitly used in later phases; use stable ids, foreign keys, parameterized values and transactions. For canonical files use atomic replacement and hashes instead. Implement python manage.py init and python manage.py seed to create only synthetic data: A three-step dummy browser form containing a fake secret that must be redacted before export. Re-running init must not erase data. Files: `schema.sql`, `db.py`, `manage.py`, `fixtures/README.md` ```sh python manage.py init python manage.py seed ``` 3. Protect the local request boundary Install Flask-WTF CSRF protection for forms and same-origin fetches, validate Host and Origin against SITE_URL, bound inputs and escape output. Deliberately public intake endpoints get bounded validation and rate limits; signed provider webhooks use signature checks instead of browser CSRF tokens. All other admin routes stay local until product authentication exists. When a later phase tests viewer/member permissions, implement the users, hashed passwords, expiring server sessions and role checks in this foundation first; product mode must never use a fabricated identity from request input. Add error, empty, keyboard-focus and retry states now. Files: `app.py`, `templates/base.html`, `test/test_foundation.py` ### Done when - [ ] The documented start command serves /healthz and the initial screen at http://127.0.0.1:5000. - [ ] Restarting preserves the seeded records or canonical files; running init again deletes nothing. - [ ] A cross-origin state-changing request to an admin route is refused. ### Watch out - The Flask development server is for local development only. Loopback binding alone does not replace CSRF and origin validation. ## M2 · User-triggered capture User-triggered capture for Scribe: Build a Chromium extension with activeTab and a toolbar action that captures only after a user click. ### Steps 1. Build a Chromium extension with activeTab and a toolbar action that captures only after a user click. Build a Chromium extension with activeTab and a toolbar action that captures only after a user click. Files: `features/user_triggered_capture.py`, `templates/user_triggered_capture.html` 2. Download a capture bundle for manual import into the local editor; include URL only after stripping query and fragment. Download a capture bundle for manual import into the local editor; include URL only after stripping query and fragment. Files: `features/user_triggered_capture.py` 3. Exercise the acceptance fixture Use A three-step dummy browser form containing a fake secret that must be redacted before export. Check: Opening a page without clicking Capture creates no screenshot. Then check: The extension requests no all-sites or background browsing permission. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_user_triggered_capture.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] Opening a page without clicking Capture creates no screenshot. - [ ] The extension requests no all-sites or background browsing permission. ### Watch out - Do not record form values, keystrokes or passwords to generate instructions. ## M3 · Editable steps and redaction Editable steps and redaction for Scribe: Import captures as ordered steps with user-written instructions and keyboard reorder controls. ### Steps 1. Import captures as ordered steps with user-written instructions and keyboard reorder controls. Import captures as ordered steps with user-written instructions and keyboard reorder controls. Files: `features/editable_steps_and_redaction.py`, `templates/editable_steps_and_redaction.html` 2. Provide rectangle redaction baked into a new image; remove original secret-bearing pixels from the export asset. Provide rectangle redaction baked into a new image; remove original secret-bearing pixels from the export asset. Files: `features/editable_steps_and_redaction.py` 3. Exercise the acceptance fixture Use A three-step dummy browser form containing a fake secret that must be redacted before export. Check: Reordering changes step numbers while keeping images paired with their instructions. Then check: The exported image cannot reveal the fake secret by deleting an overlay. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_editable_steps_and_redaction.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] Reordering changes step numbers while keeping images paired with their instructions. - [ ] The exported image cannot reveal the fake secret by deleting an overlay. ### Watch out - A CSS blur or annotation layer is not permanent redaction. ## M4 · Portable guide delivery Portable guide delivery for Scribe: Generate self-contained HTML with local images and print styles; export a Markdown plus assets bundle. ### Steps 1. Generate self-contained HTML with local images and print styles; export a Markdown plus assets bundle. Generate self-contained HTML with local images and print styles; export a Markdown plus assets bundle. Files: `features/portable_guide_delivery.py`, `templates/portable_guide_delivery.html` 2. Add a final review screen showing all screenshots, URLs and text before the user exports. Add a final review screen showing all screenshots, URLs and text before the user exports. Files: `features/portable_guide_delivery.py` 3. Exercise the acceptance fixture Use A three-step dummy browser form containing a fake secret that must be redacted before export. Check: The exported HTML opens offline with all three steps and images. Then check: No original unredacted capture is included in the share bundle. Add a focused regression for the failure case under test/ using a temporary database or folder and fake external services; also perform the visible workflow in a browser. Files: `test/test_portable_guide_delivery.py` ```sh python -m unittest discover -s test ``` ### Done when - [ ] The exported HTML opens offline with all three steps and images. - [ ] No original unredacted capture is included in the share bundle. ### Watch out - Interactive replay, video generation and cross-application recording are outside this guide builder. ## M5 · Portable delivery and clean-start proof Finish the Scribe replacement with a documented first-run path and a recoverable export. ### Steps 1. Write the user-facing runbook Document prerequisites, every configuration variable, data locations and the three domain workflows: User-triggered capture; Editable steps and redaction; Portable guide delivery. Include the exclusions, actual costs and source check date 2026-09-05. Commands shown earlier that reference project files are files the builder must implement before running them. Files: `README.md`, `.env.example` 2. Create and rehearse a recoverable backup Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for scribe. Restore into a separate empty directory or isolated deployment, with all outbound actions and schedules disabled. Recreate this proof: A three-step dummy browser form containing a fake secret that must be redacted before export. Compare ids/counts and open the result before recording the restore date. Never test a restore over the only live copy. Files: `OPERATIONS.md`, `scripts/backup.py` 3. Reproduce the first-run experience Use a new folder and only README instructions to reach the fixture outcome. Install from requirements.txt, initialize storage, run the tests and exercise the UI at 375px and 1280px; use keyboard-only controls and inspect browser errors. Record exactly what passed; do not mark unrun checks complete. Files: `README.md`, `verification.md` ```sh python -m pip install -r requirements.txt python -m unittest discover -s test ``` ### Done when - [ ] A new folder reaches the documented fixture outcome using only README instructions. - [ ] A backup restored in isolation preserves the proof data and can be opened. ### Watch out - Export without an import or restore rehearsal is not verified portability. ## M6 · Operate and share with access controls (production only) Product-builder only: make an explicit screenshot-to-guide editor with a small browser capture helper operable for its stated audience before allowing remote access. ### Steps 1. Establish owner access before exposure Add owner/member/viewer authorization as appropriate, password hashes through Werkzeug, expiring server-side sessions, CSRF and login rate limits. Add users, sessions and audit schema migrations plus an owner-init command prompting securely for its password. Enforce ownership on every private read/write/download and fail closed when product setup is incomplete. Existing learner or admin identities must use this same boundary. Files: `ARCHITECTURE.md`, `OPERATIONS.md` 2. Deploy a monitored service Serve app:app with Waitress on loopback behind Caddy HTTPS. Configure trusted proxy headers narrowly, Secure/HttpOnly/SameSite cookies, upload limits, request ids and structured logs without private content. Run background jobs as a separate supervised process when the domain workflow requires them. Files: `Caddyfile`, `OPERATIONS.md` ```sh waitress-serve --listen=127.0.0.1:5000 app:app ``` 3. Rehearse loss and recovery Add a scheduled encrypted off-host backup using this procedure: Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for scribe. Monitor health, disk space, failed jobs and backup age. Stop the service to test an alert; rehearse recovery with outbound effects disabled and record recovery time. Rotate any exposed credentials and require reconciliation before resuming queues. Files: `OPERATIONS.md`, `release-checklist.md` ### Done when - [ ] An unauthenticated visitor cannot read private records, download private files or mutate the admin surface. - [ ] A viewer cannot mutate data by making a direct request, and guessed ids cannot cross ownership boundaries. - [ ] Stopping the service triggers the configured alert and the latest off-host backup restores the fixture in isolation. ### Watch out - Product mode is additional engineering, not a switch that makes a local prototype production-ready.
OPERATIONS.md
# Operations · Scribe ## Backup Use sqlite3.Connection.backup for the database in DATA_DIR and pause writers while taking the matching attachment snapshot. Keep schema version, hashes and a manifest for scribe. ## Restore Restore into a separate empty directory or isolated deployment, with all outbound actions and schedules disabled. Recreate this proof: A three-step dummy browser form containing a fake secret that must be redacted before export. Compare ids/counts and open the result before recording the restore date. Never test a restore over the only live copy. Do a restore drill before the first real user, and write the date here when it passes. ## Monitoring Check HTTP availability, free disk, backup age and domain failures for User-triggered capture, Editable steps and redaction, Portable guide delivery. Alert without logging private payloads. ## Incident checklist Pause outbound jobs and public intake as appropriate, preserve redacted diagnostics, restore an isolated verified backup, rotate affected credentials and reconcile uncertain effects before reopening. 1. Contain the issue without destroying evidence or user data. 2. Record the timeline and affected scope. 3. Rotate exposed secrets and revoke compromised sessions or credentials. 4. Restore from a verified backup when needed. 5. Document the root cause, the remediation and the regression test. ## Release gate - [ ] Opening a page without clicking Capture creates no screenshot. - [ ] Reordering changes step numbers while keeping images paired with their instructions. - [ ] The exported HTML opens offline with all three steps and images. - [ ] A private-data authorization check passes using a second identity. - [ ] An off-host restore drill has a date, observed result and recovery time in OPERATIONS.md. - [ ] README names the excluded vendor capabilities and actual provider/hosting costs. ## Launch constraint Do not market omitted Scribe capabilities as implemented. The non-goals in `PRODUCT.md` remain user-visible limitations until they are deliberately delivered.
.env.example
# Copy to .env and fill in. Never commit .env; this file documents it. # Required. A new private folder this application creates on first run; never serve it as static files. DATA_DIR=./data/scribe # Required · secret. Generate with python -c "import secrets; print(secrets.token_hex(32))" and save only in .env. SECRET_KEY=replace-with-a-random-secret # Required. Use indie for loopback-only personal work. Product mode must refuse to start until owner login and the deployment gates are configured. APP_MODE=indie # Required. The origin used for local forms and links; replace with the chosen HTTPS origin in product mode. SITE_URL=http://127.0.0.1:5000
$ choose a build depth, inspect the files, then open the complete pack in your agent
People still pay for Scribe because the recording itself is easy; the subscription removes upload, transcoding, sharing, organization, and support work. The recurring cost buys OS permissions, codecs, rendering performance, uploads, storage, links, and viewer analytics, not just the visible interface.
xautomatic capture quality, redaction, team libraries, integrations, and sharing
xinstant hosted sharing
xviewer analytics
xteam libraries
xcross-device capture
share on X ↗"I just replaced Scribe ($35/mo) with one prompt"
Don't feel like building it? These folks already made it free.
MMimikScribe without the cloud: click through a workflow and get local, editable steps.open source↗no votes, no pay-to-list · just what's real
Scribe pricing
| plan | monthly | annual (per mo) | what you get |
|---|---|---|---|
| basic | $0/workspace | $0/workspace | Unlimited guides; browser capture; link sharing and embeds; 1-week version history; no desktop capture |
| pro personal | $35/user | $25/user | 1+ paid seat; desktop and browser capture; advanced export, editing and branding |
| pro team | $17/user | $13/user | Minimum 5 paid seats; team collaboration and management |
| enterprise | custom | — | Custom seats, security, administration, analytics and support |
free tierunlimited guides, browser capture, links/embeds and 1-week version history; no desktop capture
billingmonthly + annual (about 20% lower); plans apply to the whole team
hidden costsPro Team requires at least 5 paid seats; a workspace cannot mix free and paid members, so upgrading the team upgrades every billable user.
verified 2026-08-14 · source ↗
Vibecode Scribe
Kinda. The core of Scribe is buildable in a weekend with the prompt on this page, but there are real gaps: automatic capture quality, redaction, team libraries, integrations, and sharing, instant hosted sharing. Read the honest list above before committing.
How much does Scribe cost?
Scribe costs about $35/month (Pro Personal, checked 2026-08-14), which is $420 per year.
What do I lose by replacing Scribe?
Honestly: automatic capture quality, redaction, team libraries, integrations, and sharing; instant hosted sharing; viewer analytics; team libraries; cross-device capture. If any of those are load-bearing for you, keep paying.
Is there an open-source alternative to Scribe?
Yes: Mimik (Scribe without the cloud: click through a workflow and get local, editable steps.) The prompt is for when you want it exactly your way.