jbang(1)

Name

jbang - jbang is a tool for building and running .java/.jsh scripts and jar packages.

Synopsis

jbang [-hV] [--config=<config>] [--verbose | --quiet] [-o | --fresh] [COMMAND]

Description

jbang init hello.java [args...]
      (to initialize a script)
or  jbang edit --open=code --live hello.java
      (to edit a script in any IDE with live updates)
or  jbang edit . hello.java
      (to edit a folder in IDE that supports JBang, see https://jbang.dev/ide)
or  jbang hello.java [args...]
      (to run a .java file)
or  jbang gavsearch@jbangdev [args...]
      (to run a alias from a catalog)
or  jbang group-id:artifact-id:version [args...]
      (to run a .jar file found with a GAV id)

Options

--config=<config>

Path to config file to be used instead of the default

--fresh

Make sure we use fresh (i.e. non-cached) resources.

-h, --help

Display help/info. Use 'jbang <command> -h' for detailed usage.

-o, --offline

Work offline. Fail-fast if dependencies are missing. No connections will be attempted

--quiet

jbang will be quiet, only print when error occurs.

-V, --version

Display version info (use jbang --verbose version for more details)

--verbose

jbang will be verbose on what it does.

Commands

run

Builds and runs provided script.

build

Compiles and stores script in the cache.

edit

Setup a temporary project to edit script in an IDE.

init

Initialize a script.

alias

Manage aliases for scripts.

template

Manage templates for scripts.

catalog

Manage Catalogs of aliases.

trust

Manage which domains you trust to run scripts from.

cache

Manage compiled scripts in the local cache.

completion

Output auto-completion script for bash/zsh.

Usage: source <(jbang completion)

jdk

Manage Java Development Kits installed by jbang.

version

Display version info.

wrapper

Manage jbang wrapper for a folder.

info

Provides info about the script for tools (and humans who are tools).

app

Manage scripts installed on the user’s PATH as commands.

export

Export the result of a build.

config

Read and write configuration options.