Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/modules/ROOT/pages/troubleshooting.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,12 @@ jbang info classpath script.java
# Test dependency resolution
jbang info classpath script.java

# Resolve dependency source JARs (source-path)
jbang info source-path script.java

# Resolve source JAR for a specific JAR or dependency
jbang info source-jar xyz.jar

# Check repositories
jbang info docs script.java

Expand Down
2 changes: 2 additions & 0 deletions docs/modules/cli/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@
*** xref:jbang:cli:jbang-info-tools.adoc[tools]
*** xref:jbang:cli:jbang-info-classpath.adoc[classpath]
*** xref:jbang:cli:jbang-info-jar.adoc[jar]
*** xref:jbang:cli:jbang-info-source-path.adoc[source-path]
*** xref:jbang:cli:jbang-info-source-jar.adoc[source-jar]
*** xref:jbang:cli:jbang-info-docs.adoc[docs]
** xref:jbang:cli:jbang-version.adoc[version]
** xref:jbang:cli:jbang-wrapper.adoc[wrapper]
Expand Down
85 changes: 85 additions & 0 deletions docs/modules/cli/pages/jbang-info-source-jar.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
= JBANG-INFO-SOURCE-JAR

== NAME

jbang info source-jar -- Prints the path to this application's or artifact's source JAR file.

== SYNOPSIS

[source]
----
jbang info source-jar [-h] [-s=<sources>] [--files=<files>] [-T=<source-type>] [--jsh] [--catalog=<catalog>] [-D<key>=<value>] [--deps=<deps>] [--repos=<repos>] [--cp=<cp>] [--ignore-transitive-repositories] [--build-dir=<build-dir>] [--module] [--config=<config>] [--insecure] [--[no-]verbose] [--[no-]quiet] [--[no-]offline] [--[no-]fresh] [--[no-]stacktrace] [<scriptOrFile>]
----

== OPTIONS

*-h*, *--help*::
Display this help and exit

*-s*, *--sources*=<sources>::
Add additional sources.

*--files*=<files>::
Add additional files.

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

*--jsh*::
Force input to be interpreted with jsh/jshell. Deprecated: use '--source-type jshell'

*--catalog*=<catalog>::
Path to catalog file to be used instead of the default

*-D*=<key>=<value>::
set a system property
+
Default: `true`

*--deps*=<deps>::
Add additional dependencies (Use commas to separate them).

*--repos*=<repos>::
Add additional repositories.

*--cp*=<cp>::
Add class path entries.
+
Aliases: `--class-path`

*--ignore-transitive-repositories*::
Ignore remote repositories found in transitive dependencies
+
Aliases: `--itr`

*--build-dir*=<build-dir>::
Use given directory for build results

*--module*=<module>::
Treat resource as a module. Optionally with the given module name

*--config*=<config>::
Path to config file to be used instead of the default

*--insecure*::
Enable insecure trust of all SSL certificates.

*--[no-]verbose*::
jbang will be verbose on what it does.

*--[no-]quiet*::
jbang will be quiet, only print when error occurs.

*-o*, *--[no-]offline*::
Work offline. Fail-fast if dependencies are missing.

*--[no-]fresh*::
Make sure we use fresh (i.e. non-cached) resources.

*-x*, *--[no-]stacktrace*::
Print exceptions stacktraces to stderr (even when quiet).

== ARGUMENTS

*<scriptOrFile>*::
A file or URL to a Java code file
88 changes: 88 additions & 0 deletions docs/modules/cli/pages/jbang-info-source-path.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
= JBANG-INFO-SOURCE-PATH

== NAME

jbang info source-path -- Prints source-path used for this application using operating system specific path separation.

== SYNOPSIS

[source]
----
jbang info source-path [-h] [--deps-only] [-s=<sources>] [--files=<files>] [-T=<source-type>] [--jsh] [--catalog=<catalog>] [-D<key>=<value>] [--deps=<deps>] [--repos=<repos>] [--cp=<cp>] [--ignore-transitive-repositories] [--build-dir=<build-dir>] [--module] [--config=<config>] [--insecure] [--[no-]verbose] [--[no-]quiet] [--[no-]offline] [--[no-]fresh] [--[no-]stacktrace] [<scriptOrFile>]
----

== OPTIONS

*-h*, *--help*::
Display this help and exit

*--deps-only*::
Only include the dependencies in the output, not the application jar itself

*-s*, *--sources*=<sources>::
Add additional sources.

*--files*=<files>::
Add additional files.

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

*--jsh*::
Force input to be interpreted with jsh/jshell. Deprecated: use '--source-type jshell'

*--catalog*=<catalog>::
Path to catalog file to be used instead of the default

*-D*=<key>=<value>::
set a system property
+
Default: `true`

*--deps*=<deps>::
Add additional dependencies (Use commas to separate them).

*--repos*=<repos>::
Add additional repositories.

*--cp*=<cp>::
Add class path entries.
+
Aliases: `--class-path`

*--ignore-transitive-repositories*::
Ignore remote repositories found in transitive dependencies
+
Aliases: `--itr`

*--build-dir*=<build-dir>::
Use given directory for build results

*--module*=<module>::
Treat resource as a module. Optionally with the given module name

*--config*=<config>::
Path to config file to be used instead of the default

*--insecure*::
Enable insecure trust of all SSL certificates.

*--[no-]verbose*::
jbang will be verbose on what it does.

*--[no-]quiet*::
jbang will be quiet, only print when error occurs.

*-o*, *--[no-]offline*::
Work offline. Fail-fast if dependencies are missing.

*--[no-]fresh*::
Make sure we use fresh (i.e. non-cached) resources.

*-x*, *--[no-]stacktrace*::
Print exceptions stacktraces to stderr (even when quiet).

== ARGUMENTS

*<scriptOrFile>*::
A file or URL to a Java code file
2 changes: 2 additions & 0 deletions docs/modules/cli/pages/jbang-info.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -42,5 +42,7 @@ Print exceptions stacktraces to stderr (even when quiet).
* xref:jbang:cli:jbang-info-tools.adoc[*tools*] - Prints a json description usable for tools/IDE's to get classpath and more info for a jbang script/application.
* xref:jbang:cli:jbang-info-classpath.adoc[*classpath*] - Prints class-path used for this application using operating system specific path separation.
* xref:jbang:cli:jbang-info-jar.adoc[*jar*] - Prints the path to this application's JAR file.
* xref:jbang:cli:jbang-info-source-path.adoc[*source-path*] - Prints source-path used for this application using operating system specific path separation.
* xref:jbang:cli:jbang-info-source-jar.adoc[*source-jar*] - Prints the path to this application's or artifact's source JAR file.
* xref:jbang:cli:jbang-info-docs.adoc[*docs*] - Open the documentation file in the default browser.

2 changes: 2 additions & 0 deletions docs/modules/cli/partials/nav-jbang.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@
*** xref:jbang:cli:jbang-info-tools.adoc[tools]
*** xref:jbang:cli:jbang-info-classpath.adoc[classpath]
*** xref:jbang:cli:jbang-info-jar.adoc[jar]
*** xref:jbang:cli:jbang-info-source-path.adoc[source-path]
*** xref:jbang:cli:jbang-info-source-jar.adoc[source-jar]
*** xref:jbang:cli:jbang-info-docs.adoc[docs]
** xref:jbang:cli:jbang-app.adoc[app]
*** xref:jbang:cli:jbang-app-install.adoc[install]
Expand Down
Loading
Loading