ambleloft
Download中 / EN
Docs / API reference

CLI and release checks

Understand each command from project creation to archive validation, including its scope and success criteria.

API REFERENCE

Browse contracts, signatures, fields and examples. Unspecified defaults are not inferred.

On this page

01Scaffold options

First complete local package setup in the first-extension guide. Run from extension-work with AMBLELOFT_PACKS still set. The CLI does not install dependencies.

Code example
npx --no-install amble-extension init my-app --name my-app --template expense
cd my-app
npm install --save-dev "$AMBLELOFT_PACKS/ambleloft-extension-sdk-0.1.0-alpha.9.tgz" "$AMBLELOFT_PACKS/ambleloft-extension-core-0.1.0-alpha.9.tgz" "$AMBLELOFT_PACKS/ambleloft-extension-cli-0.1.0-alpha.9.tgz"
npm run build
npm run validate
npm run pack

02validate / pack

Run the locally installed CLI. validate does not execute extension code. pack takes a prepared directory and requires an output outside that directory ending in .amble-extension. Existing output is preserved unless --force is used.

Code example
npx amble-extension validate dist/package --json
npx amble-extension pack dist/package dist/my-app.amble-extension --json
npx amble-extension validate dist/my-app.amble-extension --json
Field / APIContract
Exit 0 / 1 / 2Success / validation or execution failure / command syntax error.
--jsonStructured output for validate, pack and doctor.
--Separates options from paths beginning with -.

03doctor checks source compatibility

--host points to host source, not a running app. Matching capability baselines is not proof of runtime success; runtimeStatus: not-tested must not be reported as a passed host test.

Code example
npx amble-extension doctor --host ../Ambleloft \
  --require operations,declarativeForms,localMessages --json
Field / APIContract
Available capability IDsoperations, configuration, localMessages, declarativeForms, mcpApps, messageActions, extensionAuthentication. agentHooks, conversationTurns, backgroundJobs (M2 source preview).
UnavailableformResumeApi; there is no extensionIcons capability ID.

04Release acceptance matrix

CLI does not install, grant trust, sign in or publish to a marketplace. Record host and SDK/CLI versions, archive validation output and runtime acceptance results.

Field / APIContract
PackagePackage icons, Skills, YAML, pages and licenses; validate the archive.
InteractionChinese/English, light/dark theme, keyboard, empty inputs and limits.
Business writesCancellation, timeout, lost response after write, recovery and idempotency.
MessagesDuplicate/out-of-order events, reconnect, withdrawal, preferences and action outcomes.

05Internal alpha.9 Hook validation

Schema and CLI checks cover Hook events, permissions, entry points and handler conflicts. doctor validates source capabilities, not actual grants, model jobs or restart behavior.

Code example
npx --no-install amble-extension doctor --host /path/to/agent --require agentHooks,conversationTurns,backgroundJobs --json
SDK / CLI 0.1.0-alpha.9 · Contract baseline Compatibility and preview notes · Sample source