前置要求

Node.js 18 或更高版本
包管理器：pnpm、npm、yarn 或 bun

使用 node --version 检查您的 Node.js 版本。Amux 需要 Node.js 18+。

安装包

安装核心包和您需要的适配器：

pnpm add @amux.ai/llm-bridge @amux.ai/adapter-openai @amux.ai/adapter-anthropic

可用包

包名	大小	描述
`@amux.ai/llm-bridge`	~15KB	核心包（必需）
`@amux.ai/adapter-openai`	~8KB	OpenAI 适配器
`@amux.ai/adapter-anthropic`	~8KB	Anthropic 适配器
`@amux.ai/adapter-deepseek`	~6KB	DeepSeek 适配器
`@amux.ai/adapter-moonshot`	~6KB	Moonshot 适配器
`@amux.ai/adapter-zhipu`	~6KB	智谱适配器
`@amux.ai/adapter-qwen`	~6KB	Qwen 适配器
`@amux.ai/adapter-google`	~7KB	Google Gemini 适配器
`@amux.ai/adapter-minimax`	~6KB	MiniMax 适配器

只安装您需要的适配器。这些包支持 tree-shaking，因此未使用的代码不会包含在您的打包文件中。

环境设置

为您的 API 密钥创建一个 .env 文件：

# .env
OPENAI_API_KEY=sk-...
ANTHROPIC_API_KEY=sk-ant-...
DEEPSEEK_API_KEY=sk-...

永远不要将 .env 文件提交到版本控制。将 .env 添加到您的 .gitignore。

TypeScript 配置

Amux 包含完整的 TypeScript 定义。确保您的 tsconfig.json 包含：

{
  "compilerOptions": {
    "target": "ES2020",
    "module": "ESNext",
    "moduleResolution": "bundler",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true
  }
}

验证安装

创建一个测试文件来验证一切正常：

// test.ts
import { createBridge } from '@amux.ai/llm-bridge'
import { openaiAdapter } from '@amux.ai/adapter-openai'

console.log('✓ Amux 安装成功！')
console.log('✓ OpenAI 适配器：', openaiAdapter.name, 'v' + openaiAdapter.version)

运行它：

tsx test.ts

您应该看到：

✓ Amux 安装成功！
✓ OpenAI 适配器： openai v1.0.0

下一步

快速开始

5 分钟构建您的第一个桥接

核心概念

了解 Amux 的工作原理

API 参考

探索完整 API

安装