-
-
Notifications
You must be signed in to change notification settings - Fork 2
Add clearer JBang wrapper example #2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
realhaley
wants to merge
1
commit into
jbangdev:main
Choose a base branch
from
realhaley:add-jbang-example
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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 |
|---|---|---|
| @@ -1,23 +1,57 @@ | ||
| # Simple JBang Example | ||
| # JBang wrapper example | ||
|
|
||
| This example shows how to package jbang wrapper to run | ||
| anything jbang is capable of running. | ||
| This example shows how to package a JBang wrapper with `jpaxa` so you can ship a single executable that can run a JBang app on the target machine. | ||
|
|
||
| ## Steps | ||
| ## What it demonstrates | ||
|
|
||
| 1. Compile the Java application: | ||
| ```bash | ||
| javac Hello.java | ||
| ``` | ||
| - wrapping an app directory that already contains the JBang wrapper scripts | ||
| - using `{{jpaxa}}` to locate the extracted wrapper at runtime | ||
| - producing a single self-extracting executable instead of asking users to unpack files manually | ||
|
|
||
| 2. Package it with jpaxa: | ||
| ```bash | ||
| jpaxa . -- "{{app}}/jbang" "env@jbangdev" | ||
| ``` | ||
| ## Prepare the wrapper | ||
|
|
||
| 3. Run the packaged executable: | ||
| ```bash | ||
| ./jbang-wrap additional args | ||
| ``` | ||
| From this directory, create the JBang wrapper files: | ||
|
|
||
| Note: On Windows, use `hello.exe` as the output name. | ||
| ```bash | ||
| jbang wrapper install -d . | ||
| ``` | ||
|
|
||
| That gives you files such as `jbang`, `jbang.cmd`, and `jbang.ps1` inside this example directory. | ||
|
|
||
| ## Build the executable | ||
|
|
||
| ### macOS / Linux | ||
|
|
||
| ```bash | ||
| jpaxa \ | ||
| --input . \ | ||
| --output jbang-wrap \ | ||
| -- "{{jpaxa}}/jbang" "env@jbangdev" | ||
| ``` | ||
|
|
||
| ### Windows | ||
|
|
||
| ```bash | ||
| jpaxa \ | ||
| --input . \ | ||
| --output jbang-wrap.exe \ | ||
| -- "{{jpaxa}}/jbang.cmd" "env@jbangdev" | ||
| ``` | ||
|
|
||
| ## Run it | ||
|
|
||
| ```bash | ||
| ./jbang-wrap | ||
| ``` | ||
|
|
||
| You should see the output from `env@jbangdev`, executed through the extracted JBang wrapper bundled in the executable. | ||
|
|
||
| ## Why this example matters | ||
|
|
||
| This is one of the nicest `jpaxa` use cases: | ||
|
|
||
| - author a tool with JBang | ||
| - bundle the wrapper once | ||
| - ship a single file to users | ||
|
|
||
| No installer, no manual unzip step, and no need to explain the internal file layout to the user. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.