# mm-plugin > MetaMask plugin development CLI. Latest version **0.3.13** (published 2019-11-06) · ISC license · 0 weekly downloads > **Deprecated.** This package is deprecated. ## Install ```sh npm install mm-plugin pnpm add mm-plugin yarn add mm-plugin bun add mm-plugin ``` Provides the command `mm-plugin`. ## Health **Score 10/100 (F)** — status: deprecated. Negative: deprecated. ## Facts | | | |---|---| | Version | 0.3.13 | | Published | 2019-11-06 | | First published | 2019-10-10 | | Weekly downloads | 0 | | License | ISC | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 13 | | Unpacked size | 167.9 KB | | Known vulnerabilities | 0 (+2 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 39 | | Author | Erik Marks | | Maintainers | rekmarks | ## Links - npm: https://www.npmjs.com/package/mm-plugin - Repository: https://github.com/MetaMask/mm-plugin - Homepage: https://github.com/MetaMask/mm-plugin#readme - Issues: https://github.com/MetaMask/mm-plugin/issues - npm.io page: https://npm.io/package/mm-plugin ## Dependencies (13) - [ses](https://npm.io/package/ses.md) ^0.6.4 - [rfdc](https://npm.io/package/rfdc.md) ^1.1.4 - [yargs](https://npm.io/package/yargs.md) ^14.0.0 - [is-url](https://npm.io/package/is-url.md) ^1.2.4 - [terser](https://npm.io/package/terser.md) ^4.3.1 - [babelify](https://npm.io/package/babelify.md) ^10.0.0 - [chokidar](https://npm.io/package/chokidar.md) ^3.0.2 - [browserify](https://npm.io/package/browserify.md) ^16.3.0 - [@babel/core](https://npm.io/package/@babel/core.md) ^7.5.5 - [serve-handler](https://npm.io/package/serve-handler.md) ^6.1.1 - [fast-deep-equal](https://npm.io/package/fast-deep-equal.md) ^2.0.1 - [@babel/preset-env](https://npm.io/package/@babel/preset-env.md) ^7.5.5 - [init-package-json](https://npm.io/package/init-package-json.md) ^1.10.3 ## Recent versions - 0.3.13 (latest) — 2019-11-06 - 0.3.12 — 2019-11-05 - 0.3.11 — 2019-11-04 - 0.3.10 — 2019-11-04 - 0.3.9 — 2019-11-01 - 0.3.8 — 2019-10-31 - 0.3.7 — 2019-10-31 - 0.3.6 — 2019-10-31 - 0.3.5 — 2019-10-31 - 0.3.4 — 2019-10-28 - 0.3.3 — 2019-10-22 - 0.3.2 — 2019-10-22 - 0.3.1 — 2019-10-10 ## README # MetaMask Plugin Utility A CLI for developing MetaMask plugins. ## Installation Always use `node@10.16.3`, the version currently used to develop MetaMask. We recommend [NVM](https://github.com/nvm-sh/nvm) for managing Node versions. To install and access the examples (recommended): 1. `git clone git@github.com:MetaMask/mm-plugin.git` 2. `cd mm-plugin` 3. `npm link` You can also simply install globally: `npm install -g mm-plugin` ## Basic Usage ```bash mkdir myPlugin cd myPlugin mm-plugin init ``` ## MetaMask Plugins MetaMask plugins consist of two things: a JSON manifest and a JavaScript bundle. For a variety of reasons, we decided to follow NPM conventions. Thus, the manifest file is simply `package.json`, with the following required standard fields: - `name` - `version` - `description` - `main` (relative path to source entry point, not the bundle) - `repository` In addition, we use the following, required custom fields: - `web3Wallet` (`object`) - `bundle` (`object`) - `local` (`string`; relative path to bundle) - `url` (`string`; absolute URL to bundle) - Set to e.g. `localhost:8081/dist/bundle.js` for local development. - `initialPermissions` (`{ string: object }`; permissions to be requested on plugin installation) - See [this interface](https://github.com/MetaMask/rpc-cap#requestpermissions-irequestedpermissions) and examples in this repo for details. If you exclude any required fields from `package.json`, your plugin may not work properly or install at all. We recommend building your plugin using this tool. You can bundle your plugin using your own tools, but it must run in the browser, run in SES, and its contents must be wrapped in an anonymous function (`() => ( ... )`). ### Assumed Project Structure This tool has default arguments assuming the following project structure: ``` . |- index.js |- dist/ |-- bundle.js |- ... (all other project files and folders) ``` Source files other than `index.js` are located through its imports. The defaults can be overwritten using the `mm-plugin.config.json` config file, [see below](#configuration-file). ### Permissions This module uses permissions as defined in [`rpc-cap`, MetaMask's JSON RPC capabilities middleware](https://github.com/MetaMask/rpc-cap). See examples in this repo for details. ## Usage Always use `node@10.16.3`, the version currently used to develop MetaMask. `mm-plugin --help` ``` Usage: mm-plugin [options] Commands: mm-plugin init Initialize plugin package [aliases: i] mm-plugin build Build plugin from source [aliases: b] mm-plugin eval Attempt to evaluate plugin bundle in SES [aliases: e] mm-plugin manifest Validate project package.json as a plugin manifest [aliases: m] mm-plugin serve Locally serve plugin file(s) for testing [aliases: s] mm-plugin watch Build plugin on change [aliases: w] Options (build): --help, -h Show help [boolean] --src, -s Source file [string] [required] [default: "index.js"] --dist, -d Output directory [string] [required] [default: "dist/"] --outfileName, -n Output file name [string] [default: "bundle.js"] --sourceMaps Whether building outputs sourcemaps [boolean] [default: false] --port, -p Local server port for testing [number] [required] [default: 8081] --eval, -e Attempt to evaluate plugin bundle in SES [boolean] [default: true] --manifest, -m Validate project package.json as a plugin manifest [boolean] [default: true] --populate Update plugin manifest properties of package.json [boolean] [default: true] --verboseErrors, -v, --verbose Display original errors [boolean] [default: false] --suppressWarnings, -w Suppress warnings [boolean] [default: false] Examples: mm-plugin init Initialize plugin package from scratch mm-plugin build -s index.js -d out Build 'plugin.js' as './out/bundle.js' mm-plugin build -s index.js -d out -n Build 'plugin.js' as plugin.js './out/plugin.js' mm-plugin serve -r out Serve files in './out' on port 8080 mm-plugin serve -r out -p 9000 Serve files in './out' on port 9000 mm-plugin watch -s index.js -d out Rebuild './out/bundle.js' on changes to files in 'index.js' parent and child directories ``` ### Usage Notes - Commands - `watch --src ... --dist ...` rebuilds on all changes in the parent directory of `src` and its children except: - `node_modules/` - `test/` and `tests/` - The specified `dist` directory - Dotfiles - `serve --root ... --port ...` serves the `root` directory on `localhost:port` - By default, `root` serves the current working directory: `.` - Arguments - `src`, `plugin`, and `outfileName` must be file paths when specified - `dist` and `root` must be directory paths when specified ### Configuration File `mm-plugin.config.json` can be placed in the project root directory. It should have string keys matching command arguments. Values become argument defaults, which can still be overriden on the command line. Example: ```json { "src": "src", "dist": "plugins", "port": 9000 } ``` --- _Source: https://npm.io/package/mm-plugin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._