[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Provide a guide on guides faststore molecules toggle field in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore)

[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/getting-started-overview)

[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/webops-dashboard)

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/headless-cms-overview)

[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/developer-tools-overview)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/styling-overview)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/components-index)

[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/atoms-overview)

[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-overview)

[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-accordion)

[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-alert)

[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-breadcrumb)

[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-buy-button)

[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-card)

[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-carousel)

[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-cart-item)

[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-checkbox-field)

[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-discount-badge)

[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-dropdown)

[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-gift)

[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-icon-button)

[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-input-field)

[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-link-button)

[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-modal)

[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-navbar-links)

[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-order-summary)

[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-popover)

[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-product-card)

[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-product-price)

[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-product-title)

[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-quantity-selector)

[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-radio-field)

[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-radio-group)

[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-rating)

[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-rating-field)

[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-region-bar)

[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-search-auto-complete)

[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-search-dropdown)

[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-search-history)

[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-search-input-field)

[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-search-products)

[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-search-top)

[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-select-field)

[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-sku-selector)

[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-table)

[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-tag)

[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-textarea-field)

[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-toast)

[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-toggle)

[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-toggle-field)

[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-tooltip)

[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/organisms-overview)

[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/storefront-features-overview)

[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/faststore-api-overview)

[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/sdk-overview)

[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/developing-and-overriding-components-overview)

[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/api-extensions-overview)

[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/managing-performance-overview)

[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/seo-overview)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/go-live-overview)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/troubleshooting-overview)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/store-framework)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/storefront-best-practices)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore)

[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/getting-started-overview)

[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/webops-dashboard)

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/headless-cms-overview)

[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/developer-tools-overview)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/styling-overview)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/components-index)

[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/atoms-overview)

[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-overview)

[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-accordion)

[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-alert)

[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-breadcrumb)

[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-buy-button)

[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-card)

[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-carousel)

[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-cart-item)

[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-checkbox-field)

[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-discount-badge)

[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-dropdown)

[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-gift)

[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-icon-button)

[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-input-field)

[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-link-button)

[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-modal)

[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-navbar-links)

[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-order-summary)

[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-popover)

[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-product-card)

[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-product-price)

[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-product-title)

[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-quantity-selector)

[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-radio-field)

[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-radio-group)

[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-rating)

[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-rating-field)

[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-region-bar)

[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-search-auto-complete)

[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-search-dropdown)

[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-search-history)

[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-search-input-field)

[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-search-products)

[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-search-top)

[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-select-field)

[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-sku-selector)

[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-table)

[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-tag)

[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-textarea-field)

[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-toast)

[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-toggle)

[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-toggle-field)

[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-tooltip)

[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/organisms-overview)

[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/storefront-features-overview)

[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/faststore-api-overview)

[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/sdk-overview)

[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/developing-and-overriding-components-overview)

[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/api-extensions-overview)

[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/managing-performance-overview)

[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/seo-overview)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/go-live-overview)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/troubleshooting-overview)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/store-framework)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/storefront-best-practices)

---

[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/storefront-development)

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/components-index)

[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-overview)

ToggleField

Groups a Toggle input and its corresponding Label.

[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/molecules/ToggleField)

The `ToggleField` component wraps a [Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle) input and its corresponding [Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label).

Example

Code

Label

Toggle

Checked

Disabled

---

## Usage

### Import the component

`1

import { ToggleField } from '@faststore/ui'

`

### Import styles

To apply styles, include the following in your stylesheet:

`1

@import '@faststore/ui/src/components/molecules/ToggleField/styles.scss';

`

For details, see [Importing FastStore UI component styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles).

---

## Data attributes

You can target and override `ToggleField` styles using the following data attributes:

`data-fs-toggle-field`

`data-fs-toggle-field-label`

---

## Props

| Name             | Type                       | Description                                                                            | Default         |
| ---------------- | -------------------------- | -------------------------------------------------------------------------------------- | --------------- |
| **testId**       | string                     | ID to find this component in testing tools (e.g.: cypress, testing library, and jest). | fs-toggle-field |
| **id\***         | string                     | ID to identify input and corresponding label.                                          |                 |
| **label\***      | string                     | The text displayed to identify the input.                                              |                 |
| **displayLabel** | false \| true              | Controls whether the label will be displayed or not.                                   | true            |
| **disabled**     | false \| true              | Specifies that this input should be disabled.                                          |                 |
| **variant**      | "horizontal" \| "vertical" | Controls the component's direction.                                                    | horizontal      |

Contributors

3

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F67270558%3Fv%3D4%26w=64%26q=75)](https://github.com/mariana-caetano)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F62757720%3Fv%3D4%26w=64%26q=75)](https://github.com/aliceoq)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/molecules/toggle-field.mdx)

[Toggle« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-toggle)[TooltipNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-tooltip)

Contributors

3

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F67270558%3Fv%3D4%26w=64%26q=75)](https://github.com/mariana-caetano)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F62757720%3Fv%3D4%26w=64%26q=75)](https://github.com/aliceoq)

ON THIS PAGE

[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-toggle-field%23usage)

[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-toggle-field%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-toggle-field%23import-styles)

[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-toggle-field%23data-attributes)

[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-toggle-field%23props)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/molecules/toggle-field.mdx)

Copy page

On this page

ON THIS PAGE

[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-toggle-field%23usage)

[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-toggle-field%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-toggle-field%23import-styles)

[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-toggle-field%23data-attributes)

[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-toggle-field%23props)

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)


[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Provide a guide on guides using the weni by vtex cli in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/data-protection-plus)

---

Weni by VTEX

Weni by VTEX CLI

[Using the Weni by VTEX CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli)

[Weni by VTEX CLI Command Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/weni-by-vtex-cli-command-reference)

[Authenticating with your Weni by VTEX account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/authenticating-with-your-weni-by-vtex-account)

[Managing your Weni by VTEX projects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/managing-your-weni-by-vtex-projects)

[Understanding the core concepts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/weni-by-vtex-understanding-the-core-concepts)

[Working with Weni by VTEX agents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/working-with-weni-by-vtex-agents)

[Fetching and filtering logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/weni-by-vtex-fetching-and-filtering-logs)

[Using Weni Run to execute tool tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-weni-run-to-execute-tool-tests)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/data-protection-plus)

---

Weni by VTEX

Weni by VTEX CLI

[Using the Weni by VTEX CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli)

[Weni by VTEX CLI Command Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/weni-by-vtex-cli-command-reference)

[Authenticating with your Weni by VTEX account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/authenticating-with-your-weni-by-vtex-account)

[Managing your Weni by VTEX projects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/managing-your-weni-by-vtex-projects)

[Understanding the core concepts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/weni-by-vtex-understanding-the-core-concepts)

[Working with Weni by VTEX agents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/working-with-weni-by-vtex-agents)

[Fetching and filtering logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/weni-by-vtex-fetching-and-filtering-logs)

[Using Weni Run to execute tool tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-weni-run-to-execute-tool-tests)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides)

Weni by VTEX

Weni by VTEX CLI

[Using the Weni by VTEX CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli)

Using the Weni by VTEX CLI

Learn how to use Weni by VTEX CLI

This guide will walk you through using the Weni by VTEX CLI to create, deploy, and manage AI-powered agents, enhancing your customer service capabilities. By the end of this guide, you will be able to install the CLI, configure your project, and deploy your first agent.

With the CLI, you can:

* Create, deploy, and manage multiple AI agents
* Add custom tools to the agents
* Update agent configuration and behavior

> To use the Weni by VTEX CLI, you must have: a Weni by VTEX Platform account; an account at [weni.ai](https://read.calvincode.net/reader?url=https://weni.ai/en); and at least one project in your account.

The content is organized as follows:

* [Installing the CLI](#step-1---installing-the-cli)
* [Getting started with your project](#getting-started-with-your-project)
* [Troubleshooting](#troubleshooting)
* [Contributing to Weni by VTEX CLI](#contributing-to-weni-cli)

## Step 1 - Installing the CLI

There are two installation methods:

* A [quick installation](#install-via-pip) with `pip`.
* A [manual installation](#install-via-poetry) with `Poetry`, for development purposes.

### Install via pip

To install the CLI using `pip`, open the terminal and run the following command:

`1

pip install weni-cli

`

### Install via Poetry

To install the CLI manually, follow these steps:

1. Clone the repository by running the following command:

`1

git clone https://github.com/weni-ai/weni-cli.git

2

cd weni-cli

`

1. Install dependencies and make the CLI executable by running the following command:

`1

poetry shell

2

poetry install

`

## Step 2 - Verifying Installation

To verify that Weni by VTEX CLI is installed, type the following command in your terminal:

`1

weni

`

If the installation was successful, your terminal should display something like this:

> An error occurred while loading the image https://github.com/vtexdocs/dev-portal-content/main/docs/guides/Weni-by-VTEX/CLI/assets/weni-installation-verification.png

### Troubleshooting

If you encounter any issues:

1. Check our [GitHub Issues](https://read.calvincode.net/reader?url=https://github.com/weni-ai/weni-cli/issues)
2. Create a new issue with:
   * Your operating system
   * Python version (`python --version`)
   * Error message
   * Steps to reproduce

### Getting started with your project

#### Step 1 - Log in to your Weni by VTEX account

1. Open the terminal and run the following command:

`1

weni login

`

This should open your browser on the login page for authentication. If that does not happen, you can open the URL shown in the terminal.

1. Log in using your Weni by VTEX account and password.

#### Step 2 - List your projects

List your projects by running the following command:

`1

weni project list

`

This will show all projects you have access to and, next to each of them, its universally unique identifier (UUID).

#### Step 3 - Select a project

Select the project you want to work on by running the following command:

`1

weni project use your-project-uuid

`

Replace `your-project-uuid` with the UUID from the project list.

#### Step 4 - Verify the current project

To verify you're working on the correct project, you can run the following command:

`1

weni project current

`

You will see the project's UUID in the terminal output.

#### Step 5 - Initialize a new agent

To create an agent, run the following command:

`1

weni init

`

This command performs the following actions:

* Creates the necessary folder structure for your agent.
* Sets up a pre-built CEP (Complex Event Processing) tool.
* Creates an `agent_definition.yaml` file with the initial configuration. You can edit this file to customize your agent's behavior.

`1

agents:

2

 sample_agent:

3

 name: "CEP Agent"

4

 description: "Weni's CEP agent"

5

 instructions:

6

 - "You are an expert in providing addresses to the user based on a postal code provided by the user"

7

 - "The user will send a ZIP code (postal code) and you must provide the address corresponding to this code."

8

 guardrails:

9

 - "Don't talk about politics, religion, or any other sensitive topic. Keep it neutral."

10

 tools:

11

 - get_address:

12

 name: "Get Address"

13

 source:

14

 path: "tools/get_address"

15

 entrypoint: "main.GetAddress"

16

 description: "Function to get the address from the postal code"

17

 parameters:

18

 - cep:

19

 description: "postal code"

20

 type: "string"

21

 required: true

`

##### Understanding the source configuration

In the YAML above, there are two fields nested within the `source` field:

* `path`: This field specifies the directory containing your tool implementation.
   * The command automatically creates a `tools` directory and a folder called `get_address` nested within it.
   * In this path, you can find the files `main.py`, `requirements.txt`, and `test_definition.yaml`.
* `entrypoint`: This field informs the system which class to use.
   * Using `main.GetAddress` indicates that the system finds the file named `main.py`, uses the `GetAddress` class inside the file and that the class must inherit from the `Tools` base class.

Your project structure should look like this:

`1

my-agent-project/

2

├── agent_definition.yaml

3

└── tools/

4

 └── get_address/

5

 ├── main.py # Contains GetAddress class

6

 └── requirements.txt # Dependencies

`

#### Step 6 - Implement the tool manually (if `weni init` fails)

If the command doesn't work, you can implement this tool manually following the next steps:

1. Create the tool directory

`1

 mkdir -p tools/get_address

2

 cd tools/get_address

`

1. Create the file `tools/get_address/main.py` and insert the following:

`1

 from weni import Tool

2

 from weni.context import Context

3

 from weni.responses import TextResponse

4

 import requests

5

6

7

 class GetAddress(Tool):

8

 def execute(self, context: Context) -> TextResponse:

9

 cep = context.parameters.get("cep", "")

10

 address_response = self.get_address_by_cep(cep=cep)

11

 return TextResponse(data=address_response)

12

13

 def get_address_by_cep(self, cep):

14

 url = f"https://viacep.com.br/ws/{cep}/json/"

15

 response = requests.get(url)

16

 return response.json()

`

* The class name `GetAddress` must match the class name in the entrypoint
* The file name `main.py` must match the file name in the entrypoint
* The class must inherit from `Tool` and implement the `execute` method
1. Create the `requirements.txt` file

`1

 requests==2.32.3

`

#### Step 7 - Add credentials and global files (optional)

If you have credentials and global files, place these files in `tools/get_address` during local runs:

`1

# .env

2

api_key=your-development-api-key

`

`1

# .globals

2

BASE_URL=https://api.example.com

`

#### Step 7 - Deploy the agent

Deploy your agent by running the following command:

`1

weni project push agent_definition.yaml

`

## Advanced Configuration

#### Custom Parameters

You can add more parameters to your tools:

`1

parameters:

2

 - format:

3

 description: "Response format (json or text)"

4

 type: "string"

5

 required: false

6

 default: "json"

`

#### Multiple Tools

Agents can have multiple tools:

`1

tools:

2

 - get_address:

3

 # tool definition

4

 - validate_cep:

5

 # another tool definition

`

## Contributing to Weni by VTEX CLI

This guide will help you get started with contributing to the project.

### Development Setup

#### Prerequisites

* Python >= 3.12
* Poetry >= 1.8.5
* Git

#### Setting Up Development Environment

1. Fork the repository on GitHub
2. Clone your fork:
`1
git clone https://github.com/YOUR_USERNAME/weni-cli.git
2
cd weni-cli
`
3. Install dependencies:
`1
poetry install
`
4. Create a new branch:
`1
git checkout -b feature/your-feature-name
`

### Development Guidelines

#### Code Style

* Follow PEP 8 guidelines
* Use meaningful variable and function names
* Add docstrings to functions and classes
* Keep functions focused and concise

#### Testing

1. Write tests for new features:
`1
def test_your_feature():
2
 # Your test code here
3
 assert expected == actual
`
2. Run tests:
`1
poetry run pytest
`
3. Check coverage:
`1
poetry run pytest --cov
`

#### Documentation

1. Update documentation for new features
2. Add docstrings to new functions
3. Update README.md if needed
4. Add examples when relevant

### Making Changes

#### Workflow

1. Create a feature branch
2. Make your changes
3. Write or update tests
4. Update documentation
5. Run tests locally
6. Commit your changes
7. Push to your fork
8. Create a Pull Request

#### Commit Messages

Follow conventional commits:

* `feat:` New features
* `fix:` Bug fixes
* `docs:` Documentation changes
* `test:` Adding or updating tests
* `chore:` Maintenance tasks

Example:

`1

git commit -m "feat: add support for custom headers in requests"

`

### Pull Requests

#### PR Guidelines

1. Create one PR per feature/fix
2. Include tests
3. Update documentation
4. Reference issues if applicable
5. Keep changes focused and minimal

#### PR Template

`1

### Description

2

Brief description of changes

3

4

### Type of Change

5

- [ ] Bug fix

6

- [ ] New feature

7

- [ ] Documentation update

8

- [ ] Other (specify)

9

10

### Testing

11

Describe testing done

12

13

### Documentation

14

List documentation updates

`

### Review Process

1. Automated checks must pass
2. Code review by maintainers
3. Documentation review
4. Changes requested if needed
5. Approval and merge

### Getting Help

* Create an issue for bugs
* Ask questions in discussions
* Join our community channels

### Development Tools

#### Recommended VSCode Extensions

* Python
* YAML
* markdownlint
* GitLens

#### Useful Commands

`1

# Format code

2

poetry run black .

3

4

# Run linter

5

poetry run flake8

6

7

# Run tests

8

poetry run pytest

9

10

# Build documentation

11

poetry run mkdocs serve

`

### Release Process

1. Version bump
2. Update CHANGELOG
3. Create release PR
4. Tag release
5. Deploy to PyPI

### Community

* Be respectful and inclusive
* Help others when possible
* Share knowledge
* Follow our Code of Conduct

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F170467615%3Fv%3D4%26w=64%26q=75)](https://github.com/mariananantua)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Weni-by-VTEX/CLI/using-the-weni-by-vtex-cli.md)

[Limitations of the PII data architecture during closed beta« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli//docs/guides/limitations-of-the-pii-data-architecture-during-closed-beta)[Weni by VTEX CLI Command ReferenceNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli//docs/guides/weni-by-vtex-cli-command-reference)

See also

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F170467615%3Fv%3D4%26w=64%26q=75)](https://github.com/mariananantua)

ON THIS PAGE

[Step 1 - Installing the CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23step-1-installing-the-cli)

[Install via pip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23install-via-pip)[Install via Poetry](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23install-via-poetry)

[Step 2 - Verifying Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23step-2-verifying-installation)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23troubleshooting)[Getting started with your project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23getting-started-with-your-project)

[Advanced Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23advanced-configuration)

[Contributing to Weni by VTEX CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23contributing-to-weni-by-vtex-cli)

[Development Setup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23development-setup)[Development Guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23development-guidelines)[Making Changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23making-changes)[Pull Requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23pull-requests)[Review Process](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23review-process)[Getting Help](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23getting-help)[Development Tools](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23development-tools)[Release Process](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23release-process)[Community](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23community)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Weni-by-VTEX/CLI/using-the-weni-by-vtex-cli.md)

Copy page

On this page

ON THIS PAGE

[Step 1 - Installing the CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23step-1-installing-the-cli)

[Install via pip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23install-via-pip)[Install via Poetry](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23install-via-poetry)

[Step 2 - Verifying Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23step-2-verifying-installation)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23troubleshooting)[Getting started with your project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23getting-started-with-your-project)

[Advanced Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23advanced-configuration)

[Contributing to Weni by VTEX CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23contributing-to-weni-by-vtex-cli)

[Development Setup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23development-setup)[Development Guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23development-guidelines)[Making Changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23making-changes)[Pull Requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23pull-requests)[Review Process](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23review-process)[Getting Help](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23getting-help)[Development Tools](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23development-tools)[Release Process](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23release-process)[Community](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23community)

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)


[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Provide a guide on guides storefront content internationalization in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/faststore)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/store-framework)

[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/vtex-io-documentation-store-theme)

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/getting-started-3)

Concepts

[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/store-framework-building-pages)

[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/store-framework-using-components)

[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/store-framework-using-advanced-layouts)

[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/store-framework-working-with-site-editor)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/store-framework-styling)

[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/store-framework-dealing-with-events)

[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/store-framework-configuring-analytics-google-tag-manager)

[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/store-framework-setting-up-cross-border-stores)

[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/vtex-io-multi-language-stores)

[Internationalizing product prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/vtex-io-documentation-internationalizing-product-prices)

[Disabling automatic translation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/vtex-io-documentation-disabling-automatic-translation)

[Translating storefront content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/storefront-content-internationalization)

[Translating Catalog content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/catalog-internationalization)

[Overwriting the Messages app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/vtex-io-documentation-overwriting-the-messages-app)

[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/store-framework-routing)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/store-framework-managing-performance)

[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/vtex-io-documentation-semantic-html-migration)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/vtex-io-documentation-go-live)

[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/store-framework-updating-live-stores)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/storefront-best-practices)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/faststore)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/store-framework)

[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/vtex-io-documentation-store-theme)

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/getting-started-3)

Concepts

[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/store-framework-building-pages)

[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/store-framework-using-components)

[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/store-framework-using-advanced-layouts)

[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/store-framework-working-with-site-editor)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/store-framework-styling)

[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/store-framework-dealing-with-events)

[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/store-framework-configuring-analytics-google-tag-manager)

[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/store-framework-setting-up-cross-border-stores)

[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/vtex-io-multi-language-stores)

[Internationalizing product prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/vtex-io-documentation-internationalizing-product-prices)

[Disabling automatic translation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/vtex-io-documentation-disabling-automatic-translation)

[Translating storefront content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/storefront-content-internationalization)

[Translating Catalog content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/catalog-internationalization)

[Overwriting the Messages app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/vtex-io-documentation-overwriting-the-messages-app)

[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/store-framework-routing)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/store-framework-managing-performance)

[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/vtex-io-documentation-semantic-html-migration)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/vtex-io-documentation-go-live)

[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/store-framework-updating-live-stores)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/storefront-best-practices)

---

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/storefront-development)

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/store-framework)

[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/vtex-io-multi-language-stores)

[Translating storefront content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/storefront-content-internationalization)

Translating storefront content

Learn how to translate text messages from a frontend app.

A message is any website text content set as translatable, and Messages is the VTEX IO app responsible for providing message translations for rendering.

As a background, it's important to know that every text set as translatable during the development of a storefront component is automatically translated either by the _storefront app's definitions_ (declared in the app's `/messages` folder) or by the _automatic translation service_ (when the storefront app doesn't include any specific translation of a message).

However, considering literal translations and cultural factors, some translations might be unsatisfactory.

Hence, you may want to overwrite a translation provided by the automatic translation service or by the app's definitions with a more specific or representative content of your store.

For example, you may want to set a special login message for Spanish-speaking users from Argentina.

Considering this case, in the following step-by-step, we'll teach you how to overwrite a storefront message with exclusive content for your store through the Messages app.

## Instructions

Follow this step-by-step to translate text messages exported from an app (declared in the app's `messages` folder).

1. [Install](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app) the `vtex.admin-graphql-ide@3.x` app using your terminal.
2. Access the Admin and go to **Store Setting > Storefront > GraphQL IDE**.
3. From the dropdown list, choose the `vtex.messages` app.
4. Write the following mutation command in the text box that is displayed:

`1

mutation Save($saveArgs: SaveArgsV2!) {

2

 saveV2(args: $saveArgs)

3

}

`

1. Then, click on _Query Variables_ at the bottom of the page. Now, your screen may look like the following:

![{"base64":"  ","img":{"width":1278,"height":768,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":39235,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/storefront-content-internationalization-1.png"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/storefront-content-internationalization-1.png)

1. To fill in the _Query Variables_ box, you must provide the following parameters:
* `to`: target translation locale.
* `messages`: a list of the messages you want to translate, containing the following parameters:
   * `srcLang`: source message locale. This variable must contain the value `en-DV`, no matter which locale is rendered on the app's interface.
   * `srcMessage`: the `id` of your message string declared in the app's `messages` folder.
   * `context`: the name of the storefront app that declared the message being overwritten.
   * `targetMessage`: the desired translation for the message string.

Take the following example:

`1

{

2

 "saveArgs": {

3

 "to": "en-US",

4

 "messages": [

5

 {

6

 "srcLang": "en-DV",

7

 "srcMessage": "store/search.placeholder",

8

 "context": "vtex.store-components@3.x",

9

 "targetMessage": "My personalized Search message"

10

 }

11

 ]

12

 }

13

}

`

> In VTEX IO, translations of storefront components are kept in a `/messages` folder inside the app's root folder. For example, the English translation of the `search.placeholder` message from the `store-components` app is declared [here](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-components/blob/master/messages/en.json%23L2). Hence, in this example, we just overwrote this message with "My personalized Search message" through the Messages app.

1. After adjusting your query, click the play button to run the declared mutation. The expected response is as follows:

`1

{

2

 "data": {

3

 "saveV2": true

4

 }

5

}

`

1. (Optional) If you want to check your changes on the GraphQL IDE, check the " Checking your changes" section.

Now, no further actions are needed on your part. Once you receive the expected response, you are ready to check out the desired changes in your store!

To better understand the full process of overwriting an app message translation, check the following gif:

![{"base64":"  ","img":{"width":1894,"height":978,"type":"gif","mime":"image/gif","wUnits":"px","hUnits":"px","length":1758228,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/storefront-content-internationalization-2.gif"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/storefront-content-internationalization-2.gif)

## Checking your changes

If you have already performed the desired mutations, you can check your changes through a query in the GraphQL IDE.

1. In the **GraphQL admin IDE**, after choosing the `vtex.messages` app, write the following query command in the text box that is displayed:

`1

query GetTranslation($args: TranslateWithDependenciesArgs!) {

2

 translateWithDependencies(args: $args)

3

}

`

1. Then, click on _Query Variables_ at the bottom of the page.
2. To fill in the _Query Variables_ box, you must provide the following parameters:
* `from`: source message locale.
* `messages`: a list of the messages you want to check translations, containing the following parameters:
   * `content`: the `id` of your message string declared in the app's `messages` folder.
   * `context`: the name of the storefront app that declared the message being overwritten.
* `to`: target translation locale.
* `depTree`: the dependency tree as in `"[{\"id\": \"{context}\"}]"`.

Take the following example:

`1

{

2

"args": {

3

 "indexedByFrom": [

4

 {

5

 "from": "en-DV",

6

 "messages": [

7

 {

8

 "content": "store/search.placeholder",

9

 "context": "vtex.store-components@3.x"

10

 }

11

 ]

12

 }

13

 ],

14

 "to": "en-US",

15

 "depTree": "[{\"id\": \"vtex.store-components@3.x\"}]"

16

 }

17

}

`

1. After adjusting your query, click the play button to run it. The expected response is the translated message in the target locale.

For the given example, the expected response is as follows:

`1

{

2

 "data": {

3

 "translateWithDependencies": [

4

 "My personalized Search message"

5

 ]

6

 }

7

}

`

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/vtex-io-multi-language-stores/storefront-content-internationalization.md)

[Disabling automatic translation« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization//docs/guides/vtex-io-documentation-disabling-automatic-translation)[Translating Catalog contentNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization//docs/guides/catalog-internationalization)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

ON THIS PAGE

[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/storefront-content-internationalization%23instructions)

[Checking your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/storefront-content-internationalization%23checking-your-changes)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/vtex-io-multi-language-stores/storefront-content-internationalization.md)

Copy page

On this page

ON THIS PAGE

[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/storefront-content-internationalization%23instructions)

[Checking your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/storefront-content-internationalization%23checking-your-changes)

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)