Arclet

Installation

Get started by installing the SDK.

Overview

Arclet is published as a zero-dependency TypeScript package, compatible with Node.js 18+, Deno, and Bun.


Package Installation

Install arclet alongside zod (used for schema validation and structured output) using your package manager of choice:

pnpm add arclet zod
npm i arclet zod
yarn add arclet zod
bun add arclet zod

Verify the install

npx arclet --version

Environment Credentials

Arclet's LLM adapters read provider keys from environment variables at runtime. You only need to set the key(s) for the provider(s) you plan to use — Arclet will fail fast with a clear error if a required key is missing rather than failing silently.

.env
# OpenAI provider
OPENAI_API_KEY="sk-proj-..."

# Anthropic Claude provider
ANTHROPIC_API_KEY="sk-ant-..."

# Google Gemini provider
GEMINI_API_KEY="AIzaSy..."

Never commit .env files or hardcode provider keys in source. Load them via your process manager or a secrets store in production.


TypeScript Configuration

Arclet relies on modern TypeScript output and Node's native ESM resolution. Your tsconfig.json should target ES2022 or higher with strict mode enabled:

tsconfig.json
{
  "compilerOptions": {
    "target": "ES2022",
    "module": "NodeNext",
    "moduleResolution": "NodeNext",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true
  }
}