diff --git a/README.md b/README.md index 1c3c56bd..b426a0d6 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,25 @@ LangBot 是一个开源的大语言模型原生即时通信机器人开发平台 ## 📦 开始使用 +#### 快速体验(推荐) + +使用 `uvx` 一键启动(无需安装): + +```bash +uvx langbot +``` + +或使用 `pip` 安装后运行: + +```bash +pip install langbot +langbot +``` + +访问 http://localhost:5300 即可开始使用。 + +详细文档[PyPI 安装](docs/PYPI_INSTALLATION.md)。 + #### Docker Compose 部署 ```bash diff --git a/README_EN.md b/README_EN.md index 86a021fd..bb7e481c 100644 --- a/README_EN.md +++ b/README_EN.md @@ -25,6 +25,25 @@ LangBot is an open-source LLM native instant messaging robot development platfor ## 📦 Getting Started +#### Quick Start (Recommended) + +Use `uvx` to start with one command (no installation required): + +```bash +uvx langbot +``` + +Or install with `pip` and run: + +```bash +pip install langbot +langbot +``` + +Visit http://localhost:5300 to start using it. + +Detailed documentation [PyPI Installation](docs/PYPI_INSTALLATION.md). + #### Docker Compose Deployment ```bash diff --git a/docs/PYPI_INSTALLATION.md b/docs/PYPI_INSTALLATION.md new file mode 100644 index 00000000..aff9386d --- /dev/null +++ b/docs/PYPI_INSTALLATION.md @@ -0,0 +1,105 @@ +# LangBot PyPI Package Installation + +## Quick Start with uvx + +The easiest way to run LangBot is using `uvx` (recommended for quick testing): + +```bash +uvx langbot +``` + +This will automatically download and run the latest version of LangBot. + +## Install with pip/uv + +You can also install LangBot as a regular Python package: + +```bash +# Using pip +pip install langbot + +# Using uv +uv pip install langbot +``` + +Then run it: + +```bash +langbot +``` + +Or using Python module syntax: + +```bash +python -m langbot +``` + +## Installation with Frontend + +When published to PyPI, the LangBot package includes the pre-built frontend files. You don't need to build the frontend separately. + +## Data Directory + +When running LangBot as a package, it will create a `data/` directory in your current working directory to store configuration, logs, and other runtime data. You can run LangBot from any directory, and it will set up its data directory there. + +## Command Line Options + +LangBot supports the following command line options: + +- `--standalone-runtime`: Use standalone plugin runtime +- `--debug`: Enable debug mode + +Example: + +```bash +langbot --debug +``` + +## Comparison with Other Installation Methods + +### PyPI Package (uvx/pip) +- **Pros**: Easy to install and update, no need to clone repository or build frontend +- **Cons**: Less flexible for development/customization + +### Docker +- **Pros**: Isolated environment, easy deployment +- **Cons**: Requires Docker + +### Manual Source Installation +- **Pros**: Full control, easy to customize and develop +- **Cons**: Requires building frontend, managing dependencies manually + +## Development + +If you want to contribute or customize LangBot, you should still use the manual installation method by cloning the repository: + +```bash +git clone https://github.com/langbot-app/LangBot +cd LangBot +uv sync +cd web +npm install +npm run build +cd .. +uv run main.py +``` + +## Updating + +To update to the latest version: + +```bash +# With pip +pip install --upgrade langbot + +# With uv +uv pip install --upgrade langbot + +# With uvx (automatically uses latest) +uvx langbot +``` + +## System Requirements + +- Python 3.10.1 or higher +- Operating System: Linux, macOS, or Windows