Skip to content
AstrBot
Main Navigation HomeFork GuideReleasesHTTP API

English

简体中文

English

简体中文

Toggle dark mode

Intro & DeployMessaging PlatformsAI IntegrationUsageDevelopment
Sidebar Navigation

Introduction

What is AstrBot

Community

FAQ

Deployment

Script Deployment

Desktop Client

One-click Launcher

Docker

Kubernetes

BT Panel

1Panel

Source Deployment

Other Deployments

CasaOS

Compshare GPU

Community-provided Deployment

Support Us

Messaging Platforms

Quick Start

QQ Official Bot

Websockets

Webhook

OneBot v11

WeCom Application

WeCom AI Bot

WeChat Official Account

Personal WeChat

Lark

DingTalk

Telegram

LINE

Slack

Mattermost

Misskey

Discord

KOOK

Satori

Connect Satori

Using server-satori

Community-provided

Matrix

VoceChat

AI Integration

✨ Model Providers

MiraRouter

NewAPI

ShengSuanYun

AIHubMix

PPIO Cloud

SiliconFlow

TokenPony

302.AI

Ollama

LMStudio

⚙️ Agent Runners

Built-in Agent Runner

Dify

Coze

Alibaba Bailian

DeerFlow

Usage

WebUI

AstrBot CLI

Built-in Commands

Plugins

Plugins

MCP

Skills

AstrBot Built-in AI

Agent Sandbox

SubAgent Orchestration

Proactive Capabilities

Web Search

SerpApi

DeepSeek Search API

Knowledge Base

Context Compression

Custom Rules

Agent Execution Mode

Unified Webhook Mode

Development

Plugin Development

🌠 Getting Started

Minimal Example

Listen to Message Events

Send Messages

Plugin Configuration

Plugin Views

Plugin Internationalization

AI

Storage

HTML to Image

Session Control

Publish Plugin

Plugin Market Specification

Versions

2026-06-27

Platform Adapter Integration

AstrBot HTTP API

API Scope–Endpoint Reference

AstrBot Configuration File

Others

Diagnostics

Self-hosted HTML to Image

Open Source Summer

OSPP 2025

On this page

Script Deployment ​

AstrBot provides installation scripts for Linux, macOS, WSL, and Windows. The scripts install uv, AstrBot, and Python 3.12.

Linux / macOS / WSL ​

Interactive installation:

bash
curl -fsSL https://docs.astrbot.app/install.sh | bash

Unattended installation:

bash
curl -fsSL https://docs.astrbot.app/install.sh -o install.sh
bash install.sh --language en-US --download-source official --non-interactive

--download-source accepts china, official, or custom. The default language is English. If the source is omitted, Chinese uses the mainland China mirrors; English and Japanese use official sources.

Windows ​

Run these commands in PowerShell 5.1 or PowerShell 7+.

Interactive installation:

powershell
irm https://docs.astrbot.app/install.ps1 | iex

Unattended installation:

powershell
Invoke-WebRequest https://docs.astrbot.app/install.ps1 -OutFile install.ps1 -UseBasicParsing
.\install.ps1 -Language en-US -DownloadSource official -NonInteractive

-DownloadSource accepts china, official, or custom. The default language is English. If the source is omitted, Chinese uses the mainland China mirrors; English and Japanese use official sources.

The mainland China option also configures the USTC mirror for Python 3.12 and retries with the official Python source on failure. Existing Python mirror environment variables or explicit options take priority.

After Installation ​

The installer runs uv tool update-shell. Reload the environment for your shell:

bash
# Bash
source ~/.bashrc
# Zsh
source ~/.zshrc
# Fish
source ~/.config/fish/config.fish
# PowerShell
. $PROFILE

Then run these commands manually:

bash
astrbot init
astrbot run

AstrBot installed by script does not support upgrades through the WebUI. Run uv tool upgrade astrbot --python 3.12 to update it.

Edit this page on GitHub

Last updated:

Pager
PreviousFAQ
NextDesktop Client

Sakura520222 独立维护 · 基于 AstrBot · AGPL-3.0-or-later