JBang Documentation

JBang Logo

Want to learn, explore or use Java instantly without setup?

Do you like Java but use Python, Groovy, Kotlin or similar languages for scripts, experimentation and exploration?

Ever wanted to just be able to run Java from anywhere without any or very minimal setup?

Then try JBang - the tool that makes Java scripting easy and fun!

Quick Start

# Install JBang
curl -Ls https://sh.jbang.dev | bash -s - app setup

# Create your first script
jbang init --template=cli hello.java

# Run it
jbang hello.java Max!

What is JBang?

JBang is a tool that makes it easy to write and run Java scripts without the traditional setup overhead. It goes beyond simple scripting - you can use JBang to launch any Java application or library packaged as a JAR, available locally, via HTTP/HTTPS download, or in a Maven repository.

Key Features

Feature Description

Feature	Description
Zero Setup	Run Java files directly - no project setup needed
Dependency Management	Declare dependencies with `//DEPS` - automatic resolution
Multiple Languages	Support for `.java`, `.jsh`, `.kt`, `.groovy`, and `.md` files
Native Images	Generate native binaries with GraalVM
IDE Integration	Edit with full IDE support using `jbang edit`
Templates	Quick start with built-in templates
Aliases & Catalogs	Share and reuse scripts easily
Cross Platform	Works on Windows, macOS, Linux, and AIX

Zero Setup

Run Java files directly - no project setup needed

Dependency Management

Declare dependencies with //DEPS - automatic resolution

Multiple Languages

Support for .java, .jsh, .kt, .groovy, and .md files

Native Images

Generate native binaries with GraalVM

IDE Integration

Edit with full IDE support using jbang edit

Templates

Quick start with built-in templates

Aliases & Catalogs

Share and reuse scripts easily

Cross Platform

Works on Windows, macOS, Linux, and AIX

Documentation Guide

🚀 Getting Started

Perfect for newcomers to JBang:

Installation - Set up JBang on your system
Java Versions - Managing Java versions

📝 Writing Scripts

Learn to write effective JBang scripts:

Dependencies - Add external libraries
Organizing Code - Structure larger projects
Templates - Use and create templates
Debugging - Debug your scripts

🔧 Advanced Features

Explore powerful JBang capabilities:

Running & Execution - Advanced execution options
IDE Integration - Edit with full IDE support
Exporting Projects - Convert to traditional projects
Aliases & Catalogs - Share and manage scripts

⚙️ Configuration & Tools

Configure JBang for your workflow:

Configuration - Customize JBang behavior
Caching - Understand caching mechanisms
Integration - Integrate with build tools
Installing Scripts - Install scripts as commands

🆘 Help & Reference

When you need assistance:

FAQ - Common questions and answers
CLI Reference - Complete command reference

Common Use Cases

Use Case Example

Use Case	Example
Quick Scripts	`jbang script.java` - Run any Java file instantly
Command Line Tools	`jbang init --template=cli mytool.java` - Build CLI apps
Experiments	`jbang --deps com.fasterxml.jackson.core:jackson-core:2.15.2 experiment.java`
Learning	`jbang --jsh` - Interactive Java shell
Prototyping	`jbang edit myapp.java` - Full IDE support for rapid development

Quick Scripts

jbang script.java - Run any Java file instantly

Command Line Tools

jbang init --template=cli mytool.java - Build CLI apps

Experiments

jbang --deps com.fasterxml.jackson.core:jackson-core:2.15.2 experiment.java

Learning

jbang --jsh - Interactive Java shell

Prototyping

jbang edit myapp.java - Full IDE support for rapid development

Requirements

JBang requires Java 8 or higher (Java 17+ recommended). If Java is not available in PATH or JAVA_HOME, JBang will automatically download and install it from Eclipse Temurin.

Tested and verified on:

🐧 Linux
🍎 macOS
🪟 Windows (Command Prompt, PowerShell, WSL)
🔧 AIX

Community

💬 Chat: Zulip Community
🐛 Issues: GitHub Issues
🛍️ App Store: JBang App Store
📚 Examples: jbang-examples

Next Steps

New to JBang? → Start with Installation
Want to dive in? → Try First Script
Building something complex? → Check Dependencies
Need help? → Visit the FAQ

Ready to unleash the power of Java scripting? Let’s get started! 🚀