Run the JAR. Keep the boundaries.

Current availability: no public source URL or release is published. These commands apply only after you have a current evaluation source checkout. Requirements verified at the current tip: JDK 21, Maven, Node.js 24 and npm.

1. Build the executable

From the repository root, run the release builder. It tests and builds the browser UI, verifies the Maven reactor and packages the executable JAR.

./ravenroot/scripts/build-release.sh

2. Start Ravenroot locally

java -jar ravenroot/ravenroot-distribution/target/ravenroot.jar

The default bind is loopback, so local startup selects disabled authentication and prints a warning. A non-loopback bind has no permissive default: startup requires explicit authentication configuration.

3. Verify the service

curl --fail http://127.0.0.1:8080/health
curl --fail http://127.0.0.1:8080/v1/status
curl --fail http://127.0.0.1:8080/v1/node-types

Open http://127.0.0.1:8080 to use the embedded editor. The same origin serves the UI and API.

4. Use the binary CLI

The packaged ZIP is a secondary compatibility shape in source builds. Its scripts expose service status, node catalog inspection and GraphML validation.

bin/ravenroot status
bin/ravenroot node-types
bin/ravenroot inspect path/to/graph.graphml

Embed instead of host

The separate ravenroot-sample demonstrates embedding without exposing an actor-framework type to application code. The host supplies an explicit security context at ingress and chooses an engine through Ravenroot’s execution SPI.

cd ravenroot
mvn --batch-mode --no-transfer-progress install
cd ../ravenroot-sample
RAVENROOT_ENGINE=pekko mvn --batch-mode --no-transfer-progress clean test exec:java \
  -Dexec.args="hello ravenroot"

Extend deliberately

Custom node packages can be compiled into an embedding application, placed on the classpath, or installed as checksum-verified plugin bundles. Install and activation are separate operator steps. Model, agent and program execution adapters are not silently enabled by any quickstart.