# Installing from source (for the adventurous)

We show here how to install RumbleDB from the GitHub repository and build it yourself if you wish to do so (for example, to use the latest master). However, the easiest way to use RumbleDB is to simply download the already compiled .jar files.

## Requirements

The following software is required:

* [Java SE](https://adoptium.net/temurin/releases/): the version of Java is important, as RumbleDB only works with Java 11 (Standalone or Spark 3.5), 17 (Standalone or Spark 3.5 or Spark 4 or Python) or 21 (Spark 4 or Python). The current master branch corresponds to Spark 4.0, meaning that Java 17 or 21 is required.
* [Spark](https://spark.apache.org/), version 4.0.0 (for example)
* [Ant](http://ant.apache.org/), version 1.10
* [Maven](https://maven.apache.org/) 3.9.9

### Checking the requirements

Type the following commands to check that the necessary commands are available. If not, you may need to either install the software, or make sure that it is on the PATH.

```
$ java -version

$ mvn --version

$ ant -version

$ spark-submit --version
```

## Checkout

You first need to download the rumble code to your local machine.

In the shell, go to the desired location:

```
$ cd some_directory
```

Clone the github repository:

```
$ git clone https://github.com/RumbleDB/rumble.git
```

Go to the root of this repository:

```
$ cd rumble
```

## Compile

You can compile the entire project like so:

```
$ mvn clean compile assembly:single
```

After successful completion, you can check the `target` directory, which should contain the compiled classes as well as the JAR file `rumbledb-2.1.0-jar-with-dependencies.jar`.

## Running locally

The most straightforward to test if the above steps were successful is to run the RumbleDB shell locally, like so:

```
$ spark-submit target/rumbledb-2.1.0-jar-with-dependencies.jar repl
```

The RumbleDB shell should start:

```
Using Spark's default log4j profile: org/apache/spark/log4j-defaults.properties

    ____                  __    __     ____  ____ 
   / __ \__  ______ ___  / /_  / /__  / __ \/ __ )
  / /_/ / / / / __ `__ \/ __ \/ / _ \/ / / / __  |  The distributed JSONiq engine
 / _, _/ /_/ / / / / / / /_/ / /  __/ /_/ / /_/ /   2.1.0 "Cedrus Libani" beta
/_/ |_|\__,_/_/ /_/ /_/_.___/_/\___/_____/_____/  

Master: local[2]
Item Display Limit: 1000
Output Path: -
Log Path: -
Query Path : -

rumble$
```

You can now start typing interactive queries. Queries can span over multiple lines. You need to press return 3 times to confirm.

```
rumble$ "Hello, world!"
```

This produces the following results (`>>>` show the extra, empty lines that appear on the first two presses of the return key).

```
rumble$ "Hello, world!"
>>> 
>>> 
Hello, world
```

You can try a few more queries.

```
rumble$ 2 + 2
>>> 
>>> 
4

rumble$ 1 to 10
>>> 
>>> 
( 1, 2, 3, 4, 5, 6, 7, 8, 9, 10)
```

This is it. RumbleDB is setup and ready to go locally. You can now move on to a JSONiq tutorial. A RumbleDB tutorial will also follow soon.

## Running on a cluster

You can also try to run the RumbleDB shell on a cluster if you have one available and configured -- this is done with the same command, as the master and deployment mode are usually already set up in cloud-managed clusters. More details are provided in the rest of the documentation.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.rumbledb.org/getting-started/install.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.