dev

.env.example

@@ -0,0 +1,184 @@
+# ==========================================
+# AstrBot Instance Configuration: ${INSTANCE_NAME}
+# AstrBot 实例配置文件：${INSTANCE_NAME}
+# ==========================================
+# 将此文件复制为 .env 并根据需要修改。
+# Copy this file to .env and modify as needed.
+# 注意：在此处设置的变量将覆盖默认配置。
+# Note: Variables set here override application defaults.
+
+# ------------------------------------------
+# 实例标识 / Instance Identity
+# ------------------------------------------
+
+# 实例名称（用于日志和服务名）
+# Instance name (used in logs/service names)
+INSTANCE_NAME="${INSTANCE_NAME}"
+
+# ------------------------------------------
+# 核心配置 / Core Configuration
+# ------------------------------------------
+
+# AstrBot 根目录路径
+# AstrBot root directory path
+# 默认 Default: 当前工作目录，桌面客户端为 ~/.astrbot，服务器为 /var/lib/astrbot/<instance>/
+# 示例 Example: /var/lib/astrbot/mybot
+ASTRBOT_ROOT="${ASTRBOT_ROOT}"
+
+# 日志等级
+# Log level
+# 可选值 Values: DEBUG, INFO, WARNING, ERROR, CRITICAL
+# 默认 Default: INFO
+# ASTRBOT_LOG_LEVEL=INFO
+
+# 启用插件热重载（开发时有用）
+# Enable plugin hot reload (useful for development)
+# 可选值 Values: 0 (禁用 disabled), 1 (启用 enabled)
+# 默认 Default: 0
+# ASTRBOT_RELOAD=0
+
+# 禁用匿名使用统计
+# Disable anonymous usage statistics
+# 可选值 Values: 0 (启用统计 enabled), 1 (禁用统计 disabled)
+# 默认 Default: 0
+ASTRBOT_DISABLE_METRICS=0
+
+# 覆盖 Python 可执行文件路径（用于本地代码执行功能）
+# Override Python executable path (for local code execution)
+# 示例 Example: /usr/bin/python3, /home/user/.pyenv/shims/python
+# PYTHON=/usr/bin/python3
+
+# 启用演示模式（可能限制部分功能）
+# Enable demo mode (may restrict certain features)
+# 可选值 Values: True, False
+# 默认 Default: False
+# DEMO_MODE=False
+
+# 启用测试模式（影响日志和部分行为）
+# Enable testing mode (affects logging and behavior)
+# 可选值 Values: True, False
+# 默认 Default: False
+# TESTING=False
+
+# 标记：是否通过桌面客户端执行（主要用于内部）
+# Flag: running via desktop client (internal use)
+# 可选值 Values: 0, 1
+# ASTRBOT_DESKTOP_CLIENT=0
+
+# 标记：是否通过 systemd 服务执行
+# Flag: running via systemd service
+# 可选值 Values: 0, 1
+ASTRBOT_SYSTEMD=1
+
+# ------------------------------------------
+# 管理面板配置 / Dashboard Configuration
+# ------------------------------------------
+
+# 启用或禁用 WebUI 管理面板
+# Enable or disable WebUI dashboard
+# 可选值 Values: True, False
+# 默认 Default: True
+ASTRBOT_DASHBOARD_ENABLE=True
+
+# 允许跨域请求的来源域名（多个用逗号分隔，允许所有则用 *）
+# Allowed CORS origins for WebUI dashboard (comma-separated, or * for all)
+# 示例 Example: https://dash.astrbot.men
+# 默认 Default: *
+# ASTRBOT_CORS_ALLOW_ORIGIN="*"
+
+# ------------------------------------------
+# 国际化配置 / Internationalization Configuration
+# ------------------------------------------
+
+# CLI 界面语言
+# CLI interface language
+# 可选值 Values: zh (中文), en (英文)
+# 默认 Default: zh (跟随系统 locale / follows system locale)
+# ASTRBOT_CLI_LANG=zh
+
+# ------------------------------------------
+# 网络配置 / Network Configuration
+# ------------------------------------------
+
+# API 绑定主机
+# API bind host
+# 示例 Example: 0.0.0.0 (所有接口 all interfaces), 127.0.0.1 (仅本地 localhost only)
+ASTRBOT_HOST="${ASTRBOT_HOST}"
+
+# API 绑定端口
+# API bind port
+# 示例 Example: 3000, 6185, 8080
+ASTRBOT_PORT="${ASTRBOT_PORT}"
+
+# 是否为 API 启用 SSL/TLS
+# Enable SSL/TLS for API
+# 可选值 Values: true, false
+# 默认 Default: false
+ASTRBOT_SSL_ENABLE=false
+
+# SSL 证书路径（PEM 格式）
+# SSL certificate path (PEM format)
+# 示例 Example: /etc/astrbot/certs/myinstance/fullchain.pem
+ASTRBOT_SSL_CERT=""
+
+# SSL 私钥路径（PEM 格式）
+# SSL private key path (PEM format)
+# 示例 Example: /etc/astrbot/certs/myinstance/privkey.pem
+ASTRBOT_SSL_KEY=""
+
+# SSL CA 证书链路径（可选，用于客户端验证）
+# SSL CA certificates bundle (optional, for client verification)
+# 示例 Example: /etc/ssl/certs/ca-certificates.crt
+ASTRBOT_SSL_CA_CERTS=""
+
+# ------------------------------------------
+# 代理配置 / Proxy Configuration
+# ------------------------------------------
+
+# HTTP 代理地址
+# HTTP proxy URL
+# 示例 Example: http://127.0.0.1:7890, socks5://127.0.0.1:1080
+# http_proxy=
+
+# HTTPS 代理地址
+# HTTPS proxy URL
+# 示例 Example: http://127.0.0.1:7890, socks5://127.0.0.1:1080
+# https_proxy=
+
+# 不走代理的主机列表（逗号分隔）
+# Hosts to bypass proxy (comma-separated)
+# 示例 Example: localhost,127.0.0.1,192.168.0.0/16,.local
+# no_proxy=localhost,127.0.0.1
+
+# ------------------------------------------
+# 第三方集成 / Third-party Integrations
+# ------------------------------------------
+
+# 阿里云 DashScope API 密钥（用于 Rerank 服务）
+# Alibaba DashScope API Key (for Rerank service)
+# 获取地址 Get from: https://dashscope.console.aliyun.com/
+# 示例 Example: sk-xxxxxxxxxxxx
+# DASHSCOPE_API_KEY=
+
+# Coze 集成
+# Coze integration
+# 获取地址 Get from: https://www.coze.com/
+# COZE_API_KEY=
+# COZE_BOT_ID=
+
+# 计算机控制相关的数据目录（用于截图/文件存储）
+# Computer control data directory (for screenshots/file storage)
+# 示例 Example: /var/lib/astrbot/bay_data
+# BAY_DATA_DIR=
+
+# ------------------------------------------
+# 平台特定配置 / Platform-specific Configuration
+# ------------------------------------------
+
+# QQ 官方机器人测试模式开关
+# QQ official bot test mode
+# 可选值 Values: on, off
+# 默认 Default: off
+# TEST_MODE=off
+
+# End of template / 模板结束

.envrc

@@ -0,0 +1,2 @@
+git pull
+git status

.github/workflows/smoke_test.yml

@@ -5,9 +5,9 @@ on:
     branches:
       - master
     paths-ignore:
-      - 'README*.md'
-      - 'changelogs/**'
-      - 'dashboard/**'
+      - "README*.md"
+      - "changelogs/**"
+      - "dashboard/**"
   pull_request:
   workflow_dispatch:
 
@@ -16,7 +16,7 @@ jobs:
     name: Run smoke tests
     runs-on: ubuntu-latest
     timeout-minutes: 10
-    
+
     steps:
       - name: Checkout
         uses: actions/checkout@v6
@@ -26,8 +26,8 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v6
         with:
-          python-version: '3.12'
-      
+          python-version: "3.12"
+
       - name: Install UV package manager
         run: |
           pip install uv
@@ -40,6 +40,9 @@ jobs:
       - name: Run smoke tests
         run: |
           uv run main.py &
+          # uv tool install -e . --force
+          # astrbot init -y 
+          # astrbot run --backend-only &
           APP_PID=$!
 
           echo "Waiting for application to start..."

.gitignore

@@ -1,6 +1,5 @@
 # Python related
 __pycache__
-.mypy_cache
 .venv*
 .conda/
 uv.lock
@@ -51,16 +50,38 @@ astrbot.lock
 chroma
 venv/*
 pytest.ini
-AGENTS.md
 IFLOW.md
 
 # genie_tts data
 CharacterModels/
 GenieData/
 .agent/
 .codex/
+.claude/
 .opencode/
 .kilocode/
+.serena
 .worktrees/
 
+.astrbot_sdk_testing/
+.env
+dashboard/warker.js
 dashboard/bun.lock
+.pua/
+
+# Rust build artifacts
+rust/target/
+
+# Build outputs
+dist/
+*.whl
+# 拓展模块
+*.so
+*.dll
+
+# MDI font subset (generated by dashboard/scripts/subset-mdi-font.mjs)
+dashboard/src/assets/mdi-subset/*.woff
+dashboard/src/assets/mdi-subset/*.woff2
+.planning
+*cache
+node_modules

.pre-commit-config.yaml

@@ -6,20 +6,20 @@ ci:
   autoupdate_schedule: weekly
   autoupdate_commit_msg: ":balloon: pre-commit autoupdate"
 repos:
-- repo: https://github.com/astral-sh/ruff-pre-commit
-  # Ruff version.
-  rev: v0.14.1
-  hooks:
-    # Run the linter.
-    - id: ruff-check
-      types_or: [ python, pyi ]
-      args: [ --fix ]
-    # Run the formatter.
-    - id: ruff-format
-      types_or: [ python, pyi ]
-      
-- repo: https://github.com/asottile/pyupgrade
-  rev: v3.21.0
-  hooks:
-    - id: pyupgrade
-      args: [--py310-plus]
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.15.7
+    hooks:
+      # Run the linter.
+      - id: ruff-check
+        types_or: [python, pyi]
+        args: [--fix]
+      # Run the formatter.
+      - id: ruff-format
+        types_or: [python, pyi]
+
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.21.2
+    hooks:
+      - id: pyupgrade
+        args: [--py312-plus]

.python-version

@@ -1 +1 @@
-3.12
+3.12

AGENTS.md

@@ -3,8 +3,10 @@
 ### Core
 
 ```
-uv sync
-uv run main.py
+uv tool install -e . --force
+astrbot init
+astrbot run # start the bot 
+astrbot run --backend-only # start the backend only
 ```
 
 Exposed an API server on `http://localhost:6185` by default.
@@ -13,8 +15,8 @@ Exposed an API server on `http://localhost:6185` by default.
 
 ```
 cd dashboard
-pnpm install # First time only. Use npm install -g pnpm if pnpm is not installed.
-pnpm dev
+bun install # First time only.
+bun dev
 ```
 
 Runs on `http://localhost:3000` by default.
@@ -27,8 +29,31 @@ Runs on `http://localhost:3000` by default.
 4. When committing, ensure to use conventional commits messages, such as `feat: add new agent for data analysis` or `fix: resolve bug in provider manager`.
 5. Use English for all new comments.
 6. For path handling, use `pathlib.Path` instead of string paths, and use `astrbot.core.utils.path_utils` to get the AstrBot data and temp directory.
+7. Use Python 3.12+ type hinting syntax (e.g., `list[str]` over `List[str]`, `int | None` over `Optional[int]`). Avoid using `Any` and `cast()` - use proper TypedDict, dataclass, or Protocol instead. When encountering dict access issues (e.g., `msg.get("key")` where ty infers wrong type), define a TypedDict with `total=False` to explicitly declare allowed keys.
+
+   Good example:
+   ```python
+   class MessageComponent(TypedDict, total=False):
+       type: str
+       text: str
+       path: str
+   ```
+
+   Bad example (avoid):
+   ```python
+   msg: Any = something
+   msg = cast(dict, msg)
+   ```
+8. When introducing new environment variables:
+   - Use the `ASTRBOT_` prefix for naming (e.g., `ASTRBOT_ENABLE_FEATURE`).
+   - Add the variable and description to `.env.example`.
+   - Update `astrbot/cli/commands/cmd_run.py`:
+     - Add to the module docstring under "Environment Variables Used in Project".
+     - Add to the `keys_to_print` list in the `run` function for debug output.
+9. To check all available CLI commands and their usage recursively, run `astrbot help --all`.
+10. uv sync --group dev && uv run pytest --cov=astrbot tests/
 
 ## PR instructions
 
 1. Title format: use conventional commit messages
-2. Use English to write PR title and descriptions.
+2. Use English to write PR title and descriptions./<