appshot AGENTS.md

AGENTS.md

Guidelines for AI agents working in this repository.

Repository Overview

Appshot generates App Store preview videos for mobile apps. It ships as AI agent skills that scan a target app's codebase, propose a narrative, and write custom Remotion scene components that mock the target app's actual UI. Mobile apps only (iOS/Android).

• Name: Appshot
• GitHub: github.com/trunghaiy/appshot
• Creator: Kian Nguyen
• License: MIT

Architecture

Appshot does NOT use fixed scene templates. The skill writes bespoke .tsx scene files from scratch for every project, using 11 shared animation primitives as building blocks.

Repository Structure

appshot/
├── AGENTS.md                  # This file — agent guidelines
├── CLAUDE.md                  # Claude Code-specific context and pitfalls
├── README.md
├── template/                  # Clean Remotion project — primitives only, NO scene files
│   └── src/components/        # 11 shared animation primitives
├── packages/create-appshot/   # npx create-appshot CLI
├── examples/bookstreak/       # Reference example
└── .claude/skills/            # Agent skills
    ├── appshot-core/          # Primitives catalog, config schema
    ├── appshot-videos/        # Creative director: scans code, writes custom scenes
    ├── appshot-images/        # Screenshot generator
    ├── eval/                  # Evaluation rubric and test scenarios
    └── shared/                # copy-principles.md, extract-app-context.md

Agent Skills Specification

Skills follow the Agent Skills spec.

Required Frontmatter

---
name: skill-name
description: What this skill does and when to use it. Include trigger phrases.
license: MIT
metadata:
  author: kiennguyen
  version: X.0.0
---

Frontmatter Constraints

Field	Required	Constraints
name	Yes	1-64 chars, lowercase a-z, numbers, hyphens. Must match directory name.
description	Yes	1-1024 chars. Include trigger phrases.
license	No	Default: MIT
metadata	No	Key-value pairs: author, version