Installation
System Requirements
- Node.js v24.x.x or later
- Docker (optional, needed for CLI docker command)
tip
Configure access to Archibald Gitlab package repository
For more information visit Personal access tokens and npm packages in the Package Registry.
npm config set @archibald:registry https://gitlab.com/api/v4/projects/24249911/packages/npm/
npm config set //gitlab.com/api/v4/projects/24249911/packages/npm/:_authToken <your_token>
Available Packages
| Package | Description |
|---|---|
| @archibald/analytics | Tracking functionality for shops |
| @archibald/auth | Authentication functionality for shops |
| @archibald/build | Build tooling (rspack config, shadowing loaders) |
| @archibald/cart | Cart functionality for shops |
| @archibald/cli | Command Line Interface (CLI) for using Archibald |
| @archibald/client | Common functionality needed on Client |
| @archibald/cms | Generic functionality to connect to a CMS |
| @archibald/codemod | Codemods to have easier transition between major versions |
| @archibald/config | Loading and writing of config functionality |
| @archibald/core | General purpose functionality |
| @archibald/create | Create a new project using predefined templates |
| @archibald/di | Dependency Injection on the server |
| @archibald/e2e | Shared end-to-end testing support (used by archibald e2e) |
| @archibald/helpers | Shared helper utilities |
| @archibald/log | Logging functionality for all platforms |
| @archibald/native | Set of functionalities for building mobile apps |
| @archibald/personalization | Personalization functionality |
| @archibald/product | Product & Review functionality for shops |
| @archibald/quotes | B2B Quotes functionality for shops |
| @archibald/search | Search functionality for shops |
| @archibald/server | Functionality needed on NodeJS |
| @archibald/storage | Storage abstractions |
| @archibald/storefront | Functionality needed for building storefronts |
| @archibald/testing | Functionality for testing purposes |
Available Integrations
| Package | Description |
|---|---|
| @archibald/cdc | Provider, Adapter and Services for SAP CDC |
| @archibald/commerce | Provider, Adapter and Services for SAP Commerce |
| @archibald/contentful | Provider, Adapter and Services for Contentful |
| @archibald/coveo | Provider, Adapter and Services for Coveo |
| @archibald/cypress | Config and helpers for Cypress end-to-end testing |
| @archibald/growthbook | Provider, Adapter and Services for Growthbook |
| @archibald/maestro | Config and helpers for Maestro mobile end-to-end testing |
| @archibald/playwright | Config and helpers for Playwright end-to-end testing |
| @archibald/storybook | Functionality needed for building storybook |
| @archibald/vercel | Config and helpers for Vercel integration |