> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.bigcommerce.com/developer/docs/storefront/catalyst/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.bigcommerce.com/_mcp/server.

# Catalyst

> Build amazing commerce solutions powered by the BigCommerce platform

## Docs

- [Catalyst](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/overview.md): Catalyst is BigCommerce's composable, fully customizable headless ecommerce storefront framework, built with Next.js and the GraphQL Storefront API.
- [Getting Started](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/getting-started/overview.md): Choose how to set up a Catalyst project, comparing One-Click Catalyst and CLI Installation, including how each path handles Makeswift, local development, and Native Hosting.
- [Prerequisites](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/getting-started/prerequisites.md): The local tools, BigCommerce store, and control panel permissions you need before setting up a Catalyst project with One-Click Catalyst or the CLI.
- [One-Click Catalyst](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/getting-started/one-click-catalyst.md): Create a Catalyst storefront from the BigCommerce control panel, with a hosted preview deployment and connected Makeswift sites, then optionally run it locally and push it to your own Git repository.
- [CLI Installation](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/getting-started/cli-installation.md): Scaffold a new Catalyst project locally with the Catalyst CLI, connect it to your BigCommerce store, run the development server, and push it to your own Git repository.
- [Versioning](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/getting-started/versioning.md): How Catalyst uses branches, Git tags, and semantic versioning, and how to keep your project up to date with catalyst upgrade.
- [Upgrading](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/getting-started/upgrading.md): Upgrade an existing Catalyst project to a newer version using the catalyst upgrade CLI command.
- [Optimization](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/development/optimization.md): Built-in optimizations and best practices for improving resource utilization and page performance in a Catalyst storefront.
- [Sessions](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/development/sessions.md): How Catalyst manages customer sessions and access tokens using Auth.js.
- [Session Sync](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/development/session-sync.md): Set up checkout session syncing for a Catalyst storefront and troubleshoot session-sync failures such as "Invalid JWT token" errors and 404 responses.
- [Proxy](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/development/middleware.md): How Catalyst's proxy chain in proxy.ts handles UCP, sessions, analytics, localization, channels, GraphQL proxying, and route resolution before a request reaches its route.
- [CDN and Images](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/development/cdn-and-images.md): How Catalyst handles image optimization and CDN delivery, using the Next.js Image component alongside BigCommerce's CDN.
- [Caching](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/development/caching.md): How Catalyst uses Next.js request memoization and the Data Cache to reduce redundant GraphQL requests and lower rendering costs.
- [Features](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/features/overview.md): A feature-support matrix showing which major BigCommerce platform features are natively supported, partially supported, or unsupported in Catalyst.
- [Cookies](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/features/cookies.md): The first-party cookies Catalyst sets on the storefront domain by default, with their purpose, consent category, and expiry.
- [Cookie Consent](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/features/cookie-consent.md): How Catalyst's built-in cookie consent manager, powered by c15t, gates Script Manager scripts by consent category, and how to choose a consent storage mode.
- [Wishlists](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/features/wishlists.md): How Catalyst's built-in wishlists let customers save products from the product page and manage their wishlists in My Account.
- [Sitemap](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/features/sitemap.md): How Catalyst serves the BigCommerce sitemap index for your default channel, and why its entries use the channel's permanent URL.
- [Localization](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/features/localization/overview.md): Options for localizing a Catalyst storefront by language and region, and how to choose between multi-language and multi-storefront setups.
- [Static Translations](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/features/localization/static-translations.md): Translate the fixed text in a Catalyst storefront with per-locale message files, and enable locales in the control panel.
- [Catalyst Multi-Storefront Overview](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/features/localization/multi-storefront/overview.md): How Catalyst supports selling internationally with multiple channels, each with its own language, currency, and locale-specific URLs.
- [Catalyst Multi-Storefront Setup](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/features/localization/multi-storefront/setup.md): Set up a Catalyst storefront that serves multiple countries and locales from one app by mapping locales to BigCommerce channels.
- [Catalyst Multi-Language Overview](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/features/localization/multi-language/overview.md): How Catalyst supports multiple languages on a single storefront, including translated catalog data, locale detection, and language switching.
- [Catalyst Multi-Language Setup](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/features/localization/multi-language/setup.md): Translate a Catalyst storefront into another language, covering static strings, catalog data, and Makeswift content.
- [Makeswift](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/makeswift/overview.md): How Makeswift, BigCommerce's visual page builder, integrates with Catalyst, and which setup paths give you a Makeswift-connected project.
- [Editing and Syncing Content](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/makeswift/editing-and-syncing-content.md): Edit a Makeswift-connected Catalyst storefront in the Makeswift visual editor, and sync your BigCommerce product catalog to your Makeswift site.
- [Create Custom Components](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/makeswift/custom-components.md): Build a custom Catalyst product carousel that's visually editable in Makeswift, fetches BigCommerce product data, and uses VIBES components and Makeswift controls.
- [Use the Customer Group Slot in Makeswift](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/makeswift/customer-group-component.md): Use the Customer Group Slot component in Makeswift to show different content to different customer groups on a Catalyst storefront.
- [Install Scripts in Catalyst](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/guides/manually-installing-scripts.md): Add third-party scripts to a Catalyst storefront with Script Manager or the Next.js Script component, and respect cookie consent.
- [Add Mailchimp to Catalyst](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/guides/mailchimp-newsletter.md): Add the Mailchimp app's tracking and pop-up script to a Catalyst storefront with the Next.js Script component.
- [Integrate Third-Party Search with Algolia](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/guides/algolia-search.md): Replace Catalyst's built-in product search with Algolia by indexing your catalog and querying Algolia from the search server action.
- [Manually Create a Catalyst Channel](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/guides/manually-create-catalyst-channel.md): Create a Catalyst channel, site, checkout URL, and routes with the REST Management API instead of the control panel, and optionally attach a Makeswift site.
- [Deploy a Catalyst Storefront](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/deployment/overview.md): Deploy Catalyst to Native Hosting, BigCommerce's own hosting infrastructure, or to Vercel, review requirements for other hosts, and configure environment variables and Redirected Checkout for production.
- [Choosing a hosting platform](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/deployment/choosing-a-hosting-platform.md): Compare BigCommerce Native Hosting and Vercel for a Catalyst storefront across deployment, domains, caching, monitoring, configuration, and cost.
- [Native Hosting Overview](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/deployment/native-hosting/overview.md): How BigCommerce Native Hosting runs Catalyst storefronts, including core concepts, authentication, and CLI configuration variables.
- [Getting Started](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/deployment/native-hosting/getting-started.md): Deploy a Catalyst storefront to BigCommerce Native Hosting with the Catalyst CLI, from a new project or an existing one.
- [GitHub Actions](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/deployment/native-hosting/github-actions.md): Deploy a Catalyst storefront to Native Hosting from GitHub Actions, on merge to your default branch and as a preview for each pull request.
- [Custom Domains](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/deployment/native-hosting/custom-domains.md): Add a custom domain to a Catalyst Native Hosting project with the Catalyst CLI, including setup for stores that already serve their domain through Cloudflare.
- [Checkout Domains](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/deployment/native-hosting/checkout-domains.md): Configure the checkout URL for a Catalyst Native Hosting channel with the Catalyst CLI, including the same-domain requirement and the checkout hostname BigCommerce provisions for auto-generated hostnames.
- [Makeswift](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/deployment/native-hosting/makeswift.md): How the Makeswift site URL and the MAKESWIFT_SITE_API_KEY variable behave when you deploy a Makeswift-enabled Catalyst storefront to Native Hosting.
- [Deploy to Vercel](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/deployment/vercel.md): Deploy a Catalyst storefront to Vercel using the Vercel dashboard or the Vercel CLI, and point your production Makeswift site at the deployment.
- [Catalyst Client](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/reference/client.md): Reference for the Catalyst Client, which wraps the GraphQL Storefront API — configuration options, the fetch and fetchSitemapIndex methods, request headers, retries, error classes, and logging.
- [Catalyst CLI](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/reference/cli.md): Reference for every Catalyst CLI command and flag, including create, deploy, env, logs, projects, channels, domains, auth, and upgrade.
- [Environment Variables](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/reference/environment-variables.md): Reference for the environment variables a Catalyst storefront reads, with their types, defaults, and whether the Catalyst CLI sets them.
- [Testing](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/reference/testing.md): Run Catalyst's Playwright UI tests and Vitest unit tests locally, and configure the test environment with .env.test.
- [Privacy and Security](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/reference/security.md): The BigCommerce certifications behind Catalyst, its default Content Security Policy, consent management, and Next.js framework security.
- [Catalyst + B2B Buyer Portal](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/experiments/b2b-edition.md): Experimental guide to integrating the B2B Edition Buyer Portal with a Catalyst storefront, including running the Buyer Portal locally.
- [Build an Integration](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/contributing/build-an-integration.md): Build a Catalyst integration with a third-party service and contribute it to the Catalyst repository as an integration branch based on canary.
- [Catalyst version 1.12.2 release notes](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/release-notes/1-12-2.md): Catalyst 1.12.2 keeps a separate cart for each channel, so a cart started on one channel no longer appears or checks out on another, and adds hosting and channel_id meta tags that identify a storefront's hosting and channel.
- [Catalyst version 1.12.1 release notes](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/release-notes/1-12-1.md): Catalyst 1.12.1 preserves the configured Auth.js session-token cookie attributes when the token is rewritten as a browser-session cookie, so storefronts using partitioned cookies no longer strand a duplicate session token that survives logout.
- [Catalyst version 1.12.0 release notes](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/release-notes/1-12-0.md): Catalyst 1.12.0 proxies the UCP agentic commerce endpoints through to BigCommerce so agents can reach them on the storefront domain, and stops the correlation ID header from making every Next.js Data Cache lookup miss.
- [Catalyst version 1.11.1 release notes](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/release-notes/1-11-1.md): Catalyst 1.11.1 upgrades Next.js to pick up two critical remote code execution advisories, applies control panel date limits to the PDP date picker, and gives the routing cache a shared Cloudflare Workers KV store on Native Hosting.
- [Catalyst version 1.11.0 release notes](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/release-notes/1-11-0.md): Catalyst 1.11.0 resolves locale subfolders at runtime, adds wallet payment buttons to the cart page, and fixes session, consent, and caching issues.
- [Catalyst version 1.10.1 release notes](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/release-notes/1-10-1.md): Catalyst 1.10.1 picks up the July 2026 Next.js security release, fixes localized content falling back to the default language after ISR revalidation, and restyles promotion callouts.
- [Catalyst version 1.10.0 release notes](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/release-notes/1-10-0.md): Catalyst 1.10.0 adds promotion callouts to homepage featured and newest product carousels.
- [Catalyst version 1.9.0 release notes](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/release-notes/1-9-0.md): Catalyst 1.9.0 adds product videos and promotion callouts to the PDP/PLP, respects control panel sort settings, and improves cart reliability.
- [Catalyst version 1.8.0 release notes](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/release-notes/1-8-0.md): Catalyst 1.8.0 adds tax-display support, locale URL paths, consent-aware cookie updates, and create-catalyst 1.1.0.
- [1.7.0](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/release-notes/1-7-0.md)
- [1.6.0](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/release-notes/1-6-0.md)
- [1.5.0](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/release-notes/1-5-0.md)
- [1.4.0](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/release-notes/1-4-0.md)
- [1.3.7](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/release-notes/1-3-7.md)
- [1.3.6](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/release-notes/1-3-6.md)
- [1.3.5](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/release-notes/1-3-5.md)
- [1.3.0](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/release-notes/1-3-0.md)
- [1.2.0](https://docs.bigcommerce.com/developer/docs/storefront/catalyst/release-notes/1-2-0.md)