Initialize your app

Before initializing your App Builder application for App Management, ensure you have completed the prerequisites and have the required services configured.

Prerequisites

Complete the following steps before initializing your app:

Create a project in the Adobe Developer Console
Create a new project or use an existing one in the Adobe Developer Console.
Add required services
Add the following services to your project:
- I/O Management API. Required for App Builder runtime actions.
- I/O Events. Required only if your app uses events.
- I/O Events for Adobe Commerce. Required only if your app uses events.
- Adobe Commerce as a Cloud Service. Required only for Adobe Commerce as a Cloud Service instances.
Only add the services your app needs. This keeps your credentials scoped to the minimum required permissions.
Set up App Builder
Ensure you have the Adobe I/O CLI installed and configured.

Initialize

Run the following command to set up your App Builder project:

Unlike the commands in CLI commands below, init runs before the library is installed. At this point each package manager needs to use its fetch-and-run runner (npx, yarn dlx, pnpm dlx, bun x) rather than its exec-style equivalent, which only runs locally installed binaries. For the same reason, init references the library by its full registry name (@adobe/aio-commerce-lib-app), whereas later commands invoke the locally installed binary using the short name (aio-commerce-lib-app).

npm

yarn

pnpm

bun

npx @adobe/aio-commerce-lib-app init
Copied to your clipboard
npx @adobe/aio-commerce-lib-app init

# For Yarn classic (v1), install first
yarn add @adobe/aio-commerce-lib-app
yarn exec aio-commerce-lib-app init

# For Yarn Berry (v2+), pull directly from remote via `dlx`
yarn dlx @adobe/aio-commerce-lib-app init
Copied to your clipboard
# For Yarn classic (v1), install first
yarn add @adobe/aio-commerce-lib-app
yarn exec aio-commerce-lib-app init

# For Yarn Berry (v2+), pull directly from remote via `dlx`
yarn dlx @adobe/aio-commerce-lib-app init

pnpm dlx @adobe/aio-commerce-lib-app init
Copied to your clipboard
pnpm dlx @adobe/aio-commerce-lib-app init

bun x @adobe/aio-commerce-lib-app init
Copied to your clipboard
bun x @adobe/aio-commerce-lib-app init

The initialization process:

Creates app.commerce.config with a template (prompts you to choose format and features if the file doesn't exist)
Installs required dependencies (@adobe/aio-commerce-lib-app, @adobe/aio-commerce-sdk, and @adobe/aio-commerce-lib-config when business configuration is enabled)
Adds a postinstall hook to package.json
Generates all required artifacts (commerce/configuration/1 resources are only generated when businessConfig is defined)
Updates app.config.yaml and install.yaml with the appropriate extension references. Creates these files if they do not exist.

CLI commands

The library provides the following CLI commands. Replace npx with your package manager of preference, using the below equivalents:

For Yarn: yarn exec
For PNPM: pnpm exec
For Bun: bun x

Command	Description
`npx aio-commerce-lib-app generate all`	Generate all artifacts (manifest, schema, and runtime actions). If your schema contains password fields, configure an encryption key. An encryption key is generated when no encryption key is found. See Password field encryption for more information
`npx aio-commerce-lib-app generate manifest`	Generate only the app manifest file
`npx aio-commerce-lib-app generate actions`	Generate only runtime actions
`npx aio-commerce-lib-app generate schema`	Generate only the configuration schema

Update the library

When a new version of the library is available, update your project to get the latest features and fixes:

npm

yarn

pnpm

bun

npm install @adobe/aio-commerce-lib-app@latest @adobe/aio-commerce-sdk@latest
Copied to your clipboard
npm install @adobe/aio-commerce-lib-app@latest @adobe/aio-commerce-sdk@latest

yarn add @adobe/aio-commerce-lib-app@latest @adobe/aio-commerce-sdk@latest
Copied to your clipboard
yarn add @adobe/aio-commerce-lib-app@latest @adobe/aio-commerce-sdk@latest

pnpm add @adobe/aio-commerce-lib-app@latest @adobe/aio-commerce-sdk@latest
Copied to your clipboard
pnpm add @adobe/aio-commerce-lib-app@latest @adobe/aio-commerce-sdk@latest

bun add @adobe/aio-commerce-lib-app@latest @adobe/aio-commerce-sdk@latest
Copied to your clipboard
bun add @adobe/aio-commerce-lib-app@latest @adobe/aio-commerce-sdk@latest

If you use a business configuration, also run the following command:

npm

yarn

pnpm

bun

npm install @adobe/aio-commerce-lib-config@latest
Copied to your clipboard
npm install @adobe/aio-commerce-lib-config@latest

yarn add @adobe/aio-commerce-lib-config@latest
Copied to your clipboard
yarn add @adobe/aio-commerce-lib-config@latest

pnpm add @adobe/aio-commerce-lib-config@latest
Copied to your clipboard
pnpm add @adobe/aio-commerce-lib-config@latest

bun add @adobe/aio-commerce-lib-config@latest
Copied to your clipboard
bun add @adobe/aio-commerce-lib-config@latest

The postinstall hook regenerates runtime actions when you install or update the library.

Overview

Define your app

Last updated 4/24/2026

Was this helpful?

Yes

Initialize your app

Prerequisites.css-83mclq{margin-left:var(--spectrum-global-dimension-size-100);}

Initialize

CLI commands

Update the library

Prerequisites