欢迎来到 Chainlit 👋

在几分钟内构建生产级的 Python 对话式 AI 应用，而不是几周 ⚡️

⚠️ 注意： Chainlit 现已由社区维护。

自 2025 年 5 月 1 日起，原 Chainlit 团队已退出项目的积极开发。该项目现由 @Chainlit/chainlit-maintainers 在正式的维护者协议下维护。

维护者负责代码审查、发布和安全性。
Chainlit SAS 不对未来的更新提供任何保证。

想要参与维护吗？请在此申请 →

官网 • 文档 • Chainlit 帮助 • 示例集

https://github.com/user-attachments/assets/b3738aba-55c0-42fa-ac00-6efd1ee0d148

安装

打开终端并运行：

pip install chainlit
chainlit hello

如果这会在你的浏览器中打开 hello app，那么你就准备好了！

开发版本

最新的开发版本可以直接从 GitHub 安装：

pip install git+https://github.com/Chainlit/chainlit.git#subdirectory=backend/

（需要系统上已安装 Node 和 pnpm。）

🚀 快速入门

🐍 纯 Python

创建一个名为 demo.py 的新文件，并输入以下代码：

import chainlit as cl


@cl.step(type="tool")
async def tool():
    # 虚拟工具
    await cl.sleep(2)
    return "来自工具的响应！"


@cl.on_message  # 此函数将在用户每次在 UI 中输入消息时被调用
async def main(message: cl.Message):
    """
    当用户在 UI 中输入消息时，此函数会被调用。它会先发送来自工具的中间响应，随后再发送最终答案。

    参数：
        message: 用户的消息。

    返回值：
        无。
    """


    # 调用工具
    tool_res = await tool()

    await cl.Message(content=tool_res).send()

现在运行它！

chainlit run demo.py -w

📚 更多示例 - 示例集

你可以在 这里 找到各种利用 OpenAI、Anthropic、LangChain、LlamaIndex、ChromaDB、Pinecone 等工具和服务的 Chainlit 应用示例。

请通过 GitHub 问题或 Discord 告诉我们你希望在 Chainlit 中看到哪些新增功能。

💁 参与贡献

作为一项快速发展的开源项目，我们欢迎任何形式的贡献，无论是添加新功能还是改进文档。

有关如何参与贡献的详细信息，请参阅 此处。

📃 许可证

Chainlit 是开源软件，采用 Apache 2.0 许可证授权。

Chainlit 快速上手指南

Chainlit 是一个用于快速构建生产级对话式 AI 应用的 Python 框架。只需几分钟，即可将你的 LLM 逻辑转化为功能完备的 Web 界面。

环境准备

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

• 操作系统：Windows, macOS 或 Linux
• Python 版本：Python 3.9 或更高版本
• 包管理器：pip
• 可选（仅开发版需要）：Node.js 和 pnpm

注意：自 2025 年 5 月 1 日起，Chainlit 转为社区维护模式。项目由社区维护者团队负责代码审查、发布及安全更新。

安装步骤

1. 安装稳定版

打开终端，运行以下命令安装最新稳定版本：

pip install chainlit

国内加速建议：如果下载速度较慢，推荐使用国内镜像源安装：

pip install chainlit -i https://pypi.tuna.tsinghua.edu.cn/simple

2. 验证安装

运行官方提供的 Hello World 示例，确认安装成功并自动在浏览器中打开应用：

chainlit hello

如果浏览器成功弹出欢迎界面，说明环境已配置完毕。

（可选）安装开发版

如需体验最新在研功能，可直接从 GitHub 安装（需预先安装 Node 和 pnpm）：

pip install git+https://github.com/Chainlit/chainlit.git#subdirectory=backend/

基本使用

1. 创建应用文件

新建一个名为 demo.py 的文件，并填入以下代码。这是一个最基础的示例，展示了如何定义消息处理函数和工具步骤：

import chainlit as cl


@cl.step(type="tool")
async def tool():
    # 模拟一个耗时工具调用
    await cl.sleep(2)
    return "Response from the tool!"


@cl.on_message  # 当用户在 UI 中输入消息时，此函数将被调用
async def main(message: cl.Message):
    """
    处理用户消息：先调用工具，再返回最终结果。
    """
    # 调用工具
    tool_res = await tool()

    # 发送回复消息
    await cl.Message(content=tool_res).send()

2. 运行应用

在终端中执行以下命令启动应用。-w 参数表示开启热重载模式，修改代码后无需重启即可生效：

chainlit run demo.py -w

运行后，终端会显示本地访问地址（通常为 http://localhost:8000），点击链接或在浏览器中打开即可与你的 AI 应用进行交互。

---

更多高级示例（如集成 OpenAI、LangChain、LlamaIndex 等）可参考官方 Cookbook。