Skip to content

doc(readme): add PyPI badge and pip / curl install methods #761

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
qinxuye merged 2 commits into from
Jul 8, 2026
Merged

doc(readme): add PyPI badge and pip / curl install methods #761

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8e3b7c7
doc(readme): add PyPI badge and pip / curl install methods
qinxuye Jul 4, 2026
1de3c61
doc(readme): configure the model in the UI, not via env key
qinxuye Jul 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 16 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

</div>
Expand Down Expand Up @@ -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
Comment thread
qinxuye marked this conversation as resolved.
```

### 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
```
Create your admin account at `/setup`; Xagent then guides you to the Models page to connect a provider.

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 # optional: review settings
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 <admin_username>
```

That's it. Xagent is now running.

---

## One platform, three ways to use it
Expand Down
Loading