https://github.com/astrbotdevs/astrbot-desktop
https://github.com/astrbotdevs/astrbot-desktop
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/astrbotdevs/astrbot-desktop
- Owner: AstrBotDevs
- Created: 2026-02-19T04:25:10.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2026-02-19T14:01:46.000Z (4 months ago)
- Last Synced: 2026-02-19T14:22:04.863Z (4 months ago)
- Language: Rust
- Size: 237 KB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
English ｜ 简体中文
# AstrBot Desktop
The desktop edition of AstrBot, designed for fast local installation and convenient access to ChatUI and plugins.
Upstream AstrBot
·
Documentation
·
Releases
·
Issue Tracker
AstrBot Desktop is a packaged desktop distribution of AstrBot for local use. It bundles the WebUI, backend runtime, and desktop shell into a single app, making it a good fit for users who want a quick local setup with ChatUI, plugins, and knowledge base features. If you plan to run AstrBot on a server for long-term use, the upstream AstrBot source, Docker, or panel-based deployment is still the better choice.
## Best Fit For
- You want to install AstrBot directly on Windows, macOS, or Linux without preparing a full command-line environment first.
- You mainly use ChatUI, the plugin marketplace, and the knowledge base on your local machine.
- You want your data stored in a local directory for easier backup, migration, and troubleshooting.
- You need both `stable` and `nightly` release channels for daily use or early access testing.
## Highlights
1. Ready-to-use desktop installation experience with the WebUI and backend runtime included by default.
2. Compatible with the upstream AstrBot ecosystem for local ChatUI, plugins, and common workflows.
3. Uses an isolated local data directory by default, making configuration, plugins, and logs easier to manage.
4. Provides both `stable` and `nightly` channels for stable usage or early access to recent changes.
5. Supports migration to source-based deployment, and migration back from source deployment to the desktop app.
## One-Click Install
If you only want to use the app and do not need to build it locally, download the installer for your platform from [`Releases`](https://github.com/AstrBotDevs/AstrBot-desktop/releases/latest).
- [Stable](https://github.com/AstrBotDevs/AstrBot-desktop/releases/latest): recommended for most users.
- [Nightly](https://github.com/AstrBotDevs/AstrBot-desktop/releases/tag/nightly): automatically built from newer upstream changes for early access to fixes and features.
- Choose the package that matches your operating system and CPU architecture.
## Data and Configuration Location
AstrBot Desktop stores the AstrBot root directory under the user home directory as `.astrbot` by default:
- macOS / Linux: `~/.astrbot`
- Windows: `C:\Users\\.astrbot`
Common directories:
| Path | Description |
| --- | --- |
| `data/config/` | Configuration files |
| `data/plugins/` | Plugins |
| `data/plugin_data/` | Plugin data |
| `data/knowledge_base/` | Knowledge base data |
| `data/webchat/` | WebChat-related data |
| `logs/` | Desktop and backend logs |
If you need to migrate data between the desktop app and a source-based deployment, read [`docs/data-migration.md`](docs/data-migration.md) first.
## Updates and Release Channels
- `stable`: recommended for everyday use.
- `nightly`: closer to the latest upstream commits, suitable for testing new features or fixes.
- On Windows, macOS, and Linux AppImage builds, the desktop updater usually works directly in-app. Some Linux installation methods may still require manual download and installation.
## FAQ
### Is it suitable for server deployment?
Not really. AstrBot Desktop is intended for local desktop usage and personal workflows. If you need long-running, stable server deployment, use the upstream AstrBot source, Docker, or panel-based deployment instead.
### macOS says the app is damaged or cannot be opened
If you downloaded the installer from the internet, macOS may attach a quarantine flag to the app. Run:
```bash
xattr -dr com.apple.quarantine /Applications/AstrBot.app
```
Then restart the app. If the app is not located in `/Applications`, replace the path with the actual one.
### Why do some MCP tools say `node`, `npx`, or `uvx` is missing?
Some MCP tools depend on `node`, `npx`, or `uvx` from your system environment. These dependencies are not bundled with the desktop installer, so you need to install them separately.
- Node.js installation docs:
- uv installation docs:
After installation, you can verify them yourself:
```bash
node -v
npm -v
npx -v
uvx --version
```
## Further Documentation
The following repository documents are currently written in Chinese:
- [`docs/data-migration.md`](docs/data-migration.md): data migration between the desktop app and source deployment.
- [`docs/development.md`](docs/development.md): local build, maintenance commands, version syncing, and release notes.
- [`docs/environment-variables.md`](docs/environment-variables.md): environment variable reference.
- [`docs/architecture.md`](docs/architecture.md): current desktop architecture.
- [`docs/repository-structure.md`](docs/repository-structure.md): repository structure overview.
## Feedback
If you need installation help or want to report issues and suggestions, you can reach out through:
- GitHub Issues:
- QQ Group: 1060046189
## License
This project is licensed under `AGPL-3.0`. See [`LICENSE`](./LICENSE) for the full text.