> For the complete documentation index, see [llms.txt](https://docs.onelitefeather.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.onelitefeather.net/falco/how-to-guides/build-falco-from-source.md).

# Build Falco from source

Compile Falco itself, run its tests and render its Javadoc. You end with a jar per library module and a benchmark jar. This is needed only to work on Falco. Consuming the published artefacts needs none of this — that is [How-to Add Falco to your build](/falco/how-to-guides/add-falco-to-your-build.md).

**Before you start:** Java 25, and OneLiteFeather Maven credentials, because Minestom and the internal `mycelium-bom` are served from an authenticated endpoint. How the build is put together is in [Build setup](/falco/contributing/build-setup.md).

1. Export the credentials:

   ```bash
   export ONELITEFEATHER_MAVEN_USERNAME=...
   export ONELITEFEATHER_MAVEN_PASSWORD=...
   ```
2. Build — this compiles, renders Javadoc and runs the tests:

   ```bash
   ./gradlew build
   ```
3. Render the Javadoc on its own, one tree per module under `falco-<module>/build/docs/javadoc/index.html`:

   ```bash
   ./gradlew javadoc
   ```
4. Build the benchmark jar. A build never runs the benchmarks:

   ```bash
   ./gradlew :falco-benchmarks:jmhJar
   ```

## Check it worked

`./gradlew build` reports `BUILD SUCCESSFUL` and each library module has a jar under `falco-<module>/build/libs/`.

## If it does not work

A 401 during dependency resolution means the two environment variables from step 1 are unset or wrong.

See also: [Build setup](/falco/contributing/build-setup.md) for what the build is made of · [How-to Run the JMH benchmark suite](/falco/how-to-guides/run-the-jmh-benchmark-suite.md) to run what step 4 produced.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.onelitefeather.net/falco/how-to-guides/build-falco-from-source.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.