Markdown Converter
Agent skill for markdown-converter
A concise, agent-focused guide for working on this repo. Prefer these commands and conventions. Keep READMEs for humans; put build/test details here for agents.
Sign in to like and favorite skills
A concise, agent-focused guide for working on this repo. Prefer these commands and conventions. Keep READMEs for humans; put build/test details here for agents.
web/dist for tests/prod)reverseflow (editable install)pytest for backend; Vitest + Playwright for webdocker compose up --build (MITM: 8080, mitmweb: 8081, API: 8000, Dashboard: 3000)Repo structure (key paths)
src/reverseflow/ — API, engines, mitm addon, plugins, modelsweb/ — UI (Vite/React)tests/ — pytest suitescripts/ — tooling (static server for Playwright, smoke runner)Choose local dev, or Docker.
Python 3.11 recommended (>=3.9 supported). Node 18+.
Windows PowerShell:
python -m venv .venv.\.venv\Scripts\Activate.ps1pip install --upgrade pippip install -r requirements.txtpip install -e .npm cimacOS/Linux:
python -m venv .venv. .venv/bin/activatepip install --upgrade pippip install -r requirements.txtpip install -e .npm ciInitialize DB (once):
reverseflow init_dbreverseflow init_dbdocker compose up --build
Ports: 8080 (MITM), 8081 (mitmweb), 8000 (API), 3000 (dashboard).Start proxy + API + UI dev:
reverseflow devEndpoints
Mobile device
Run the smallest necessary scope first.
Backend (pytest):
pytest -qpytest tests/unit/test_rule_engine.py -qType checks & lint:
mypy src/reverseflow testsblack . --checkflake8Frontend unit (Vitest):
npm run test:unit:runFrontend E2E (Playwright):
npm run buildnpm run test:corenpm run test:pagesnpm run test:editorsnpm run test:accessibilitynpm run test:allPlaywright details
playwright.config.tsnode scripts/serve-static.js expects web/dist — run npm run build firsthttp://127.0.0.1:5176Smoke tests
npm run smokenpm run smoke:fullPython
.py files; do not add shebangs (no env/bin headers)TypeScript/React
npm run type-check for TSnpm run lint (ESLint)General
reverseflow start — start mitmproxy (+ optional API)reverseflow dev — proxy + API + Vite UI (dev)reverseflow init_db / reset_dbreverseflow stats, reverseflow list_plugins, reverseflow check_setupSee README “Configuration” for full table. Common vars (defaults in code):
MITM_PORT=8080, MITM_WEB_PORT=8081, API_PORT=8000DATABASE_URL=sqlite:///./reverseflow.dbAPI_CORS_ORIGINS=http://localhost:3000,http://localhost:5173PLUGINS_DIR=./plugins, ENABLED_PLUGINS=base_interceptorENABLE_PREMIUM_BYPASS=true, SAVE_RAW_TRAFFIC=truesrc/reverseflow/plugins/reverseflow dev and Plugin browserblack --check, flake8, mypy, pytest -q, npm run type-check, npm run test:unit:runnpm run build then Playwright subset (see above)ADMIN_TOKEN, SECRET_KEY)SAVE_RAW_TRAFFIC=false in sensitive environments/api+/wsnpm run build (creates web/dist)mitmdump not found? pip install mitmproxy, restart shell to refresh PATH&& — run commands on separate lines