feature-test

Generate E2E PTY feature tests with VHS GIFs and Zola pages.

29|2|Updated Feb 4, 2026
One-click install
npx skills add https://github.com/agentty-xyz/agentty --skill feature-test-agentty-xyz
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: feature-test
Source: https://github.com/agentty-xyz/agentty/tree/main/skills/feature-test
Command: npx skills add https://github.com/agentty-xyz/agentty --skill feature-test-agentty-xyz

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill streamlines the workflow of adding new visible, user-facing UI features by producing a reproducible PTY E2E test, an illustrative VHS GIF, and an auto-generated Zola feature page so tests, demos, and documentation remain synchronized and reviewable.

Core Features & Use Cases

  • Unified artifact generation: one declarative test produces an E2E test under crates/agentty/tests/e2e/, a feature GIF in docs/site/static/features/, and a Zola page in docs/site/content/features/.
  • Naming and discoverability: enforces snake_case naming and placement conventions so feature pages are auto-discovered by the Zola template and ordered by weight.
  • Use Case: capture a short PTY scenario for a new help overlay or tab-switch behavior, assert visible UI text, generate a cached GIF if VHS is present, and add a documentation card without manual template edits.

Quick Start

Create a FeatureTest with a snake_case name, enable Zola page generation with a title, description, and weight, run the scenario to capture the GIF, and commit the generated test and Zola page.

Frequently Asked Questions about feature-test

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate E2E PTY tests and GIFs for UI features in Rust?

You can automate E2E test generation by creating a declarative FeatureTest with a snake_case name. This produces a PTY test under crates/agentty/tests/e2e/, captures a VHS GIF scenario, and generates a Zola markdown page with proper frontmatter.

How does VHS GIF content-hash caching work for feature tests?

VHS GIF content-hash caching stores generated GIFs in docs/site/static/features/ and reuses them when the underlying PTY scenario remains unchanged. This prevents redundant render cycles during subsequent test runs while keeping feature demos synchronized.

Can I auto-generate Zola documentation pages from E2E tests?

Yes, you can auto-generate Zola documentation pages by enabling Zola generation in your FeatureTest configuration. The Skill creates docs/site/content/features/{name}.md with proper frontmatter, including title, description, and weight for automatic template discovery.

Do I need VHS installed to run PTY E2E feature tests?

You do not need VHS installed to run the PTY E2E tests themselves, but VHS must be present on your system to generate the illustrative feature GIFs. The Skill gracefully skips GIF creation if VHS is not found during the test execution.

What is the best way to keep UI feature demos and tests synchronized?

The best way to keep UI feature demos and tests synchronized is using a unified artifact generation approach. This Skill produces the E2E test, VHS GIF, and Zola page from a single declarative scenario, ensuring all components remain reviewable and aligned.

When should I not use automated PTY test generation for UI features?

You should avoid automated PTY test generation for non-visible backend changes or UI features that cannot be demonstrated in a short terminal scenario. This Skill is specifically designed for visible, user-facing UI behaviors that fit within a brief PTY interaction window.