-
Notifications
You must be signed in to change notification settings - Fork 12k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(@angular-devkit/schematics-cli): Add README
This commit adds a README for the package. (cherry picked from commit 07bf174)
- Loading branch information
Showing
2 changed files
with
50 additions
and
1 deletion.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
# Schematics CLI | ||
|
||
This package contains the executable for running a [Schematic](/packages/angular_devkit/schematics/README.md). | ||
|
||
# Usage | ||
|
||
``` | ||
$ schematics [CollectionName:]SchematicName [options, ...] | ||
By default, if the collection name is not specified, use the internal collection provided | ||
by the Schematics CLI. | ||
Options: | ||
--debug Debug mode. This is true by default if the collection is a relative | ||
path (in that case, turn off with --debug=false). | ||
--allow-private Allow private schematics to be run from the command line. Default to | ||
false. | ||
--dry-run Do not output anything, but instead just show what actions would be | ||
performed. Default to true if debug is also true. | ||
--force Force overwriting files that would otherwise be an error. | ||
--list-schematics List all schematics from the collection, by name. A collection name | ||
should be suffixed by a colon. Example: '@angular-devkit/schematics-cli:'. | ||
--no-interactive Disables interactive input prompts. | ||
--verbose Show more information. | ||
--help Show this message. | ||
Any additional option is passed to the Schematics depending on its schema. | ||
``` | ||
|
||
# Examples | ||
|
||
1. Create a new NPM package that contains a blank schematic. | ||
|
||
```sh | ||
$ schematics blank <name> | ||
``` | ||
|
||
2. Walkthrough example that demonstrates how to build a schematic. | ||
|
||
```sh | ||
$ schematics schematic --name <name> | ||
``` |
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