amos-plugin-cli

1.2.0 verified Sat Apr 25 auth: no javascript

A CLI tool for installing, generating, and publishing plugins for the Amos framework (v1.2.0). It supports plugin lifecycle management including scaffolding, packaging, and distribution. Key features include configurable plugin sources, extensible copy commands (MF and UMD), and multi-source configuration (environment variables, .pluginsrc, package.json). Release cadence appears irregular. Differentiates from generic plugin managers by tight coupling with Amos framework conventions and support for Chinese-language documentation.

Common errors

error CLI_NOT_FOUND ↓

cause Module not installed globally or npx not used.

fix

Install globally: npm install -g amos-plugin-cli. Or run with npx: npx amos-plugin -v.

error CONFIG_FILE_MISSING ↓

cause .pluginsrc or package.json missing required config fields.

fix

Create .pluginsrc in project root with at least amos_plugin_site and amos_plugin_dir.

error PLUGIN_ARCHIVE_INVALID ↓

cause Plugin ZIP file corrupted or missing index.plugin.js.

fix

Re-package plugin with amos-plugin -p, ensuring project structure includes index.plugin.js.

Warnings

gotcha Environment variables (AMOS_PLUGIN_*) may conflict with other tools. Use .pluginsrc or package.json for isolation. ↓

fix Configure via .pluginsrc or package.json 'amosPluginConfig' instead of env vars.

deprecated The --mf and --umd options copy module federation/UMD files but their configuration format (mfrc/umdrc) changed in 1.1.x. ↓

fix Use .mfrc.json or .umdrc.js format. Check version-specific examples in README.

gotcha Plugin packaging (-p) only supports ZIP format despite config allowing other extensions. ↓

fix Ensure plugins are ZIP archives. Custom extensions only apply to remote plugin storage, not local packaging.

Install

npm install amos-plugin-cli

yarn add amos-plugin-cli

pnpm add amos-plugin-cli

Imports

amos-plugin
wrong
```
const amosPlugin = require('amos-plugin-cli')
```
correct
```
npx amos-plugin <command>
```
This is a CLI tool, not a library. Use npx or global install, not require().

Quickstart

Shows installation, scaffolding, packaging, and custom configuration of a plugin.

npm install -g amos-plugin-cli
# View help
amos-plugin -h
# Create a new plugin project scaffold
amos-plugin -t
# Package current plugin into a tarball (ZIP)
amos-plugin -p
# Install a plugin named 'hello' from configured site
amos-plugin hello
# Install with custom extension and site
amos-plugin hello --ext rar --amos-plugin-site http://localhost:3333/plugins