chainlit README

The project's README from github.com/Chainlit/chainlit. As one markdown file: README.md.

Welcome to Chainlit 👋

Build python production-ready conversational AI applications in minutes, not weeks ⚡️

chat on Discord Twitter Downloads Contributors CI

⚠️ Notice: Chainlit is now community-maintained.

As of May 1st 2025, the original Chainlit team has stepped back from active development. The project is maintained by @Chainlit/chainlit-maintainers under a formal Maintainer Agreement.

Maintainers are responsible for code review, releases, and security.
Chainlit SAS provides no warranties on future updates.

Want to help maintain? Apply here →

Website • Documentation • Chainlit Help • Cookbook

Chainlit%2Fchainlit | Trendshift

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

Installation

Open a terminal and run:

pip install chainlit
chainlit hello

If this opens the hello app in your browser, you're all set!

Development version

The latest in-development version can be installed straight from GitHub with:

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

(Requires Node and pnpm installed on the system.)

🚀 Quickstart

🐍 Pure Python

Create a new file demo.py with the following code:

import chainlit as cl


@cl.step(type="tool")
async def tool():
    # Fake tool
    await cl.sleep(2)
    return "Response from the tool!"


@cl.on_message  # this function will be called every time a user inputs a message in the UI
async def main(message: cl.Message):
    """
    This function is called every time a user inputs a message in the UI.
    It sends back an intermediate response from the tool, followed by the final answer.

    Args:
        message: The user's message.

    Returns:
        None.
    """


    # Call the tool
    tool_res = await tool()

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

Now run it!

chainlit run demo.py -w

Quick Start

📚 More Examples - Cookbook

You can find various examples of Chainlit apps here that leverage tools and services such as OpenAI, Anthropiс, LangChain, LlamaIndex, ChromaDB, Pinecone and more.

Tell us what you would like to see added in Chainlit using the Github issues or on Discord.

💁 Contributing

As an open-source initiative in a rapidly evolving domain, we welcome contributions, be it through the addition of new features or the improvement of documentation.

For detailed information on how to contribute, see here.

📃 License

Chainlit is open-source and licensed under the Apache 2.0 license.

chainlit (Chainlit/chainlit)

Searching Database…

12.5K ·GitHub
archived
这是什么东西?Chainlit 是一个开源的 Python 框架,让你几分钟(而不是几周)就能搭建好可用于生产环境的对话式 AI 应用。
怎么把第一个应用跑起来?在终端用 pip 安装这个包(pip install chainlit),创建一个 demo.py 并运行——等 hello 应用在你的浏览器里打开,就大功告成了。
能配合 OpenAI、LangChain 之类的工具用吗?可以——官方 Cookbook 提供了示例应用,用到了 OpenAI、Anthropic、LangChain、LlamaIndex、ChromaDB、Pinecone 等各种工具和服务。
这个项目现在还在积极维护吗?从 2025 年 5 月 1 日起,原团队已退出,目前由社区维护者团队负责代码审查、发布和安全工作;Chainlit SAS 对未来的更新不作任何保证。
用它需要懂 JavaScript 吗?它面向 Python 开发者——不需要任何 JavaScript 或前端知识。只有当你直接从 GitHub 安装开发中的版本时,才需要 Node 和 pnpm。
在自己的项目里可以免费使用吗?可以——Chainlit 基于 Apache 2.0 许可证开源,可以免费使用和修改,包括商业项目。
Chainlit 有多火?挺火的:在 GitHub 上有约 12,500 颗星,2023 年 3 月就上架了;现在开发工作由社区维护者团队负责。
试用它需要付费套餐或 API 密钥吗?Chainlit 本身完全免费;只有当你把应用接入某个 AI 服务(比如 OpenAI 或 Anthropic)时,才需要相应的密钥。
What are similar projects?botpress, gpt4free, quivr, chatgpt-web, ChatTTS, ChatALL, tambo, wanwan
Creator
Chainlit
Size
12.3 MB
Stars
12.5K
Age
3y
Commits · 90 Days