Metadata-Version: 2.4
Name: clickcast
Version: 0.1.0
Summary: Drive a browser through a website and hand back a reel + AI-readable feedback sidecar.
Project-URL: Homepage, https://github.com/AlexKay28/clickcast
Project-URL: Issues, https://github.com/AlexKay28/clickcast/issues
Author: Alex Kay
License:                                  Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "[]"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
           Copyright [yyyy] [name of copyright owner]
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
License-File: LICENSE
Keywords: agent,ai,automation,browser,gif,playwright,screenshot
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Multimedia :: Graphics
Classifier: Topic :: Software Development :: Testing
Requires-Python: >=3.10
Requires-Dist: imageio[ffmpeg]>=2.34
Requires-Dist: pillow>=10.0
Requires-Dist: platformdirs>=4.2
Requires-Dist: playwright>=1.44
Requires-Dist: pydantic-settings>=2.3
Requires-Dist: pydantic>=2.7
Requires-Dist: pyyaml>=6.0
Requires-Dist: rich>=13.7
Requires-Dist: tomli>=2.0; python_version < '3.11'
Requires-Dist: typer>=0.12
Provides-Extra: dev
Requires-Dist: build>=1.0; extra == 'dev'
Requires-Dist: mypy>=1.10; extra == 'dev'
Requires-Dist: pre-commit>=3.7; extra == 'dev'
Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
Requires-Dist: pytest-cov>=5.0; extra == 'dev'
Requires-Dist: pytest>=8.0; extra == 'dev'
Requires-Dist: ruff>=0.5; extra == 'dev'
Requires-Dist: types-pyyaml; extra == 'dev'
Description-Content-Type: text/markdown

# 🎞️ clickcast

> Give AI agents visual + structured feedback about live web UIs — and give humans deterministic demo reels while you're at it.

[![PyPI version](https://img.shields.io/pypi/v/clickcast.svg)](https://pypi.org/project/clickcast/)
[![Python](https://img.shields.io/pypi/pyversions/clickcast.svg)](https://pypi.org/project/clickcast/)
[![CI](https://img.shields.io/github/actions/workflow/status/AlexKay28/clickcast/ci.yml?branch=main)](https://github.com/AlexKay28/clickcast/actions)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](./LICENSE)

![clickcast touring worldsight-weld.vercel.app](docs/demo.gif)

> **Not to be confused with [vercel-labs/webreel](https://github.com/vercel-labs/webreel)** — that's a TypeScript tool for authoring polished demo videos. `clickcast` is a Python tool aimed primarily at *AI agents* that need a visual modality onto a live web UI, and secondarily at humans who want reproducible demo reels.

`clickcast` drives a real browser through a website — clicking buttons, toggling views, switching
languages, scrolling, filling forms — and hands back **two things**:

1. A watchable **reel** (GIF / MP4 / WebP) with click ripples, cursor trails, and a progress bar.
2. A machine-readable **JSON sidecar** — every step, every discovered element, every console error,
   every failed request — so an AI agent can *reason* about what it just saw without watching the pixels.

Point it at a URL and it will *auto-discover* the interactive elements and build a tour for you,
or hand it a small YAML **scenario** for a scripted, repeatable walkthrough.

---

## Demo

```bash
clickcast auto https://worldsight-weld.vercel.app --out worldsight.gif
```

```
✔ Launching chromium (1280×800)
✔ Page loaded in 1.9s  ·  title: "WorldSight — World Metrics Map"
✔ Discovered 11 interactive elements
  → toggle 3D view          [button]
  → switch language ES      [button]
  → open Rankings           [link]
  → Compare countries       [button]
  ...
✔ Captured 42 frames
✔ Encoded worldsight.gif (2.3 MB, 18s, 12 fps)
```

<sub>The GIF above is regenerated by the [`demo` workflow](.github/workflows/demo.yml) — trigger it from the Actions tab, or run [`scripts/generate_demo.py`](scripts/generate_demo.py) locally.</sub>

**Prefer scripted tours?** Three example scenarios live in [`docs/scenarios/`](docs/scenarios/) (landing page, form submission, ARIA tab widget). They run against the built-in fixture site:

```bash
clickcast run docs/scenarios/spa.yml --var base_url=http://127.0.0.1:8000
```

**Wiring this into an AI agent?** See [`docs/ai-integration.md`](docs/ai-integration.md) for the two-line loop, and [`docs/feedback-schema.md`](docs/feedback-schema.md) for the JSON sidecar contract.

---

## Why clickcast

LLM agents today reason about web UIs almost entirely through DOM/HTML. That misses rendered
layout, visual state transitions, regressions that don't change the DOM but ruin the pixels, and
whether a click *appeared* to do anything. `clickcast` closes that gap by producing both a
video artifact and a structured JSON sidecar the agent can parse.

For humans, screen recorders are manual, non-reproducible, and go stale the moment your UI
changes. Existing browser-automation frameworks (Playwright, Selenium) *can* capture screenshots,
but you have to write and maintain glue code for framing, timing, annotation, and encoding every
time. `clickcast` collapses that into one tool with three modes:

| Mode | Command | When to use |
|------|---------|-------------|
| **Auto** | `clickcast auto <url>` | You want a quick visual tour and don't care about the exact script. |
| **Scenario** | `clickcast run tour.yml` | You want a precise, repeatable walkthrough (docs, release notes, CI). |
| **Shot** | `clickcast shot <url>` | You just need one clean, full-page screenshot. |

Everything is deterministic, headless-by-default, CI-friendly, and version-controllable.

---

## Features

- 🧠 **AI-feedback sidecar** — every run writes a versioned JSON report an agent can parse: steps, timings, discovered elements, per-step frames, console errors, failed requests.
- 🤖 **Auto-tour** — heuristically finds buttons, toggles, tabs, and links, then visits them in a sensible order.
- 📝 **Declarative scenarios** — describe a walkthrough in readable YAML; no Python required.
- 🎨 **Annotated output** — click ripples, action labels, cursor trails, and a progress bar (each toggleable).
- 🖼️ **Multiple formats** — `gif`, `mp4`, `webp`, or a raw `frames/` directory.
- 📱 **Device emulation** — desktop, mobile, tablet presets, or a custom viewport & device-scale-factor.
- ⏱️ **Frame control** — set fps, per-step dwell time, loop count, and easing between actions.
- 🌐 **SPA-aware** — waits for network idle and custom selectors so hydration finishes before capture.
- 🔁 **Reproducible** — same scenario + same site = same reel. Great for visual regression.
- 🧩 **Scriptable API** — use it as a Python library, not just a CLI.
- 🚦 **CI-ready** — runs headless in GitHub Actions; ships a reusable action.

---

## Install

```bash
# Recommended: isolated install
pipx install clickcast

# or plain pip
pip install clickcast

# one-time: fetch the browser binaries Playwright needs
clickcast install
```

`clickcast install` is a thin wrapper over `playwright install chromium` (add `--with-deps` on Linux
CI to pull system libraries). Firefox and WebKit are optional: `clickcast install firefox webkit`.

**Requirements:** Python ≥ 3.9. On Linux you'll need the usual headless-Chromium system deps
(handled by `--with-deps`).

---

## Quickstart

```bash
# 1. Auto-tour a site and save a GIF
clickcast auto https://example.com --out tour.gif

# 2. Scaffold a scenario you can edit
clickcast init tour.yml --url https://example.com

# 3. Run the scenario
clickcast run tour.yml

# 4. Grab a single full-page screenshot
clickcast shot https://example.com --full-page --out home.png
```

---

## Commands

### `clickcast auto <url>`

Discover interactive elements and build a tour automatically.

```bash
clickcast auto https://worldsight-weld.vercel.app \
  --out worldsight.gif \
  --max-steps 8 \
  --viewport 1280x800 \
  --fps 12 \
  --dwell 1.2 \
  --lang en
```

| Flag | Default | Description |
|------|---------|-------------|
| `--out PATH` | `reel.gif` | Output file; extension picks the format (`.gif`/`.mp4`/`.webp`). |
| `--max-steps N` | `10` | Cap on how many elements to visit. |
| `--include SELECTOR` | – | Only consider elements matching this CSS selector. |
| `--exclude SELECTOR` | – | Skip elements matching this selector (e.g. `footer a`). |
| `--order MODE` | `dom` | Visit order: `dom`, `visual` (top→bottom, left→right), or `random`. |
| `--dwell SEC` | `1.0` | Seconds to linger after each action. |
| `--scroll` | `on` | Auto-scroll targets into view before interacting. |
| `--dry-run` | – | Print the planned tour without recording. |

### `clickcast run <scenario.yml>`

Execute a declarative scenario (see [Scenario format](#scenario-format)).

```bash
clickcast run tour.yml --out release-notes.mp4 --format mp4 --loop 0
```

Useful flags: `--out`, `--format`, `--headful` (watch it run), `--slowmo MS`, `--var key=value`
(inject variables usable as `{{ key }}` inside the scenario).

### `clickcast shot <url>`

Capture a single screenshot.

```bash
clickcast shot https://example.com --full-page --wait "networkidle" --out home.png
```

Flags: `--full-page`, `--selector CSS` (screenshot just one element), `--wait`, `--viewport`,
`--device`, `--dark` (emulate `prefers-color-scheme: dark`).

### `clickcast init [file]`

Scaffold a starter scenario file, optionally pre-seeded by auto-discovering a URL.

```bash
clickcast init tour.yml --url https://example.com --from-auto
```

`--from-auto` runs discovery once and writes the found steps into the file so you can trim/edit
instead of starting blank.

### `clickcast elements <url>`

Dump the interactive elements clickcast can see — handy for authoring selectors.

```bash
clickcast elements https://example.com --interactive --json > elements.json
```

### `clickcast doctor`

Diagnose the environment: Python version, installed browser engines, ffmpeg availability, and
whether the sandbox can reach the network.

```bash
clickcast doctor
```

### `clickcast config`

Read/write persistent defaults (see [Configuration](#configuration)).

```bash
clickcast config set defaults.viewport 1440x900
clickcast config get defaults.viewport
clickcast config path
```

---

## Scenario format

Scenarios are plain YAML. A scenario is a list of **steps**; each step is one **action**.

```yaml
# tour.yml
meta:
  name: WorldSight broad tour
  engine: chromium          # chromium | firefox | webkit
  viewport: 1280x800
  device: null              # or "iPhone 15", "Pixel 8", "iPad Pro"
  fps: 12
  dwell: 1.0                # default seconds after each step
  format: gif               # gif | mp4 | webp | frames
  out: worldsight.gif
  annotate:
    clicks: true
    labels: true
    cursor: true
    progress: true
    watermark: false

steps:
  - goto: https://worldsight-weld.vercel.app
    wait: networkidle
    label: "Open WorldSight"

  - click: "text=3D"
    label: "Switch to 3D globe"
    dwell: 2.0

  - hover: "[aria-label='Rankings']"
  - click: "[aria-label='Rankings']"
    label: "Open Rankings"

  - click: "text=Español"
    label: "Switch language → ES"

  - scroll: { to: "footer", behavior: smooth }
  - screenshot: { full_page: false }
```

### Supported actions

| Action | Example | Notes |
|--------|---------|-------|
| `goto` | `goto: https://…` | Navigate; pair with `wait`. |
| `click` | `click: "text=Compare"` | CSS or Playwright text selector. |
| `dblclick` | `dblclick: ".cell"` | Double click. |
| `hover` | `hover: ".menu"` | Reveal hover states/tooltips. |
| `type` | `type: { into: "#search", text: "Japan" }` | Types into a field. |
| `press` | `press: "Enter"` | Keyboard key. |
| `select` | `select: { in: "#metric", value: "GDP" }` | Dropdowns. |
| `scroll` | `scroll: { to: "footer" }` or `scroll: { by: 600 }` | Element or pixel scroll. |
| `wait` | `wait: 1.5` or `wait: networkidle` or `wait: ".map-loaded"` | Time, load-state, or selector. |
| `screenshot` | `screenshot: { full_page: true }` | Force a frame capture. |
| `label` | `label: "Human-readable caption"` | Overlay caption for that step. |

Any step also accepts `dwell`, `optional: true` (don't fail the run if the selector is missing),
and `repeat: N`.

---

## Configuration

Precedence (highest first): **CLI flags → scenario `meta:` → project `clickcast.toml` → user config → built-in defaults.**

```toml
# clickcast.toml (project-local)
[defaults]
engine   = "chromium"
viewport = "1280x800"
fps      = 12
dwell    = 1.0
format   = "gif"

[annotate]
clicks   = true
labels   = true
progress = true
watermark = false

[network]
# extra headers, basic-auth, or a proxy for reaching internal sites
proxy = ""
```

Environment overrides: `CLICKCAST_ENGINE`, `CLICKCAST_VIEWPORT`, `CLICKCAST_HEADFUL`, `CLICKCAST_PROXY`.

---

## Output formats

| Format | Best for | Notes |
|--------|----------|-------|
| `gif` | READMEs, chat, quick shares | Widest compatibility; larger files. |
| `mp4` | Docs sites, social, long tours | Smallest for length; needs `ffmpeg`. |
| `webp` | Web embedding | Great size/quality; animated. |
| `frames` | Custom pipelines | Writes numbered PNGs to a directory. |

`--quality 1..30` trades size for fidelity (lower = better). `--loop 0` loops forever; `--loop 1`
plays once.

---

## Recipes

**Keep your README demo fresh in CI**

```yaml
# .github/workflows/reel.yml
name: refresh-demo
on:
  workflow_dispatch:
  schedule: [{ cron: "0 6 * * 1" }]   # every Monday
jobs:
  reel:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: AlexKay28/clickcast-action@v1
        with:
          scenario: docs/tour.yml
          out: docs/demo.gif
      - run: |
          git add docs/demo.gif
          git commit -m "chore: refresh demo reel" || echo "no changes"
          git push
```

**Mobile capture**

```bash
clickcast auto https://example.com --device "iPhone 15" --out mobile.gif
```

**Dark mode shot**

```bash
clickcast shot https://example.com --dark --full-page --out home-dark.png
```

---

## Python API

```python
from clickcast import Reel

reel = (
    Reel("https://worldsight-weld.vercel.app", viewport=(1280, 800), fps=12)
    .goto(wait="networkidle")
    .click("text=3D", label="Switch to 3D globe", dwell=2.0)
    .click("[aria-label='Rankings']", label="Open Rankings")
    .click("text=Español", label="Switch language")
    .scroll(to="footer")
)

reel.save("worldsight.gif")  # or .save("tour.mp4", quality=8)
```

Discovery is available programmatically too:

```python
from clickcast import discover

elements = discover("https://example.com", interactive=True)
```

---

## How it works

```
   URL ──▶ Playwright ──▶ Action engine ──▶ Frame grabber ──▶ Annotator ──▶ Encoder ──▶ .gif/.mp4/.webp
            (chromium)     (auto | scenario)   (per-step PNG)   (Pillow)      (imageio/ffmpeg)
```

1. **Launch** a browser engine (Chromium by default) at the requested viewport/device.
2. **Plan** the tour — either auto-discovered from the accessibility tree + DOM, or read from the scenario.
3. **Execute** each action, waiting for load-states/selectors so SPA hydration completes.
4. **Capture** a frame after every action (plus a few padding frames for smooth playback).
5. **Annotate** frames with click ripples, cursor path, captions, and a progress bar.
6. **Encode** to the target format (Pillow/imageio for GIF/WebP, ffmpeg for MP4).

---

## Troubleshooting

- **Blank frames / nothing rendered** — the page is a SPA; add `wait: networkidle` or a
  `wait: ".loaded-selector"` to your first step.
- **`ffmpeg not found`** — install ffmpeg, or output `gif`/`webp` (which don't require it).
- **Selector not found** — run `clickcast elements <url>` to see what's actually clickable, or mark
  the step `optional: true`.
- **Can't reach an internal site** — set a proxy via `CLICKCAST_PROXY` or `[network].proxy`, or run
  `clickcast doctor` to confirm network egress.
- **Chromium missing** — run `clickcast install` (add `--with-deps` on Linux CI).

---

## Roadmap

- [ ] Voice-over / caption track baked into MP4
- [ ] Side-by-side "before/after" diff reels for visual regression
- [ ] Record real network + console logs alongside the reel
- [ ] Parallel multi-page tours stitched into one output
- [ ] Web UI for authoring scenarios visually

---

## Contributing

Issues and PRs welcome. To set up locally:

```bash
git clone https://github.com/AlexKay28/clickcast
cd clickcast
pip install -e ".[dev]"
clickcast install
pytest
```

Please run `ruff` and `pytest` before opening a PR.

---

## License

MIT © 2026 Your Name. See [LICENSE](./LICENSE).
