Start Scripts

The following scripts, which are mentioned on the Startup and Startup Options pages, are also included in our official Windows and ZIP release files, and available in our GitHub repository:

• The Windows installer automatically adds the project’s bin directory to your path environment.
• With the ZIP distribution, you need to manually modify the path to the PATH environment variable.

BaseX Main Package

The following scripts launch the standalone version of BaseX. Please replace the class name in org.basex.BaseX with either BaseXClient, BaseXServer, or BaseXGUI to run the client, server or GUI version.

Windows: basex.bat

@setlocal
@echo off

REM Path to this script
set PWD=%~dp0

REM Paths to distributed JAR archives or class files
set BXPATH=basex.jar

REM Options for virtual machine
set VM=-Xmx512m

REM Classpath
set LIB=%PWD%/../lib
set CP=%BASEX%;%LIB%/lucene-analyzers-3.0.2.jar;%LIB%/tagsoup-1.2.jar;%LIB%/snowball.jar

REM Run BaseX
java -cp "%CP%" %VM% org.basex.BaseX %*

Linux/Mac: basex

#!/bin/bash

# Path to this script
PWD=`dirname $0`

REM Paths to distributed JAR archives or class files
BXPATH=basex.jar

# Options for virtual machine
VM=-Xmx512m

# Classpath
LIB=$PWD/../lib
CP=$BASEX:$LIB/lucene-analyzers-3.0.2.jar:$LIB/tagsoup-1.2.jar:$LIB/snowball.jar

# Run BaseX
java -cp "$CP" $VM org.basex.XXX "$@"

BaseX JAX-RX Server

Deprecated from Version 6.8: The scripts for starting the JAX-RX Server can be found below.

Windows: basexjaxrx.bat

@setlocal
@echo off

REM Path to this script
set PWD=%~dp0

REM Paths to distributed JAR archives or class files
set BASEX=%PWD%/basex-%BXVERSION%.jar 
set BASEXAPI=%PWD%/basex-api-%BXVERSION%.jar

REM Classpath
set LIB=%PWD%/../lib
set CP=%BASEX%;%BASEXAPI%;%LIB%/jax-rx-1.2.9.jar;%LIB%/jetty-6.1.25.jar;%LIB%/jetty-util-6.1.25.jar
set CP=%CP%;%LIB%/servlet-api-2.5-20081211.jar;%LIB%/jersey-server-1.4.jar;%LIB%/jersey-core-1.4.jar;%LIB%/asm-3.1.jar

REM Options for virtual machine
set VM=-Xmx512m

REM Run code
java -cp "%CP%" %VM% org.basex.api.jaxrx.JaxRxServer %*

Linux/Mac: basexjaxrx

#!/bin/bash

# Path to this script
PWD=`dirname $0`

REM Paths to distributed JAR archives or class files
BASEX=$PWD/basex.jar
BASEXAPI=$PWD/basex-api.jar

# Classpath
LIB=$PWD/../lib
CP=$BASEX:$BASEXAPI:$LIB/jax-rx-1.2.9.jar:$LIB/jetty-6.1.25.jar:$LIB/jetty-util-6.1.25.jar
CP=$CP:$LIB/servlet-api-2.5-20081211.jar:$LIB/jersey-server-1.4.jar:$LIB/jersey-core-1.4.jar:$LIB/asm-3.1.jar

# Options for virtual machine
VM=-Xmx512m

# Run code
java -cp "$CP" $VM org.basex.api.jaxrx.JaxRxServer "$@"

BaseX HTTP Server

Introduced with Version 6.8: The scripts for starting the HTTP server, which allows access to the REST and WebDAV services, can be found below.

Windows: basexhttp.bat

@echo off
setlocal

REM Path to this script
set PWD=%~dp0

REM Paths to distributed JAR archives or class files
set BASEX=%PWD%/basex-%BXVERSION%.jar 
set BASEXAPI=%PWD%/basex-api-%BXVERSION%.jar

REM Classpath
set LIB=%PWD%/../lib
set CP=%BASEX%;%BASEXAPI%;%LIB%/commons-beanutils-1.8.2.jar;%LIB%/commons-codec-1.4.jar;%LIB%/commons-fileupload-1.2.2.jar;%LIB%/commons-io-1.4.jar;%LIB%/commons-logging-1.1.1.jar;%LIB%/jdom-1.1.jar;%LIB%/jetty-6.1.26.jar;%LIB%/jetty-util-6.1.26.jar;%LIB%/log4j-1.2.14.jar;%LIB%/lucene-analyzers-3.0.2.jar;%LIB%/milton-api-1.6.4.jar;%LIB%/mime-util-2.1.3.jar;%LIB%/resolver.jar;%LIB%/servlet-api-2.5-20081211.jar;%LIB%/slf4j-api-1.5.8.jar;%LIB%/slf4j-log4j12-1.5.6.jar;%LIB%/snowball.jar;%LIB%/tagsoup-1.2.jar;%LIB%/xmldb-api-1.0.jar;%LIB%/xqj-api-1.0.jar

REM Options for virtual machine
set VM=-Xmx512m

REM Run code
java -cp "%CP%;." %VM% org.basex.api.BaseXHTTP %*

Linux/Mac: basexhttp

#!/bin/bash

# Path to this script
PWD=`dirname $0`

REM Paths to distributed JAR archives or class files
BASEX=$PWD/basex.jar
BASEXAPI=$PWD/basex-api.jar

# Classpath
LIB=$PWD/../lib
CP=$BASEX:$BASEXAPI:$LIB/commons-fileupload-1.2.2.jar:$LIB/commons-beanutils-1.8.2.jar:$LIB/commons-codec-1.4.jar:$LIB/commons-fileupload-1.2.2.jar:$LIB/commons-io-1.4.jar:$LIB/commons-logging-1.1.1.jar:$LIB/jdom-1.1.jar:$LIB/jetty-6.1.26.jar:$LIB/jetty-util-6.1.26.jar:$LIB/log4j-1.2.14.jar:$LIB/lucene-analyzers-3.0.2.jar:$LIB/milton-api-1.6.4.jar:$LIB/mime-util-2.1.3.jar:$LIB/resolver.jar:$LIB/servlet-api-2.5-20081211.jar:$LIB/slf4j-api-1.5.8.jar:$LIB/slf4j-log4j12-1.5.6.jar:$LIB/snowball.jar:$LIB/tagsoup-1.2.jar:$LIB/xmldb-api-1.0.jar:$LIB/xqj-api-1.0.jar

# Options for virtual machine
VM=-Xmx512m

# Run code
java -cp "$CP" $VM org.basex.api.BaseXHTTP "$@"