Skip to content

Commit 942aedd

Browse files
author
Kelly Selden
committed
convert readme options to help output
1 parent 2d62a6a commit 942aedd

File tree

1 file changed

+31
-14
lines changed

1 file changed

+31
-14
lines changed

README.md

Lines changed: 31 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -70,20 +70,37 @@ ember-cli-update --run-codemods
7070

7171
## Options
7272

73-
| Option | Description | Type | Examples | Default |
74-
|---|---|---|---|---|
75-
| --blueprint | Provide a custom blueprint for use in the update | String | "@glimmer/blueprint" "git+https://[email protected]/tildeio/libkit.git" "../blueprint" | |
76-
| --from | Use a starting version that is different than what is in your package.json | String | "2.9.1" | |
77-
| --to | Update to a version that isn\'t latest | String | "2.14.1" "~2.15" "latest" "beta" | |
78-
| --resolve-conflicts | Automatically run git mergetool if conflicts found | Boolean | | false |
79-
| --run-codemods | Run codemods to help update your code | Boolean | | false |
80-
| --codemods-source | Supply your own codemods manifest via URL | String | "ember-app-codemods-manifest@*" "git+https://github.com/ember-cli/ember-app-codemods-manifest.git#semver:*" | |
81-
| --codemods-json | Supply your own codemods manifest via JSON | String | `{ /* json */ }` | |
82-
| --reset | Reset your code to the default blueprint at the new version | Boolean | | false |
83-
| --compare-only | Show the changes between different versions without updating | Boolean | | false |
84-
| --stats-only | Show all calculated values regarding your project | Boolean | | false |
85-
| --list-codemods | List available codemods | Boolean | | false |
86-
| --create-custom-diff | Create a personal diff using system .ember-cli | Boolean | | false |
73+
```
74+
--help Show help [boolean]
75+
--version Show version number [boolean]
76+
--blueprint, -b Provide a custom blueprint for use in the update
77+
("@glimmer/blueprint",
78+
"git+https://[email protected]/tildeio/libkit.git",
79+
"../blueprint") [string]
80+
--from Use a starting version that is different than
81+
what is in your package.json ("2.9.1") [string]
82+
--to Update to a version that isn't latest ("2.14.1",
83+
"~2.15", "latest", "beta") [string]
84+
--resolve-conflicts Automatically run git mergetool if conflicts
85+
found [boolean] [default: false]
86+
--run-codemods Run codemods to help update your code
87+
[boolean] [default: false]
88+
--codemods-source Supply your own codemods manifest via URL
89+
("ember-app-codemods-manifest@*",
90+
"git+https://github.com/ember-cli/ember-app-codem
91+
ods-manifest.git#semver:*") [string]
92+
--codemods-json Supply your own codemods manifest via JSON (`{ /*
93+
json */ }`) [string]
94+
--reset Reset your code to the default blueprint at the
95+
new version [boolean] [default: false]
96+
--compare-only Show the changes between different versions
97+
without updating [boolean] [default: false]
98+
--stats-only Show all calculated values regarding your project
99+
[boolean] [default: false]
100+
--list-codemods List available codemods[boolean] [default: false]
101+
--create-custom-diff, --ccd Create a personal diff using system .ember-cli
102+
[boolean] [default: false]
103+
```
87104

88105
## Power User Guide
89106

0 commit comments

Comments
 (0)