Skip to content

Commit a050b12

Browse files
Update command docs to reflect new command tree (#173)
1 parent b52306f commit a050b12

File tree

3 files changed

+19
-19
lines changed

3 files changed

+19
-19
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -140,11 +140,11 @@ Here is a detailed list of the available `adr` commands:
140140

141141
`adr templates` - Manipulate ADR Templates & ADR Template Packages. Root command for template operations. Will list available sub-commands.
142142

143-
`adr templates default show` - Displays the detailed metadata of the current default ADR Template.
143+
`adr templates show` - Displays the detailed metadata of the current default ADR Template.
144144

145-
`adr templates default show --id-only` - Displays the id of the current default ADR Template.
145+
`adr templates show --id-only` - Displays the id of the current default ADR Template.
146146

147-
`adr templates default set <TEMPLATE ID>` - Sets the default ADR Template. The `<TEMPLATE ID>` can be obtained from `adr templates default show`
147+
`adr templates set <TEMPLATE ID>` - Sets the default ADR Template. The `<TEMPLATE ID>` can be obtained from `adr templates show`
148148

149149
`adr templates list` - Displays a table containing the detailed metadata of all ADR Templates contained in the current default ADR Template Package.
150150

@@ -208,7 +208,7 @@ ADR using the Alexandrian [Pattern Language Approach](https://en.wikipedia.org/w
208208

209209
Source [Joel Parker Henderson](https://github.com/joelparkerhenderson/architecture-decision-record/), see this [issue about licensing](https://github.com/joelparkerhenderson/architecture-decision-record/issues/30).
210210

211-
Set as the default template using `adr templates default set alexandrian`
211+
Set as the default template using `adr templates set alexandrian`
212212

213213
#### Business Case Pattern
214214
Emphasizes creating a business case for a decision, including criteria, candidates, and costs, [created by Joel Parker Henderson](https://github.com/joelparkerhenderson/architecture-decision-record/blob/main/templates/decision-record-template-for-business-case/index.md), which distils the decision record into the following headings:
@@ -226,7 +226,7 @@ Emphasizes creating a business case for a decision, including criteria, candidat
226226

227227
Source [Joel Parker Henderson](https://github.com/joelparkerhenderson/architecture-decision-record/), see this [issue about licensing](https://github.com/joelparkerhenderson/architecture-decision-record/issues/30).
228228

229-
Set as the default template using `adr templates default set business-case`
229+
Set as the default template using `adr templates set business-case`
230230

231231
#### Markdown Architectural Decision Records (MADR)
232232
Architectural Decisions using Markdown and Architectural Decision Records, by [Oliver Kopp](https://adr.github.io/madr/), which distils the decision record into the following headings:
@@ -246,7 +246,7 @@ Architectural Decisions using Markdown and Architectural Decision Records, by [O
246246

247247
[Available](https://adr.github.io/madr/) as dual-license under [MIT](https://opensource.org/licenses/MIT) and [CC0](https://creativecommons.org/share-your-work/public-domain/cc0/). You can choose between one of them if you use this work.
248248

249-
Set as the default template using `adr templates default set madr`
249+
Set as the default template using `adr templates set madr`
250250

251251
#### Merson Pattern
252252
An adaptation of the [Nygard pattern](#nygard-pattern), by [Paulo Merson](https://github.com/pmerson/ADR-template) which adds the rationale behind the decision. It distils the decision record into the following headings:
@@ -259,7 +259,7 @@ An adaptation of the [Nygard pattern](#nygard-pattern), by [Paulo Merson](https:
259259

260260
[Available](https://github.com/pmerson/ADR-template) under the [MIT License](https://github.com/pmerson/ADR-template/blob/master/LICENSE).
261261

262-
Set as the default template using `adr templates default set merson`
262+
Set as the default template using `adr templates set merson`
263263

264264
#### Nygard Pattern
265265
A simple, low-friction "Agile" ADR approach by [Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions), which distils the decision record into the following headings:
@@ -272,7 +272,7 @@ A simple, low-friction "Agile" ADR approach by [Michael Nygard](http://thinkrele
272272

273273
[Available](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions) under [CC0 1.0 Universal (CC0 1.0) Public Domain Dedication](https://creativecommons.org/publicdomain/zero/1.0/).
274274

275-
Set as the default template using `adr templates default set nygard`
275+
Set as the default template using `adr templates set nygard`
276276

277277
#### Planguage Pattern
278278
A Quality Assurance oriented approach by [John Terzakis](http://www.iaria.org/conferences2012/filesICCGI12/Tutorial%20Specifying%20Effective%20Non-func.pdf), which distils the decision record into the following headings:
@@ -295,7 +295,7 @@ A Quality Assurance oriented approach by [John Terzakis](http://www.iaria.org/co
295295

296296
Source [Joel Parker Henderson](https://github.com/joelparkerhenderson/architecture-decision-record/), see this [issue about licensing](https://github.com/joelparkerhenderson/architecture-decision-record/issues/30).
297297

298-
Set as the default template using `adr templates default set planguage`
298+
Set as the default template using `adr templates set planguage`
299299

300300
#### Tyree and Akerman Pattern
301301
ADR approach by [Jeff Tyree and Art Akerman](https://personal.utdallas.edu/~chung/SA/zz-Impreso-architecture_decisions-tyree-05.pdf), Capital One Financial, which distils the decision record into the following headings:
@@ -318,7 +318,7 @@ ADR approach by [Jeff Tyree and Art Akerman](https://personal.utdallas.edu/~chun
318318

319319
Source [Joel Parker Henderson](https://github.com/joelparkerhenderson/architecture-decision-record/), see this [issue about licensing](https://github.com/joelparkerhenderson/architecture-decision-record/issues/30).
320320

321-
Set as the default template using `adr templates default set tyree-ackerman`
321+
Set as the default template using `adr templates set tyree-ackerman`
322322

323323
### ADR Templates and ADR Template Packages
324324

@@ -400,7 +400,7 @@ To see the currently set default package, use:
400400

401401
To see the id of the currently set default template, use:
402402

403-
`adr templates default show`
403+
`adr templates show`
404404

405405
To revert to the "official" ADT Template Package you can either, reset the environment:
406406

Solutions/Endjin.Adr.Templates/NuGet.Readme.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ ADR using the Alexandrian [Pattern Language Approach](https://en.wikipedia.org/w
2424

2525
Source [Joel Parker Henderson](https://github.com/joelparkerhenderson/architecture-decision-record/), see this [issue about licensing](https://github.com/joelparkerhenderson/architecture-decision-record/issues/30).
2626

27-
Set as the default template using `adr templates default set alexandrian`
27+
Set as the default template using `adr templates set alexandrian`
2828

2929
#### Business Case Pattern
3030
Emphasizes creating a business case for a decision, including criteria, candidates, and costs, [created by Joel Parker Henderson](https://github.com/joelparkerhenderson/architecture-decision-record/blob/main/templates/decision-record-template-for-business-case/index.md), which distils the decision record into the following headings:
@@ -42,7 +42,7 @@ Emphasizes creating a business case for a decision, including criteria, candidat
4242

4343
Source [Joel Parker Henderson](https://github.com/joelparkerhenderson/architecture-decision-record/), see this [issue about licensing](https://github.com/joelparkerhenderson/architecture-decision-record/issues/30).
4444

45-
Set as the default template using `adr templates default set business-case`
45+
Set as the default template using `adr templates set business-case`
4646

4747
#### Markdown Architectural Decision Records (MADR)
4848
Architectural Decisions using Markdown and Architectural Decision Records, by [Oliver Kopp](https://adr.github.io/madr/), which distils the decision record into the following headings:
@@ -62,7 +62,7 @@ Architectural Decisions using Markdown and Architectural Decision Records, by [O
6262

6363
[Available](https://adr.github.io/madr/) as dual-license under [MIT](https://opensource.org/licenses/MIT) and [CC0](https://creativecommons.org/share-your-work/public-domain/cc0/). You can choose between one of them if you use this work.
6464

65-
Set as the default template using `adr templates default set madr`
65+
Set as the default template using `adr templates set madr`
6666

6767
#### Merson Pattern
6868
An adaptation of the [Nygard pattern](#nygard-pattern), by [Paulo Merson](https://github.com/pmerson/ADR-template) which adds the rationale behind the decision. It distils the decision record into the following headings:
@@ -75,7 +75,7 @@ An adaptation of the [Nygard pattern](#nygard-pattern), by [Paulo Merson](https:
7575

7676
[Available](https://github.com/pmerson/ADR-template) under the [MIT License](https://github.com/pmerson/ADR-template/blob/master/LICENSE).
7777

78-
Set as the default template using `adr templates default set merson`
78+
Set as the default template using `adr templates set merson`
7979

8080
#### Nygard Pattern
8181
A simple, low-friction "Agile" ADR approach by [Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions), which distils the decision record into the following headings:
@@ -88,7 +88,7 @@ A simple, low-friction "Agile" ADR approach by [Michael Nygard](http://thinkrele
8888

8989
[Available](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions) under [CC0 1.0 Universal (CC0 1.0) Public Domain Dedication](https://creativecommons.org/publicdomain/zero/1.0/).
9090

91-
Set as the default template using `adr templates default set nygard`
91+
Set as the default template using `adr templates set nygard`
9292

9393
#### Planguage Pattern
9494
A Quality Assurance oriented approach by [John Terzakis](http://www.iaria.org/conferences2012/filesICCGI12/Tutorial%20Specifying%20Effective%20Non-func.pdf), which distils the decision record into the following headings:
@@ -111,7 +111,7 @@ A Quality Assurance oriented approach by [John Terzakis](http://www.iaria.org/co
111111

112112
Source [Joel Parker Henderson](https://github.com/joelparkerhenderson/architecture-decision-record/), see this [issue about licensing](https://github.com/joelparkerhenderson/architecture-decision-record/issues/30).
113113

114-
Set as the default template using `adr templates default set planguage`
114+
Set as the default template using `adr templates set planguage`
115115

116116
#### Tyree and Akerman Pattern
117117
ADR approach by [Jeff Tyree and Art Akerman](https://personal.utdallas.edu/~chung/SA/zz-Impreso-architecture_decisions-tyree-05.pdf), Capital One Financial, which distils the decision record into the following headings:
@@ -134,7 +134,7 @@ ADR approach by [Jeff Tyree and Art Akerman](https://personal.utdallas.edu/~chun
134134

135135
Source [Joel Parker Henderson](https://github.com/joelparkerhenderson/architecture-decision-record/), see this [issue about licensing](https://github.com/joelparkerhenderson/architecture-decision-record/issues/30).
136136

137-
Set as the default template using `adr templates default set tyree-ackerman`
137+
Set as the default template using `adr templates set tyree-ackerman`
138138

139139
## More Information
140140

Solutions/ThirdParty.Adr.Templates/NuGet.Readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ To see the currently set default package, use:
8080

8181
To see the id of the currently set default template, use:
8282

83-
`adr templates default show`
83+
`adr templates show`
8484

8585
To revert to the "official" ADT Template Package you can either, reset the environment:
8686

0 commit comments

Comments
 (0)