File structure
Every request is one .req.yaml file:
# products/list.req.yaml
method: GET
url: "https://api.example.com/products?page={{page}}"
headers:
- key: Accept
value: application/json
enabled: true
auth:
type: bearer
token: "{{token}}" Key order is stable (deterministic serializer), so git diffs are clean and human-readable.
Body sidecars
Payloads 4 KB or larger are automatically promoted to a sidecar file under
files/<slug>.body.<ext>. The .req.yaml references the sidecar by path.
This keeps YAML files small and diffs focused on metadata changes.
Workspace folder
Scrapeman writes only inside the workspace folder you choose. History, cookies, and state live in the app data directory, never the workspace. The workspace is safe to commit to git.
Per-request git sync toggle
Right-click a request in the sidebar and select "Stop syncing to git" to exclude it from
version control. Backed by .git/info/exclude (never pushed to remote). Shortcut:
Cmd+Shift+H on the active tab. A crossed-eye icon marks unsynced requests.