@archilogic/create-extension-sdk
v0.1.1
Published
Create a new Archilogic extension
Keywords
Readme
@archilogic/create-extension-sdk
Scaffold a hello world Archilogic extension in seconds.
Usage
npm create @archilogic/extension-sdk
# or with a project name
npm create @archilogic/extension-sdk my-extension
# or as a worker extension (no UI)
npm create @archilogic/extension-sdk my-extension -- --workerBy default a Vue-based editor extension is created. Pass --worker to scaffold a headless worker extension instead.
Generated structure
Editor extension (default)
my-extension/
├── src/
│ ├── index.ts # mounts the Vue app into the editor panel
│ └── Plugin.vue # hello world component
├── manifest.json # host: "editor"
├── package.json
├── tsconfig.json
└── vite.config.tsWorker extension (--worker)
my-extension/
├── src/
│ └── index.ts # run() function returning data
├── manifest.json # host: "worker"
├── package.json
├── tsconfig.json
└── vite.config.tsNext steps after scaffolding
cd my-extension
npm install
npm run buildnpm run build compiles the extension and produces a ready-to-upload zip:
my-extension/
└── artifacts/
└── my-extension-0.1.0.zip # manifest.json + dist/ bundled togetherUpload the zip to your Archilogic workspace to install the extension.
