Instructions file CodexOpenCode
AGENTS.md instructions for vtex/skills, covering agents.md — ai contributor guide, quick rules, skill template, frontmatter format and hard constraint format.
Instructions file CodexOpenCode
AGENTS.md instructions for vtex/skills, covering agents.md — ai contributor guide, quick rules, skill template, frontmatter format and hard constraint format.
Cursor rule
Composite skill for the architecture track. Apply when scoping, reviewing, or documenting cross-cutting VTEX commerce architecture across storefront, IO, headless, marketplace, payments, or any other VTEX module. Grounds work in the Well-Architected Commerce framework—Technical Foundation (reliability, trust…
Cursor rule
Apply when scoping, reviewing, or documenting cross-cutting VTEX commerce architecture across storefront, IO, headless, marketplace, payments, or any other VTEX module. Grounds work in the Well-Architected Commerce framework—Technical Foundation (reliability, trust, integrity; security, infrastructure, compliance)…
Cursor rule
Composite skill for the faststore track. Core coding rules and workflow for developing VTEX FastStore storefronts. Use when starting any FastStore development task, writing TypeScript/React components, creating section overrides, extending the BFF, or styling. Covers all primary conventions, safety rules, and the…
Cursor rule
How to send and receive analytics events using @faststore/sdk, and how to configure Google Tag Manager in a FastStore storefront. Use when adding analytics tracking, firing custom events on user interactions, listening for events in a handler component, or setting up GTM.
Cursor rule
How VTEX Headless CMS integrates with FastStore, including how to define section schema.json and sync them. Use when registering new CMS sections, defining editable CMS fields (text, boolean, dropdown, nested objects), syncing schema changes, or understanding how CMS props flow to React components.
Cursor rule
Step-by-step guide to extending the FastStore BFF GraphQL API with custom VTEX type fields or entirely new third-party queries and mutations, and how to consume them in React components. Use when adding new fields to StoreProduct or other built-in types, creating new queries to external APIs, adding form submission…
Cursor rule
A reusable guide for migrating any VTEX FastStore storefront from v3 to v4. Written from two real migrations; all store/account names below are placeholders — substitute the values for the store being migrated.
Cursor rule
Complete FastStore GraphQL BFF API reference including all built-in root queries, root mutations, and type definitions. Use when querying product, collection, search, cart, session, shipping, or user order data, when extending existing types with new fields, or when looking up available fields on types like…
Cursor rule
How to inject third-party scripts, meta tags, and head content into a FastStore storefront. Use when adding external scripts (pixel tags, chat widgets, A/B testing tools), site verification meta tags, Google Tag Manager snippets, or any other content that needs to be in the HTML document head.
Cursor rule
Complete catalog of all built-in FastStore global sections and their overridable component slots. Use when looking up which native sections are available, which inner components (slots) within a section can be overridden via getOverriddenSection, or when deciding whether to override an existing section or create a new…
Cursor rule
FastStore project structure, routes, CLI build pipeline, store configuration (discovery.config.js), and naming conventions. Use when understanding how a FastStore project is organized, how the @faststore/cli works, what files to create or modify, how routing works, or how to configure store settings like SEO, API…
Cursor rule
FastStore styling conventions including CSS custom properties (design tokens), SCSS modules for scoped component styles, component-level overrides using data-fs- attributes, and how to import @faststore/ui styles for new sections. Use when styling components, creating SCSS modules, overriding design tokens in…
Cursor rule
FastStore search and facets reference covering common pitfalls, page context data flow for PLP/Search pages, facets access patterns, and useSearch Zustand API. Use when building custom sections that need search facets, toggling filters, or accessing search state on PLP and Search pages.
Cursor rule
How to override FastStore native sections and inner components using getOverriddenSection, and how to create brand-new custom sections. Use when customizing existing sections (Navbar, Alert, ProductDetails, etc.), replacing inner component slots (BuyButton, Icon, etc.), adding CSS classes to a section, or creating new…
Cursor rule
FastStore atomic design system including @faststore/components and @faststore/ui packages, available atoms, molecules, and organisms, and their data-fs- styling attributes. Use when composing new components with FastStore UI building blocks, looking up which UI components are available (Button, InputField, Modal…
Cursor rule
Core coding rules and workflow for developing VTEX FastStore storefronts. Use when starting any FastStore development task, writing TypeScript/React components, creating section overrides, extending the BFF, or styling. Covers all primary conventions, safety rules, and the development workflow used across every…
Cursor rule
Composite skill for the headless track. Apply when designing or modifying a BFF (Backend-for-Frontend) layer, middleware, or API proxy for a headless VTEX storefront. Covers BFF middleware architecture, public vs private API classification, VtexIdclientAutCookie management, API key protection, and secure request…
Cursor rule
Apply when designing or modifying a BFF (Backend-for-Frontend) layer, middleware, or API proxy for a headless VTEX storefront. Covers BFF middleware architecture, public vs private API classification, VtexIdclientAutCookie management, API key protection, and secure request proxying. Use for any headless commerce…
Cursor rule
Apply when implementing caching logic, CDN configuration, or performance optimization for a headless VTEX storefront. Covers which VTEX APIs can be cached (Intelligent Search, Catalog) versus which must never be cached (Checkout, Profile, OMS), stale-while-revalidate patterns, cache invalidation, and BFF-level…
Cursor rule
Apply when implementing cart, checkout, or order placement logic proxied through a BFF for headless VTEX storefronts. Covers OrderForm lifecycle, cart creation, item management, profile/shipping/payment attachments, orderFormId management, and secure checkout flows. Use for any headless frontend that needs to proxy…
Cursor rule
Apply when implementing search functionality, faceted navigation, or autocomplete in a headless VTEX storefront. Covers productsearch, autocompletesuggestions, facets, banners, correctionsearch, and topsearches endpoints, plus analytics event collection. Use for any custom frontend that integrates VTEX Intelligent…
Cursor rule
Composite skill for the marketplace track. Apply when building catalog or SKU synchronization logic for VTEX marketplace seller connectors. Covers the changenotification endpoint, SKU suggestion lifecycle, product data mapping, price and inventory sync, and fulfillment simulation. Use for implementing seller-side…
Cursor rule
Apply when building catalog or SKU synchronization logic for VTEX marketplace seller connectors. Covers the changenotification endpoint, SKU suggestion lifecycle, product data mapping, price and inventory sync, and fulfillment simulation. Use for implementing seller-side catalog integration that pushes SKUs to VTEX…