Skip to content

Install

Prerequisites

LanguageRequirement
PythonPython 3+
TypeScript / Node.jsNode.js 18+
JavaJDK 21+

You also need a browser driver installed separately (e.g., ChromeDriver for Selenium, or run npx playwright install for Playwright).

Install by language

Python

bash
pip install alumnium

TypeScript / JavaScript (npm)

bash
npm install alumnium

TypeScript / JavaScript (pnpm)

bash
pnpm add alumnium

TypeScript / JavaScript (yarn)

bash
yarn add alumnium

Java (Gradle)

Add to build.gradle:

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

Replace the runtime artifact suffix with your platform: darwin-arm64, darwin-x64, linux-arm64, linux-x64, windows-arm64, or windows-x64.

Java (Maven)

Add to pom.xml:

xml
<dependency>
  <groupId>ai.alumnium</groupId>
  <artifactId>alumnium</artifactId>
  <version>0.21.0</version>
  <scope>test</scope>
</dependency>

MCP (Claude integration)

To expose Alumnium as an MCP server for Claude:

bash
claude mcp add alumnium --env OPENAI_API_KEY=<your-key> -- npx alumnium mcp

LLM provider setup

Alumnium defaults to OpenAI. Set your key as an environment variable before running tests:

bash
export OPENAI_API_KEY=sk-...

See https://alumnium.ai/docs/getting-started/configuration for using alternative LLM providers.

Starter examples

The official repository includes ready-to-run examples:

https://github.com/alumnium-hq/alumnium/tree/main/examples