You can find the latest version of MetaMask on our official website. For help using MetaMask, visit our User Support Site.
For up to the minute news, follow our Twitter or Medium pages.
To learn how to develop MetaMask-compatible applications, visit our Developer Docs.
To learn how to contribute to the MetaMask project itself, visit our Internal Docs.
- Install Node.js version 8 and the latest available npm@6
- If you are using nvm (recommended) running
nvm use
will automatically choose the right node version for you.
- If you install Node.js manually, ensure you're using npm@6
- Install npm@6 using
npm install -g npm@6
- Install dependencies:
npm install
- If you have issues with node-sass compilation, try
npm rebuild node-sass
- Install gulp globally with
npm install -g gulp-cli
.
- Build the project to the
./dist/
folder with gulp build
.
- Optionally, to rebuild on file changes, run
gulp dev
.
- To package .zip files for distribution, run
gulp zip
, or run the full build & zip with gulp dist
.
Uncompressed builds can be found in /dist
, compressed builds can be found in /builds
once they're built.
You can read our internal docs here.
You can re-generate the docs locally by running npm run doc
, and contributors can update the hosted docs by running npm run publish-docs
.
Requires mocha
installed. Run npm install -g mocha
.
Then just run npm test
.
You can also test with a continuously watching process, via npm run watch
.
You can run the linter by itself with gulp lint
.
To write tests that will be run in the browser using QUnit, add your test files to test/integration/lib
.