appbuilder-connector-interactive-onboarding
v1.0.0
Published
Interactive script to set up Adobe App Builder connector projects
Readme
appbuilder-connector-interactive-onboarding
Interactive CLI that automates Adobe App Builder connector project setup. Run one command, answer a few prompts, get a fully configured connector project.
What it does
Instead of remembering and running 5+ separate aio commands, you run:
npx appbuilder-connector-interactive-onboardingThe CLI walks you through:
- Prerequisites — checks Node.js 20+, npm, and aio CLI (auto-installs aio if missing)
- Authentication — opens browser for Adobe login
- Organization — lists your orgs, you pick one
- Project — lists projects (or create a new one)
- Workspace — pick Stage, Production, etc.
- Connector Type — pick Translation, Commerce, etc. (maps to template internally)
- Target Directory — where to create the project
- Scaffold — runs
aio app initwith your connector template, configures.aioand.env - Install — runs
npm install - Next step — start dev server, deploy, or exit
Requirements
- Node.js >= 20
- npm
- Adobe Developer Console access with Developer or System Admin role
The @adobe/aio-cli is installed automatically if not present.
Usage
From npx (no install needed)
npx appbuilder-connector-interactive-onboardingFrom source
cd appbuilder-connector-interactive-onboarding
npm install
npm startConnector Types
The CLI supports these connector types:
| Connector Type | Template |
|---|---|
| Translation | @adobe/generator-app-connector-translation |
| Commerce | @adobe/generator-app-connector-commerce |
To add new connector types, edit src/connectors.js.
How it works
The CLI wraps these aio commands under the hood:
| Phase | Command |
|---|---|
| Auth | aio auth login |
| Org/Project/Workspace | aio console org list --json, aio console org select <id>, etc. |
| Pre-seed config | aio app use --merge --no-input (before init) |
| Scaffold | aio app init <dir> --template <name> --yes --import <config> |
| Dev/Run/Deploy | aio app dev, aio app run, aio app deploy |
You never need to run these manually. The CLI orchestrates the full sequence.
Key Implementation Detail
The CLI runs aio app use --merge --no-input before aio app init. This is required because some template generators (like asset-compute) read .aio and .env during their own install phase. The --import flag in aio app init is processed too late.
