Installation

Alumnium for Java requires JDK 21+ and is distributed via Maven Central.

To install, add the library to your Gradle build along with a CLI artifact that matches your host platform.

dependencies {
  testImplementation 'ai.alumnium:alumnium:0.21.0'
  testRuntimeOnly    'ai.alumnium:alumnium-cli-darwin-arm64:0.21.0'
}

Or, if you’re using maven, add this to your pom.xml

<dependencies>
  <dependency>
    <groupId>ai.alumnium</groupId>
    <artifactId>alumnium</artifactId>
    <version>0.21.0</version>
    <scope>test</scope>
  </dependency>
  <dependency>
    <groupId>ai.alumnium</groupId>
    <artifactId>alumnium-cli-darwin-arm64</artifactId>
    <version>0.21.0</version>
    <scope>test</scope>
  </dependency>
</dependencies>

Replace alumnium-cli-darwin-arm64 with the artifact matching your platform, or add multiple artifacts if you need to support multiple platforms. The available CLI artifacts are:

OS	Architecture	Artifact
macOS	arm64	`alumnium-cli-darwin-arm64`
macOS	x64	`alumnium-cli-darwin-x64`
Linux	arm64	`alumnium-cli-linux-arm64`
Linux	x64	`alumnium-cli-linux-x64`
Windows	arm64	`alumnium-cli-windows-arm64`
Windows	x64	`alumnium-cli-windows-x64`

Alumnium requires Python 3+ and is distributed as a PyPI package.

To install, run the following command:

pip install alumnium

Alumnium for TypeScript requires Node.js 18+ and is distributed as an NPM package.

To install, run one of the following commands:

npm install alumnium

pnpm add alumnium

yarn add alumnium

That’s it! Keep reading to learn how to configure Alumnium to use an AI provider.