Skip to content

✨ Add Vizzly agent project guidance#281

Merged
Robdel12 merged 1 commit into
mainfrom
rd/vizzly-agent-guidance
May 27, 2026
Merged

✨ Add Vizzly agent project guidance#281
Robdel12 merged 1 commit into
mainfrom
rd/vizzly-agent-guidance

Conversation

@Robdel12
Copy link
Copy Markdown
Contributor

@Robdel12 Robdel12 commented May 27, 2026

Summary

This PR packages the Vizzly agent skill with the CLI and adds an opt-in vizzly init --agent-guidance path that sets up project-local agent context.

The core idea is simple: agents cannot use what they do not know exists. Vizzly already has the good stuff agents need for UI work: approved baselines, screenshot history, diffs, review state, comments, dynamic regions, public screenshot URLs, and local TDD context. But unless that context is installed and named in the repo, models tend to reach for generic browser tooling or write tests at the wrong layer.

--agent-guidance makes that setup explicit and project-scoped. It installs .agents/skills/vizzly and adds a small marked section to the repo AGENTS.md that points agents toward Vizzly context and local visual TDD when they are working on user-facing UI.

What Changed

  • Added the packaged skills/vizzly skill to the npm artifact.
  • Added vizzly init --agent-skill for installing only the repo-local skill.
  • Added vizzly init --agent-guidance for installing the skill and updating project AGENTS.md.
  • Made the AGENTS.md update idempotent with a marker, so reruns do not duplicate guidance.
  • Kept the flow project-only: no global Codex config or user-level agent files are touched.
  • Documented the setup path in the README and JSON output docs.

Why This Matters

This should make Vizzly feel much more native to coding agents. Instead of treating visual testing as something the human has to remember to invoke, the project can teach the agent: check screenshot memory first, use existing user workflows, and capture visual evidence through Vizzly.

That is a big unlock for customers using Codex, OpenCode, Pi, or any harness that honors repo-local agent context. The CLI becomes the delivery mechanism for the right instructions, not just the screenshot runner.

Verification

Covered with focused init tests, relevant command tests, Biome, skill validation, a production build, a temp-project init --agent-guidance smoke test, and an npm pack check to confirm the skill ships in the artifact.

Install the packaged Vizzly skill from init and optionally add project AGENTS.md guidance for agents using Vizzly visual context.
@vizzly-testing
Copy link
Copy Markdown

Vizzly - Visual Test Results

CLI Reporter - Waiting for build

No builds received yet for this pull request.

CLI TUI - Approved

5 comparisons, no changes detected.

View build


rd/vizzly-agent-guidance · e361206f

@Robdel12 Robdel12 marked this pull request as ready for review May 27, 2026 22:01
@Robdel12 Robdel12 merged commit c9f87c9 into main May 27, 2026
29 checks passed
@Robdel12 Robdel12 deleted the rd/vizzly-agent-guidance branch May 27, 2026 22:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant