From 8e3b7c7cfdd7cbe033135ea1ece5ab6ceff130fa Mon Sep 17 00:00:00 2001 From: qinxuye Date: Sat, 4 Jul 2026 21:29:55 +0800 Subject: [PATCH 1/2] doc(readme): add PyPI badge and pip / curl install methods Add a PyPI version badge and a 'Run on your machine' Quick Start path (uv/pip install of xagent-ai, or curl https://get.xagent.co | sh), keeping Docker as the teams/self-hosting option. Kept the section tight. --- README.md | 34 ++++++++++++++++------------------ 1 file changed, 16 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 527853c6a7..66b7805835 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ [![Documentation](https://img.shields.io/badge/docs-docs.xagent.co-blue?style=for-the-badge&logo=gitbook)](https://docs.xagent.co/) [![GitHub Release](https://img.shields.io/github/v/release/xorbitsai/xagent?logo=github&style=for-the-badge)](https://github.com/xorbitsai/xagent/releases) +[![PyPI](https://img.shields.io/pypi/v/xagent-ai?style=for-the-badge&logo=pypi&logoColor=white)](https://pypi.org/project/xagent-ai/) [![Docker Pulls](https://img.shields.io/docker/pulls/xprobe/xagent-backend?style=for-the-badge&logo=docker)](https://hub.docker.com/r/xprobe/xagent-backend) @@ -44,41 +45,38 @@ Join [Telegram](https://t.me/+2_-SAVLtuJNkNWFl) | [Discord](https://discord.gg/R ## Quick Start -**Get started in 3 minutes** +### Run on your machine -### 1️⃣ Clone and configure +The published package bundles the web UI — no Docker or Node required (Python 3.11+): ```bash -git clone https://github.com/xorbitsai/xagent.git -cd xagent -cp example.env .env -# Edit .env to configure at least one LLM API key. +uv tool install xagent-ai # or: pip install xagent-ai (use a virtualenv) +xagent # then open http://127.0.0.1:8000 ``` -### 2️⃣ Start with Docker +Or in one line: ```bash -docker compose up -d +curl -fsSL https://get.xagent.co | sh ``` -### 3️⃣ Open in browser - -``` -http://localhost:80 -``` +Set at least one LLM API key (e.g. `OPENAI_API_KEY`) via a `.env` file or your environment, then create your admin account at `/setup`. -On first startup, Xagent redirects to `/setup`. +### Run with Docker (teams / self-hosting) -Create the first administrator account to complete initialization. +```bash +git clone https://github.com/xorbitsai/xagent.git +cd xagent +cp example.env .env # configure at least one LLM API key +docker compose up -d # then open http://localhost:80 +``` -If the admin password is forgotten, reset it via CLI: +On first startup, Xagent redirects to `/setup` to create the first administrator account. Forgot the admin password? Reset it: ```bash docker compose exec backend python -m xagent.web.reset_admin_password --username ``` -That's it. Xagent is now running. - --- ## One platform, three ways to use it From 1de3c61149dd4b2c10d9800dced9f890e9c34d94 Mon Sep 17 00:00:00 2001 From: qinxuye Date: Sat, 4 Jul 2026 21:37:00 +0800 Subject: [PATCH 2/2] doc(readme): configure the model in the UI, not via env key Xagent redirects to the Models page when no provider is configured, so drop the 'set an LLM API key first' instruction from Quick Start. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 66b7805835..326f03388d 100644 --- a/README.md +++ b/README.md @@ -60,14 +60,14 @@ Or in one line: curl -fsSL https://get.xagent.co | sh ``` -Set at least one LLM API key (e.g. `OPENAI_API_KEY`) via a `.env` file or your environment, then create your admin account at `/setup`. +Create your admin account at `/setup`; Xagent then guides you to the Models page to connect a provider. ### Run with Docker (teams / self-hosting) ```bash git clone https://github.com/xorbitsai/xagent.git cd xagent -cp example.env .env # configure at least one LLM API key +cp example.env .env # optional: review settings docker compose up -d # then open http://localhost:80 ```