vtex-io-app-structure

Align VTEX IO app scaffolding with manifest, builders, and policy best practices.

39|9|Updated Mar 16, 2026
One-click install
npx skills add https://github.com/vtexdocs/ai-skills --skill vtex-io-app-structure
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: vtex-io-app-structure
Source: https://github.com/vtexdocs/ai-skills/tree/main/tracks/vtex-io/skills/vtex-io-app-structure
Command: npx skills add https://github.com/vtexdocs/ai-skills --skill vtex-io-app-structure

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Scaffold VTEX IO apps and validate manifest configuration.

Core Features & Use Cases

  • Guidance for app scaffolding including manifest.json, builders, policies, dependencies, and directory layout.
  • Helps ensure compatibility across node, react, graphql, admin, pixel, and store segments.
  • Use case: when starting a new VTEX IO project or refactoring an existing one to meet best practices.

Quick Start

Review and apply the recommended VTEX IO app structure to your project.

Frequently Asked Questions about vtex-io-app-structure

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

FAQPage Schema
How do I structure a new VTEX IO app for production readiness?

You should organize your VTEX IO app by aligning manifest.json, builders, and policies with best practices. This requires proper builder declarations, explicit outbound-access policies, semantic versioning, and a clean directory layout for node, react, graphql, and store segments.

What builders do I need to declare in a VTEX IO manifest?

VTEX IO manifest builder declarations depend on your project segments. You must explicitly declare builders for node, react, graphql, admin, pixel, or store in the manifest.json to ensure compatibility and enforce proper directory structure.

Why do I need explicit outbound-access policies in VTEX IO apps?

Explicit outbound-access policies are required in VTEX IO apps to enforce production readiness and security. Configuring these policies in your manifest ensures controlled external resource access and aligns your app with platform best practices.

When should I refactor an existing VTEX IO app structure?

Refactor an existing VTEX IO app structure when it lacks production readiness best practices. This includes correcting missing semantic versioning, disorganized directory layouts, absent explicit outbound-access policies, or incomplete builder declarations in the manifest.

Does VTEX IO app scaffolding support both react and node segments simultaneously?

VTEX IO app scaffolding supports simultaneous react and node segments. You configure both in the manifest.json by declaring their respective builders and organizing the directory layout to handle each segment's specific compatibility requirements.