创建 Llama

开始使用 LlamaIndex 的最简单方式是使用 create-llama。这个 CLI 工具可以帮助你快速搭建一个新的 LlamaIndex 应用，并为你预先配置好所有内容。

开始使用

只需运行以下命令即可开始：

npx create-llama@latest

或者观看此视频以获取演示：

应用生成完成后，运行以下命令启动开发服务器：

npm run dev

随后访问 http://localhost:3000，即可看到你的应用。

你将获得的内容

• 一组预配置的用例，帮助你快速上手，例如 Agentic RAG、数据分析、报告生成等。
• 前端采用 shadcn/ui 中的组件。应用被设置为一个聊天界面，可以回答关于你数据的问题或与你的代理进行交互。
• 两种框架供你选择：
  • Next.js：如果你选择此选项，你将获得一个全栈 Next.js 应用程序，只需点击几下即可部署到像 Vercel 这样的平台上。该应用使用我们的 TypeScript 库 LlamaIndex.TS，并结合 LlamaIndex Server for TS。
  • Python FastAPI：如果你选择此选项，你将得到一个由 llama-index Python 包 和 LlamaIndex Server for Python 提供支持的全栈 Python 应用程序。
• 应用默认使用 OpenAI，因此你需要一个 OpenAI API 密钥；当然，你也可以自定义配置，使用我们支持的数十种其他大模型。

以下是应用的外观示例：

https://github.com/user-attachments/assets/d57af1a1-d99b-4e9c-98d9-4cbd1327eff8

使用你的数据

你可以选择性地提供自己的数据；应用会对其进行索引并加以利用，例如用于回答问题。生成的应用中会有一个名为 data 的文件夹。

应用会自动导入放置在该目录中的任何受支持的文件。对于 Next.js 应用，它们使用 LlamaIndex.TS，因此能够导入 PDF、文本、CSV、Markdown、Word 和 HTML 文件。而 Python 后端则能读取更多类型的文件，包括视频和音频文件。

在使用数据之前，你需要先对数据进行索引。如果你使用的是 Next.js 应用，请运行以下命令：

npm run generate

然后重新启动应用。请记住，如果向 data 文件夹中添加了新文件，你需要再次运行 generate。

如果你使用的是 Python 后端，则可以通过调用以下命令来触发数据索引：

uv run generate

自定义 AI 模型

应用默认使用 OpenAI 的 gpt-4.1 大模型和 text-embedding-3-large 嵌入模型。

如果你想使用不同的模型，只需添加 --ask-models CLI 参数即可。

你还可以将默认模型替换为我们支持的数十种其他大模型之一。为此，你需要手动修改生成的代码（对于 TypeScript 项目，编辑 settings.ts 文件；对于 Python 项目，编辑 settings.py 文件）。

示例

最简单的操作是在交互模式下运行 create-llama：

npx create-llama@latest
# 或
npm create llama@latest
# 或
yarn create llama
# 或
pnpm create llama@latest

系统会提示你输入项目名称以及其他配置选项，如下所示：

>> npm create llama@latest
需要安装以下包：
  create-llama@latest
是否继续？(y) y
✔ 你的项目名称是什么？… my-app
✔ 你想构建哪种用例？› Agentic RAG
✔ 你想使用哪种语言？› Python (FastAPI)
✔ 你是否希望使用 LlamaCloud 服务？… 否 / 是
✔ 请提供你的 LlamaCloud API 密钥（留空以跳过）：…
? 你希望如何继续？› - 使用方向键。按回车键提交。
    直接生成代码 (~1 秒)
❯   在 VSCode 中开始 (~1 秒)
    生成代码并安装依赖项 (~2 分钟)

非交互式运行

你也可以通过命令行参数非交互式地设置新项目。要查看最新选项列表，请运行 create-llama --help。

LlamaIndex 文档

• TS/JS 文档
• Python 文档

LlamaIndex 服务器

生成的代码使用了 LlamaIndex 服务器，它通过 API 服务器提供 LlamaIndex 工作流和代理工作流服务。更多信息请参阅以下文档：

• LlamaIndex Server For TypeScript
• LlamaIndex Server For Python

灵感来源于并改编自 create-next-app。

create-llama 快速上手指南

create-llama 是启动 LlamaIndex 项目最便捷的方式。该 CLI 工具可帮助你快速构建全新的 LlamaIndex 应用，自动完成所有基础配置。

环境准备

在开始之前，请确保你的开发环境满足以下要求：

• 操作系统：Windows, macOS, 或 Linux
• Node.js：建议安装最新 LTS 版本（用于运行 CLI 及 Next.js 前端）
• Python（可选）：如果你选择 Python (FastAPI) 后端方案，需安装 Python 3.9+ 及 uv 或 pip
• API Key：默认使用 OpenAI，需准备 OPENAI_API_KEY。也可配置为其他支持的数十种大模型。

提示：国内开发者若遇到 npm 包下载缓慢，可临时切换镜像源：

npm config set registry https://registry.npmmirror.com

安装与创建项目

无需全局安装，直接使用 npx 即可运行最新版本的创建工具。

1. 运行创建命令

在终端执行以下命令启动交互式向导：

npx create-llama@latest

或者使用其他包管理器：

npm create llama@latest
# 或
yarn create llama
# 或
pnpm create llama@latest

2. 配置项目

根据终端提示输入项目信息，典型流程如下：

✔ What is your project named? … my-app
✔ What use case do you want to build? › Agentic RAG
✔ What language do you want to use? › Python (FastAPI)
✔ Do you want to use LlamaCloud services? … No / Yes
✔ Please provide your LlamaCloud API key (leave blank to skip): …
? How would you like to proceed? › 
    Just generate code (~1 sec)
❯   Start in VSCode (~1 sec)
    Generate code and install dependencies (~2 min)

你将选择：

• 项目名称
• 应用场景：如 Agentic RAG、数据分析、报告生成等
• 技术栈：
  • Next.js：全栈 TypeScript 应用，基于 LlamaIndex.TS，适合部署到 Vercel。
  • Python FastAPI：全栈 Python 应用，基于 llama-index 包。
• 是否使用 LlamaCloud 服务（可选）

基本使用

项目生成后，按照以下步骤运行和预览应用。

1. 启动开发服务器

进入项目目录并启动服务：

对于 Next.js 项目：

npm run dev

对于 Python 项目：

uv run dev
# 或者如果使用 pip/venv
python -m uvicorn main:app --reload

启动成功后，访问 http://localhost:3000 即可查看基于 shadcn/ui 构建的聊天界面。

2. 使用自定义数据

生成的项目中包含一个 data 文件夹。你可以将支持的文件（PDF, TXT, CSV, Markdown, Word, HTML 等）放入该目录。Python 后端还支持视频和音频文件。

重要：在添加新文件后，必须重新索引数据才能被应用识别。

Next.js 项目索引命令：

npm run generate

执行后请重启开发服务器。

Python 项目索引命令：

uv run generate

3. 自定义 AI 模型

默认配置使用 OpenAI 的 gpt-4.1 和 text-embedding-3-large 模型。

• 交互式修改：运行创建命令时添加 --ask-models 参数可在向导中选择不同模型。
• 手动修改：编辑生成代码中的配置文件以切换模型：
  • TypeScript 项目：编辑 settings.ts
  • Python 项目：编辑 settings.py

更多模型支持列表请参考 LlamaIndex 官方文档。