Install

Requirements

• Node.js >= 20.19
• Chrome or Chromium installed locally (for type: "local" browser mode)
• An LLM provider API key (Anthropic, Google, or OpenAI)

Install the package

npm install @omxyz/lumen

Set your API key

For Anthropic (recommended default):

export ANTHROPIC_API_KEY="sk-ant-..."

For Google:

export GOOGLE_API_KEY="..."

For OpenAI:

export OPENAI_API_KEY="sk-..."

Alternative: Browserbase (remote cloud browser)

If you do not want to run a local Chrome instance, Lumen supports Browserbase as a remote browser backend. Set the browser.type option to "browserbase" in your agent config and provide Browserbase credentials via environment variables.

TypeScript runner (for .ts files)

Lumen examples are written in TypeScript. Run them with:

npm install -D tsx
npx tsx agent.ts