Skip to content

Commit 54a342f

Browse files
maxandersenmaxandersen
committed
docs: update cli docs
1 parent c723707 commit 54a342f

29 files changed

+124
-72
lines changed

‎docs/modules/cli/pages/jbang-alias-add.adoc‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@ jbang-alias-add - Add alias for script reference.
2525
[*--module*[=_<module>_]] [*-d*[=_<String=String>_]]...
2626
[*--catalog*=_<catalog>_] [*--config*=_<config>_]
2727
[*--description*=_<description>_] [*-f*=_<catalogFile>_]
28-
[*-j*=_<javaVersion>_] [*-m*=_<main>_] [*--name*=_<name>_]
29-
[*--source-type*=_<forceType>_] [*-C*=_<compileOptions>_]...
30-
[*--cp*=_<classpaths>_]... [*-D*=_<String=String>_]...
31-
[*--deps*=_<dependencies>_]... [*--docs*=_<docs>_]...
32-
[*--files*=_<resources>_]... [*--javaagent*=_<String=String>_]...
28+
[*-j*=_<javaVersion>_] [*-m*=_<main>_] [*--name*=_<name>_] [*-T*=_<forceType>_]
29+
[*-C*=_<compileOptions>_]... [*--cp*=_<classpaths>_]...
30+
[*-D*=_<String=String>_]... [*--deps*=_<dependencies>_]...
31+
[*--docs*=_<docs>_]... [*--files*=_<resources>_]...
32+
[*--javaagent*=_<String=String>_]...
3333
[*--manifest*=_<String=String>_]... [*-N*=_<nativeOptions>_]...
3434
[*-R*=_<javaRuntimeOptions>_]... [*--repos*=_<repositories>_]...
3535
[*-s*=_<sources>_]... [_<scriptOrFile>_] [_params_...]
@@ -160,7 +160,7 @@ Add alias for script reference.
160160
*-s*, *--sources*=_<sources>_::
161161
Add additional sources.
162162

163-
*--source-type*=_<forceType>_::
163+
*-T*, *--source-type*=_<forceType>_::
164164
Force input to be interpreted as the given type. Can be: java, jshell, groovy, kotlin, or markdown
165165

166166
*--verbose*::

‎docs/modules/cli/pages/jbang-alias.adoc‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ jbang-alias - Manage aliases for scripts.
1919
// tag::picocli-generated-man-section-synopsis[]
2020
== Synopsis
2121

22-
*jbang alias* *-o* *--fresh* *--quiet* *--verbose* [COMMAND]
22+
*jbang alias* *-o* [*-h*] *--fresh* *--quiet* *--verbose* [COMMAND]
2323

2424
// end::picocli-generated-man-section-synopsis[]
2525

@@ -36,6 +36,9 @@ Manage aliases for scripts.
3636
*--fresh*::
3737
Make sure we use fresh (i.e. non-cached) resources.
3838

39+
*-h*, *--help*::
40+
Display help/info. Use 'jbang <command> -h' for detailed usage.
41+
3942
*-o*, *--offline*::
4043
Work offline. Fail-fast if dependencies are missing. No connections will be attempted
4144

‎docs/modules/cli/pages/jbang-app-install.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ jbang-app-install - Install a script as a command.
2525
[=_<flightRecorderString>_]] [*--module*[=_<module>_]] [*-d*
2626
[=_<String=String>_]]... [*--build-dir*=_<buildDir>_]
2727
[*--catalog*=_<catalog>_] [*--config*=_<config>_] [*-j*=_<javaVersion>_]
28-
[*-m*=_<main>_] [*--name*=_<name>_] [*--source-type*=_<forceType>_]
28+
[*-m*=_<main>_] [*--name*=_<name>_] [*-T*=_<forceType>_]
2929
[*-C*=_<compileOptions>_]... [*--cp*=_<classpaths>_]...
3030
[*-D*=_<String=String>_]... [*--deps*=_<dependencies>_]...
3131
[*--files*=_<resources>_]... [*--javaagent*=_<String=String>_]...
@@ -153,7 +153,7 @@ Install a script as a command.
153153
*-s*, *--sources*=_<sources>_::
154154
Add additional sources.
155155

156-
*--source-type*=_<forceType>_::
156+
*-T*, *--source-type*=_<forceType>_::
157157
Force input to be interpreted as the given type. Can be: java, jshell, groovy, kotlin, or markdown
158158

159159
*--verbose*::

‎docs/modules/cli/pages/jbang-app.adoc‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ jbang-app - Manage scripts installed on the user's PATH as commands.
1919
// tag::picocli-generated-man-section-synopsis[]
2020
== Synopsis
2121

22-
*jbang app* *-o* *--fresh* *--quiet* *--verbose* [COMMAND]
22+
*jbang app* *-o* [*-h*] *--fresh* *--quiet* *--verbose* [COMMAND]
2323

2424
// end::picocli-generated-man-section-synopsis[]
2525

@@ -36,6 +36,9 @@ Manage scripts installed on the user's PATH as commands.
3636
*--fresh*::
3737
Make sure we use fresh (i.e. non-cached) resources.
3838

39+
*-h*, *--help*::
40+
Display help/info. Use 'jbang <command> -h' for detailed usage.
41+
3942
*-o*, *--offline*::
4043
Work offline. Fail-fast if dependencies are missing. No connections will be attempted
4144

‎docs/modules/cli/pages/jbang-build.adoc‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@ jbang-build - Compiles and stores script in the cache.
2222
*jbang build* *-o* [*-hn*] [*--enable-preview*] *--fresh* [*--insecure*] [*--[no-]*
2323
* integrations*] [*--itr*] [*--jsh*] *--quiet* *--verbose* [*--module*
2424
[=_<module>_]] [*--build-dir*=_<buildDir>_] [*--catalog*=_<catalog>_]
25-
[*--config*=_<config>_] [*-j*=_<javaVersion>_] [*-m*=_<main>_]
26-
[*--source-type*=_<forceType>_] [*-C*=_<compileOptions>_]...
27-
[*--cp*=_<classpaths>_]... [*-D*=_<String=String>_]...
28-
[*--deps*=_<dependencies>_]... [*--files*=_<resources>_]...
29-
[*--manifest*=_<String=String>_]... [*-N*=_<nativeOptions>_]...
30-
[*--repos*=_<repositories>_]... [*-s*=_<sources>_]... [_<scriptOrFile>_]
25+
[*--config*=_<config>_] [*-j*=_<javaVersion>_] [*-m*=_<main>_] [*-T*=_<forceType>_]
26+
[*-C*=_<compileOptions>_]... [*--cp*=_<classpaths>_]...
27+
[*-D*=_<String=String>_]... [*--deps*=_<dependencies>_]...
28+
[*--files*=_<resources>_]... [*--manifest*=_<String=String>_]...
29+
[*-N*=_<nativeOptions>_]... [*--repos*=_<repositories>_]...
30+
[*-s*=_<sources>_]... [_<scriptOrFile>_]
3131

3232
// end::picocli-generated-man-section-synopsis[]
3333

@@ -116,7 +116,7 @@ Compiles and stores script in the cache.
116116
*-s*, *--sources*=_<sources>_::
117117
Add additional sources.
118118

119-
*--source-type*=_<forceType>_::
119+
*-T*, *--source-type*=_<forceType>_::
120120
Force input to be interpreted as the given type. Can be: java, jshell, groovy, kotlin, or markdown
121121

122122
*--verbose*::

‎docs/modules/cli/pages/jbang-cache.adoc‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ jbang-cache - Manage compiled scripts in the local cache.
1919
// tag::picocli-generated-man-section-synopsis[]
2020
== Synopsis
2121

22-
*jbang cache* *-o* *--fresh* *--quiet* *--verbose* [COMMAND]
22+
*jbang cache* *-o* [*-h*] *--fresh* *--quiet* *--verbose* [COMMAND]
2323

2424
// end::picocli-generated-man-section-synopsis[]
2525

@@ -36,6 +36,9 @@ Manage compiled scripts in the local cache.
3636
*--fresh*::
3737
Make sure we use fresh (i.e. non-cached) resources.
3838

39+
*-h*, *--help*::
40+
Display help/info. Use 'jbang <command> -h' for detailed usage.
41+
3942
*-o*, *--offline*::
4043
Work offline. Fail-fast if dependencies are missing. No connections will be attempted
4144

‎docs/modules/cli/pages/jbang-catalog.adoc‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ jbang-catalog - Manage Catalogs of aliases.
1919
// tag::picocli-generated-man-section-synopsis[]
2020
== Synopsis
2121

22-
*jbang catalog* *-o* *--fresh* *--quiet* *--verbose* [COMMAND]
22+
*jbang catalog* *-o* [*-h*] *--fresh* *--quiet* *--verbose* [COMMAND]
2323

2424
// end::picocli-generated-man-section-synopsis[]
2525

@@ -36,6 +36,9 @@ Manage Catalogs of aliases.
3636
*--fresh*::
3737
Make sure we use fresh (i.e. non-cached) resources.
3838

39+
*-h*, *--help*::
40+
Display help/info. Use 'jbang <command> -h' for detailed usage.
41+
3942
*-o*, *--offline*::
4043
Work offline. Fail-fast if dependencies are missing. No connections will be attempted
4144

‎docs/modules/cli/pages/jbang-config.adoc‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ jbang-config - Read and write configuration options.
1919
// tag::picocli-generated-man-section-synopsis[]
2020
== Synopsis
2121

22-
*jbang config* *-o* *--fresh* *--quiet* *--verbose* [COMMAND]
22+
*jbang config* *-o* [*-h*] *--fresh* *--quiet* *--verbose* [COMMAND]
2323

2424
// end::picocli-generated-man-section-synopsis[]
2525

@@ -36,6 +36,9 @@ Read and write configuration options.
3636
*--fresh*::
3737
Make sure we use fresh (i.e. non-cached) resources.
3838

39+
*-h*, *--help*::
40+
Display help/info. Use 'jbang <command> -h' for detailed usage.
41+
3942
*-o*, *--offline*::
4043
Work offline. Fail-fast if dependencies are missing. No connections will be attempted
4144

‎docs/modules/cli/pages/jbang-edit.adoc‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,10 @@ jbang-edit - Setup a temporary project to edit script in an IDE.
2121

2222
*jbang edit* *-o* [*-bh*] *--fresh* [*--insecure*] [*--itr*] [*--jsh*] [*--live*] [*--no-open*]
2323
*--quiet* *--verbose* [*--open*[=_<editor>_]] [*--catalog*=_<catalog>_]
24-
[*--config*=_<config>_] [*--source-type*=_<forceType>_]
25-
[*--cp*=_<classpaths>_]... [*-D*=_<String=String>_]...
26-
[*--deps*=_<dependencies>_]... [*--files*=_<resources>_]...
27-
[*--repos*=_<repositories>_]... [*-s*=_<sources>_]... [_<scriptOrFile>_]
28-
[_<additionalFiles>_...]
24+
[*--config*=_<config>_] [*-T*=_<forceType>_] [*--cp*=_<classpaths>_]...
25+
[*-D*=_<String=String>_]... [*--deps*=_<dependencies>_]...
26+
[*--files*=_<resources>_]... [*--repos*=_<repositories>_]...
27+
[*-s*=_<sources>_]... [_<scriptOrFile>_] [_<additionalFiles>_...]
2928

3029
// end::picocli-generated-man-section-synopsis[]
3130

@@ -96,7 +95,7 @@ Setup a temporary project to edit script in an IDE.
9695
*-s*, *--sources*=_<sources>_::
9796
Add additional sources.
9897

99-
*--source-type*=_<forceType>_::
98+
*-T*, *--source-type*=_<forceType>_::
10099
Force input to be interpreted as the given type. Can be: java, jshell, groovy, kotlin, or markdown
101100

102101
*--verbose*::

‎docs/modules/cli/pages/jbang-export-fatjar.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ jbang-export-fatjar - Exports an executable jar with all necessary dependencies
2323
* integrations*] [*--itr*] [*--jsh*] *--quiet* *--verbose* [*--module*
2424
[=_<module>_]] [*--catalog*=_<catalog>_] [*--config*=_<config>_]
2525
[*-j*=_<javaVersion>_] [*-m*=_<main>_] [*-O*=_<outputFile>_]
26-
[*--source-type*=_<forceType>_] [*-C*=_<compileOptions>_]...
26+
[*-T*=_<forceType>_] [*-C*=_<compileOptions>_]...
2727
[*--cp*=_<classpaths>_]... [*-D*=_<String=String>_]...
2828
[*--deps*=_<dependencies>_]... [*--files*=_<resources>_]...
2929
[*--manifest*=_<String=String>_]... [*--repos*=_<repositories>_]...
@@ -110,7 +110,7 @@ Exports an executable jar with all necessary dependencies included inside
110110
*-s*, *--sources*=_<sources>_::
111111
Add additional sources.
112112

113-
*--source-type*=_<forceType>_::
113+
*-T*, *--source-type*=_<forceType>_::
114114
Force input to be interpreted as the given type. Can be: java, jshell, groovy, kotlin, or markdown
115115

116116
*--verbose*::

0 commit comments

Comments
 (0)