Clarify Snaps CLI usage #1075
Merged
Clarify Snaps CLI usage #1075
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Preview published: 854-snaps-cli |
Mrtenz
reviewed
Jan 4, 2024
|
Preview published: 854-snaps-cli |
Montoya
reviewed
Jan 4, 2024
Montoya
reviewed
Jan 4, 2024
Montoya
reviewed
Jan 4, 2024
|
Preview published: 854-snaps-cli |
Montoya
reviewed
Jan 4, 2024
Montoya
requested changes
Jan 4, 2024
Montoya
approved these changes
Jan 4, 2024
mjsmike62
reviewed
Jan 4, 2024
| @@ -155,8 +148,9 @@ details the requirements of both `snap.manifest.json` and its relationship to `p | |||
| You might need to modify some manifest fields manually. | |||
| For example, if you change the location of the icon SVG file, you must update | |||
| `source.location.npm.iconPath` to match. | |||
| You can also use the [command line](../reference/cli/index.md) to update some fields for you. | |||
| For example, `mm-snap build` or `mm-snap manifest --fix` updates `source.shasum`. | |||
| You can also use the [Snaps CLI](../reference/cli/subcommands.md) to update some fields for you. | |||
There was a problem hiding this comment.
Maybe... "You can also use ... to update some fields.
mjsmike62
reviewed
Jan 4, 2024
| running `mm-snap manifest --fix` after creating your bundle. | ||
| You may also benefit from running `mm-snap eval` to detect any SES issues up front. | ||
| We recommend running [`yarn mm-snap manifest --fix`](../reference/cli/subcommands.md#m-manifest) | ||
| after creating your bundle to make sure your manifest `shasum` value is correct. |
There was a problem hiding this comment.
Maybe... to make sure = to ensure
mjsmike62
reviewed
Jan 4, 2024
|
|
||
| ## Specify options | ||
|
|
||
| You can specify options: |
There was a problem hiding this comment.
Not sure if this format is necessary. Maybe... "You can specify options either in the configuration file (...) or on the command line using ...
mjsmike62
approved these changes
Jan 4, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The recommended Snaps quickstart method is to use
@metamask/create-snap, which installs@metamask/snaps-clifor you when you create a new Snap. This PR clarifies the command required to run the documented CLI subcommands and options (yarn mm-snap ...), and also makes minor edits throughout the Snaps docs for clarity and consistency. Fixes #854.