Vendure Documentation llms.txt · AI Docs Browser · mdream [llms.txt Tools](https://mdream.dev/llms-txt/vendure-documentation/llms-txt) # Vendure Documentation llms.txt Browse Vendure Documentation documentation as markdown. Click any page in the sidebar to view it, or copy the full llms.txt for your AI tools. www.vendure.io/llms.txt [Raw llms.txt](https://www.vendure.io/docs/llms.txt) [Raw llms-full.txt](https://www.vendure.io/llms-full.txt) Copy Markdown [](https://www.vendure.io/llms.txt) llms.txt Vendure Core (v3.x (Latest)) Installation Introducing GraphQL Try the API Core Concepts Pricing Products Promotions Assets Search Facets & Filters Collections Cart Payment Customers Orders Fulfillment Inventory Currency Zones Language Taxes User Management Roles Permissions Job Queue Healthchecks Auth Channels Email Shipping Overview The API Layer The Service Layer CLI AI-assisted Development Configuration Custom Fields Error Handling Events Migrations Plugins Security API Keys Strategies & Configurable Operations Testing Updating Worker & Job Queue Settings Store REST Endpoint Custom Permissions Database Entity Extend GraphQL API Custom Strategies in Plugins Channel Aware Translatable Has Custom Fields Cache Dataloaders DB Subscribers Importing Data Logging Scheduled Tasks Stand-alone Scripts Translations Uploading Files Nest DevTools Telemetry CMS Integration Plugin Codegen Configurable Products Digital Products GitHub OAuth Authentication Google OAuth Authentication Multi-vendor Marketplaces Paginated List Publish Plugin S3 Asset Storage Telemetry Getting Started Extending Overview Public API & Imports Creating Pages List Pages Detail Pages Tabbed Pages Customizing Pages Customizing List Pages Customizing Detail Pages Customizing Login Page Page Blocks Action Bar Items Toolbar Items Extension Targets Insights Widgets History Entries Customizing Forms Input Component Examples Relation Selector Components Navigation Alerts Data Fetching Theming Localization Deployment Tech Stack Migration Custom Providers Storefront Starters Connect API Codegen Navigation Menu Listing Products Product Detail Active Order Checkout Flow Customer Accounts Deployment Production Configuration Using Docker Horizontal Scaling Getting Data into Production Server Resource Requirements Deploying Admin UI Deploy to Northflank Deploy to Digital Ocean App Platform Deploy to Railway Deploy to Render Deploy to Google Cloud Run Getting Started UI Library Admin UI Theming & Branding Adding UI Translations Using Other Frameworks Nav Menu Alerts Add Actions to Pages Page Tabs Custom Form Inputs Custom Data Table Components Custom Detail Components Bulk Actions Dashboard Widgets Custom Timeline Components Defining Routes Creating List Views Creating Detail Views Migrating from v1 Reference TypeScript API Assets AssetNamingStrategy AssetOptions AssetPreviewStrategy AssetStorageStrategy DefaultAssetNamingStrategy Auth ApiKeyStrategy AuthenticationStrategy AuthOptions BcryptPasswordHashingStrategy CookieOptions CustomerChannelAssignmentStrategy DefaultPasswordValidationStrategy DefaultSessionCacheStrategy DefaultVerificationTokenStrategy EntityAccessControlStrategy ExternalAuthenticationService InMemorySessionCacheStrategy NativeAuthenticationStrategy NoopSessionCacheStrategy PasswordHashingStrategy PasswordValidationStrategy PermissionDefinition SessionCacheStrategy SuperadminCredentials VerificationTokenStrategy Cache CacheConfig CacheService CacheStrategy DefaultCachePlugin RedisCachePlugin RedisCacheStrategy RequestContextCacheService SelfRefreshingCache SqlCacheStrategy Common AsyncQueue Bootstrap CurrencyCode EntityRelationPaths I18nService ID InjectableStrategy Injector JobState JsonCompatible LanguageCode Middleware PaginatedList Permission PriceCalculationResult ProcessContext VENDURE_VERSION Admin Ui AdminUiAppConfig AdminUiAppDevModeConfig AdminUiConfig ConfigurableOperationDef ConfigArgs ConfigArgType ConfigurableOperationDefOptions DefaultFormComponentId DefaultFormConfigHash LocalizedStringArray Configuration ApiOptions CollectionFilter DefaultConfig DefaultSlugStrategy EntityDuplicator EntityId Decorator EntityIdStrategy EntityOptions MergeConfig ProductVariantPriceSelectionStrategy ProductVariantPriceUpdateStrategy RuntimeVendureConfig SettingsStoreFields SlugStrategy SystemOptions TrustProxyOptions VendureConfig CustomFields CustomFieldConfig CustomFieldType StructCustomFieldConfig StructFieldConfig TypedCustomSingleFieldConfig Data Access Calculated CalculatedPropertySubscriber EntityHydrator GetEntityOrThrowOptions HydrateOptions ListQueryBuilder TransactionalConnection DefaultSearchPlugin DefaultSearchPluginInitOptions MysqlSearchStrategy PostgresSearchStrategy SearchStrategy SqliteSearchStrategy Entities Address Administrator AnonymousSession ApiKey Asset AuthenticatedSession AuthenticationMethod Channel Collection Country Customer CustomerGroup CustomerHistoryEntry Facet FacetValue Fulfillment GlobalSettings HistoryEntry Interfaces Order OrderableAsset OrderHistoryEntry OrderLine OrderLineReference OrderModification Payment PaymentMethod Product ProductOption ProductOptionGroup ProductVariant ProductVariantPrice Promotion Province Refund Region Role Seller Session SettingsStoreEntry ShippingLine ShippingMethod StockLevel StockLocation StockMovement Surcharge Tag TaxCategory TaxRate User VendureEntity Zone Errors Error Types ErrorHandlerStrategy ErrorResultUnion I18nError IsGraphQlErrorResult Events BlockingEventHandlerOptions Event Types EventBus VendureEntityEvent VendureEvent Fulfillment FulfillmentHandler FulfillmentProcess FulfillmentState FulfillmentStates FulfillmentTransitionData Health Check HealthCheckError HealthCheckRegistryService HealthCheckStrategy HealthIndicator HealthIndicatorFunction HealthIndicatorResult HealthIndicatorStatus HttpHealthCheckStrategy TypeORMHealthCheckStrategy Import Export AssetImporter AssetImportStrategy DefaultAssetImportStrategy DefaultAssetImportStrategyOptions FastImporterService Importer ImportExportOptions ImportParser InitialData Populate Populator JobQueue DefaultJobQueuePlugin InMemoryJobBufferStorageStrategy InMemoryJobQueueStrategy InspectableJobQueueStrategy Job JobBuffer JobBufferStorageStrategy JobQueueOptions JobQueueService JobQueueStrategy PollingJobQueueStrategy SqlJobQueueStrategy SubscribableJob Types Logger DefaultLogger LogLevel VendureLogger Migration GenerateMigration MigrateAssetTranslationData MigrateProductOptionGroupData MigrationOptions RevertLastMigration RunMigrations Money BigIntMoneyStrategy DefaultMoneyStrategy Money Decorator MoneyStrategy RoundMoney Orders ActiveOrderService ActiveOrderStrategy ChangedPriceHandlingStrategy CustomOrderStates DefaultActiveOrderStrategy DefaultGuestCheckoutStrategy DefaultOrderItemPriceCalculationStrategy DefaultOrderPlacedStrategy DefaultStockAllocationStrategy GuestCheckoutStrategy Merge Strategies OrderByCodeAccessStrategy OrderCodeStrategy OrderInterceptor OrderItemPriceCalculationStrategy OrderLineDiscountDistributionStrategy OrderMergeStrategy OrderOptions OrderPlacedStrategy OrderProcess OrderSellerStrategy StockAllocationStrategy Payment DefaultPaymentProcess DefaultRefundProcess DummyPaymentHandler Payment Method Types PaymentMethodConfigOptions PaymentMethodEligibilityChecker PaymentMethodHandler PaymentOptions PaymentProcess PaymentState PaymentStates PaymentTransitionData RefundProcess RefundState RefundStates RefundTransitionData Plugin Plugin Utilities PluginCommonModule VendurePlugin VendurePluginMetadata Products Stock CatalogOptions DefaultProductVariantPriceCalculationStrategy DefaultStockDisplayStrategy DefaultStockLocationStrategy MultiChannelStockLocationStrategy ProductVariantPriceCalculationStrategy StockDisplayStrategy StockLocationStrategy Promotions FacetValueChecker Promotion Action Promotion Condition PromotionOptions Request Allow Decorator Api Decorator ApiType Ctx Decorator Relations Decorator RequestContext RequestContextService Transaction Decorator Scheduled Tasks CleanSessionsTask DefaultSchedulerPlugin DefaultSchedulerStrategy ScheduledTask SchedulerOptions SchedulerService SchedulerStrategy Service Helpers EntityDuplicatorService OrderCalculator OrderModifier ProductPriceApplicator SlugValidator TranslatableSaver TranslatorService Services AdministratorService AssetService AuthService ChannelService CollectionService CountryService CustomerChannelAssignmentService CustomerGroupService CustomerService EntitySlugService FacetService FacetValueService FulfillmentService GlobalSettingsService HistoryService InitializerService OrderService OrderTestingService PaymentMethodService PaymentService ProductOptionGroupService ProductOptionService ProductService ProductVariantService PromotionService ProvinceService RoleService SearchService SellerService SessionService SettingsStoreService ShippingMethodService SlugService StockLevelService StockLocationService StockMovementService TagService TaxCategoryService TaxRateService UserService ZoneService SettingsStore CleanupOrphanedSettingsStoreEntriesOptions CleanupOrphanedSettingsStoreEntriesResult OrphanedSettingsStoreEntry SetSettingsStoreValueResult SettingsStoreFieldConfig SettingsStoreRegistration SettingsStoreScopeFunction SettingsStoreScopes Shipping CheckShippingEligibilityCheckerFn DefaultShippingLineAssignmentStrategy ShippingCalculator ShippingEligibilityChecker ShippingEligibilityCheckerConfig ShippingLineAssignmentStrategy ShippingOptions ShouldRunCheckFn State Machine FSM StateMachineConfig Transitions Tax AddressBasedTaxZoneStrategy DefaultTaxLineCalculationStrategy DefaultTaxZoneStrategy OrderTaxCalculationStrategy TaxLineCalculationStrategy TaxOptions TaxZoneStrategy Telemetry Instrument InstrumentationStrategy TelemetryModule TelemetryService WrappedMethodArgs Testing CreateErrorResultGuard CreateTestEnvironment ErrorResultGuard GetSuperadminContext RegisterInitializer SimpleGraphQLClient TestConfig TestDbInitializer TestEnvironment TestingLogger TestServer TestServerOptions Worker BootstrapWorker VendureWorker WorkerHealthCheckConfig Core Plugins AdminUiPlugin AdminUiPluginOptions AssetServerPlugin AssetServerOptions CacheConfig HashedAssetNamingStrategy ImageTransformMode ImageTransformPreset ImageTransformStrategy LocalAssetStorageStrategy PresetOnlyStrategy S3AssetStorageStrategy SharpAssetPreviewStrategy DashboardPlugin DashboardPluginOptions EmailPlugin Email Plugin Types Email Utils EmailEventHandler EmailEventHandlerWithAsyncData EmailEventListener EmailGenerator EmailPluginOptions EmailSender EmailSendEvent TemplateLoader Transport Options GraphiQLPlugin HardenPlugin DefaultVendureComplexityEstimator HardenPluginOptions JobQueuePlugin BullMQJobQueuePlugin BullMQJobQueueStrategy BullMQPluginOptions TelemetryPlugin GetSdkConfiguration OtelLogger RegisterMethodHooks TelemetryPluginOptions Admin API Enums Input Objects Mutations Queries Types Shop API Enums Input Objects Mutations Queries Types Dashboard API Components AssetGallery AssetPickerDialog ChannelChip CopyableText DetailPageButton FacetValueChip FacetValueFacetedFilter FacetValueSelector PermissionGuard VendureImage Detail Views DetailPage UseDetailPage UseGeneratedForm Extensions Api ActionBar Alerts Custom Providers DataTables DefineDashboardExtension DetailForms FormComponents HistoryEntries Login Navigation Page Blocks Routes Toolbar Widgets Form Components AffixedInput BooleanInput CheckboxInput DateTimeInput FormFieldWrapper MoneyInput NumberInput PasswordInput RichTextInput SlugInput TextareaInput TextInput TranslatableFormFieldWrapper Hooks UseAlerts UseAuth UseChannel UseCustomFieldConfig UseDisplayLocale UseDragAndDrop UseFacetValueBrowser UseIsServerConfigLoaded UseLocalFormat UsePaginatedList UsePermissions UseSortedLanguages UseUiLanguageLoader UseWidgetFilters List Views Bulk Actions DataTable DataTableCellComponent ListPage PaginatedListDataTable PageLayout Page PageActionBar PageBlock PageTitle UsePageBlock Vite Plugin VendureDashboardPlugin Admin UI API Action Bar ActionBarContext ActionBarDropdownMenuItem ActionBarItem ActionBarLocationId AddActionBarDropdownMenuItem AddActionBarItem PageLocationId RouterLinkDefinition Alerts AlertConfig AlertContext RegisterAlert Bulk Actions BulkAction RegisterBulkAction Components AssetPickerDialogComponent ChipComponent CurrencyInputComponent DataTable2Component DataTableComponent DatetimePickerComponent DropdownComponent FacetValueSelectorComponent ObjectTreeComponent OrderStateLabelComponent ProductVariantSelectorComponent RichTextEditorComponent ZoneSelectorComponent Custom Detail Components CustomDetailComponent CustomDetailComponentConfig CustomDetailComponentLocationId RegisterCustomDetailComponent Custom History Entry Components CustomerHistoryEntryComponent HistoryEntryComponent HistoryEntryConfig OrderHistoryEntryComponent RegisterHistoryEntryComponent Custom Input Components Default Inputs FormInputComponent RegisterFormInputComponent Custom Table Components CustomColumnComponent DataTableComponentConfig RegisterDataTableComponent Dashboard Widgets DashboardWidgetConfig RegisterDashboardWidget SetDashboardWidgetLayout WidgetLayoutDefinition Directives IfMultichannelDirective IfPermissionsDirective List Detail Views BaseDetailComponent BaseEntityResolver BaseListComponent DetailComponentWithResolver TypedBaseDetailComponent TypedBaseListComponent Nav Menu AddNavMenuItem AddNavMenuSection Navigation Types NavMenuItem NavMenuSection Pipes AssetPreviewPipe DurationPipe FileSizePipe HasPermissionPipe LocaleCurrencyNamePipe LocaleCurrencyPipe LocaleDatePipe LocaleLanguageNamePipe LocaleRegionNamePipe TimeAgoPipe React Components ActionBar Card CdsIcon FormField Link PageBlock PageDetailLayout RichTextEditor React Extensions ReactCustomDetailComponentConfig ReactDataTableComponentConfig RegisterReactCustomDetailComponent RegisterReactDataTableComponent RegisterReactFormInputComponent RegisterReactRouteComponent RegisterReactRouteComponentOptions React Hooks UseDetailComponentData UseFormControl UseInjector UseLazyQuery UseMutation UsePageMetadata UseQuery UseRichTextEditor UseRouteParams Routes RegisterRouteComponent RegisterRouteComponentOptions Services DataService ModalService NotificationService Tabs PageTabConfig RegisterPageTab Ui Devkit AdminUiExtension CompileUiExtensions Helpers UiDevkitClient UiExtensionBuildCommand UiExtensionCompilerOptions UiExtensionCompilerProcessArgument User Guide Catalog Products Facets Collections Orders Orders Draft Orders Customers Promotions Settings Global Settings Administrators & Roles Channels Countries & Zones Payment Methods Shipping Methods Taxes Localization Community Plugins (v3.x (Latest)) BraintreePlugin BraintreePluginOptions ElasticsearchPlugin ElasticsearchOptions MolliePlugin MolliePluginOptions PubSubPlugin PubSubJobQueueStrategy PunchOutGatewayPlugin PunchOutGatewayPluginOptions SentryPlugin SentryPluginOptions SentryService StellatePlugin PurgeRule StellatePluginOptions StellateService StripePlugin StripePluginOptions ## What is Vendure Documentation's llms.txt? Vendure Documentation publishes an `/llms.txt` file that provides AI systems with a structured index of its documentation. It follows the [llms.txt specification](https://llmstxt.org), organizing links to guides, API references, and tutorials under section headings so that LLMs like ChatGPT, Claude, and Gemini can quickly understand what Vendure Documentation offers and where to find details. Pass Spec 2 Sections 849 Links 107.2 KB Size ~27.4k Tokens Sections: Vendure Core (v3.x (Latest)) · Community Plugins (v3.x (Latest)) ## Add Vendure Documentation Docs to Your AI Assistant Select your tool to see how to add Vendure Documentation's llms.txt as a documentation source. Cursor Windsurf Claude Code ChatGPT Zed Copilot 1. 1 Open any chat or composer panel 2. 2 Type @Docs and select "Add new doc" 3. 3 Paste the URL: https://www.vendure.io/llms.txt 4. 4 Wait for the green dot (indexing complete) 5. 5 Reference @Docs in chat when asking about Vendure Documentation Cursor crawls the URL and indexes all subpages. Add a trailing slash to index child pages too. ## Spec Compliance 3 notes ## Frequently Asked Questions Where is Vendure Documentation's llms.txt file? Vendure Documentation publishes its llms.txt at https://www.vendure.io/llms.txt. This file provides a structured, markdown-formatted index of Vendure Documentation's documentation that AI systems can consume to understand the project's APIs, guides, and references. How do I use Vendure Documentation's llms.txt with AI coding assistants? Copy the llms.txt content and paste it into your AI assistant (Cursor, Windsurf, Claude, ChatGPT) as context. This gives the AI an accurate map of Vendure Documentation's documentation so it can provide better code suggestions and answers about Vendure Documentation. What does Vendure Documentation's llms.txt contain? Vendure Documentation's llms.txt contains 2 sections and 849 documentation links in 107.2 KB (~27.4k tokens). Key sections include Vendure Core (v3.x (Latest)), Community Plugins (v3.x (Latest)). How many tokens does Vendure Documentation's llms.txt use? The concise llms.txt index is approximately 27.4k tokens (107.2 KB). Most AI assistants can fit this within their context window. For the full expanded documentation, look for an llms-full.txt variant which embeds all content inline. What is Vendure Documentation? Vendure is a headless commerce framework built on Node.js with TypeScript.. Vendure Documentation's llms.txt file helps AI systems understand this by providing a structured overview of its documentation, making it easier for developers to get accurate AI-assisted help when working with Vendure Documentation. Can I generate an llms.txt for my own project? Yes. Use the free llms.txt generator at mdream.dev/tools/llms-txt/generator to crawl your site and produce a spec-compliant llms.txt file. You can also validate existing files with the llms.txt validator. ## Browse More llms.txt Files [fast-check Documentation Complete documentation for fast-check - Property-based testing framework for JavaScript/TypeScript](https://mdream.dev/llms-txt/vendure-documentation/llms-txt/fast-check-documentation) [Medusa Digital commerce platform with a built-in framework](https://mdream.dev/llms-txt/vendure-documentation/llms-txt/medusa) [reveal.js Documentation Official documentation for reveal.js, the open source HTML presentation framework for building interactive slide decks on the web.](https://mdream.dev/llms-txt/vendure-documentation/llms-txt/reveal-js-documentation) [Upstash Serverless data platform for Redis and Kafka](https://mdream.dev/llms-txt/vendure-documentation/llms-txt/upstash) [Javalin Javalin is a lightweight web framework for Java and Kotlin. Version 7 (current) requires Java 17+ and runs on Jetty 12. All configuration - routes, handlers, plugins, lifecycle events - is passed upfront in a single config block when creating the instance.](https://mdream.dev/llms-txt/vendure-documentation/llms-txt/javalin) [Clerk Authentication and user management for developers](https://mdream.dev/llms-txt/vendure-documentation/llms-txt/clerk) [What is Datadog?](https://mdream.dev/llms-txt/vendure-documentation/llms-txt/datadoghq) [Mintlify Beautiful documentation that converts users](https://mdream.dev/llms-txt/vendure-documentation/llms-txt/mintlify) [View all 99 projects ](https://mdream.dev/llms-txt/vendure-documentation/llms-txt) ## Related Tools [

llms.txt Generator

Generate an llms.txt for your own project.](https://mdream.dev/llms-txt/vendure-documentation/tools/llms-txt/generator) [

llms.txt Validator

Validate your llms.txt against the official spec.](https://mdream.dev/llms-txt/vendure-documentation/tools/llms-txt/validator) © 2026 [Harlan Wilton](https://github.com/harlan-zw) · [MIT](https://github.com/harlan-zw/mdream/blob/main/license) [GitHub](https://github.com/harlan-zw/mdream) [Discord](https://discord.com/invite/275MBUBvgP)