https://github.com/metamask/template-sync
Synchronise a Git repository with the MetaMask module template repository.
https://github.com/metamask/template-sync
Last synced: 7 months ago
JSON representation
Synchronise a Git repository with the MetaMask module template repository.
- Host: GitHub
- URL: https://github.com/metamask/template-sync
- Owner: MetaMask
- License: mit
- Created: 2023-04-21T19:15:40.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-31T14:18:04.000Z (10 months ago)
- Last Synced: 2025-06-23T09:45:43.050Z (7 months ago)
- Language: TypeScript
- Homepage:
- Size: 1.14 MB
- Stars: 8
- Watchers: 64
- Forks: 3
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# `@metamask/template-sync`
Synchronise a local repository with `metamask-module-template` with an
easy-to-use CLI tool.
- Copies all files from `metamask-module-template` to the local repository.
- Updates the `package.json` file with the latest dependencies and scripts.
- Checks for any conflicts, and prompts the user to resolve them.
## Usage
```sh
npx @metamask/template-sync
```
```
Options:
--help Show help [boolean]
--version Show version number [boolean]
-c, --check Whether to only check for changes compared to the template.
When this is enabled, no files will be modified.
[boolean] [default: false]
```
## Caveats
- Existing files cannot be merged, and will be either skipped or overwritten.
- This does not apply to the `package.json` file, which will be merged with
the latest dependencies and scripts.
- Certain files (such as `CHANGELOG.md`, `LICENSE`, and `README.md`) are
skipped, as they are not intended to be updated by this tool.