Skip to main content

A lightweight personal AI assistant framework

Project description

weavbot

GitHub Actions PyPI Docs (English) Docs (中文)

A lightweight personal AI assistant framework.

中文说明

Installation

uv tool install weavbot

Verify:

weavbot --version

To try the latest unreleased features:

uv tool install git+https://github.com/yankeguo/weavbot.git

Onboard (Recommended First Run)

Initialize local config/workspace and run the interactive setup wizard:

weavbot onboard

What onboard does:

  • Creates ~/.weavbot/config.json and ~/.weavbot/workspace/
  • Guides provider/model selection with realtime filtering
  • Configures one chat channel in the wizard (Telegram/Discord/Feishu/DingTalk/Slack/QQ/Wecom/Email/Mochat)
  • Offers optional ripgrep install and gateway auto-start setup

For non-interactive or scripted setup, use repeatable --set key=value:

weavbot onboard \
  --set providers.openrouter.apiKey=sk-or-v1-xxx \
  --set providers.openrouter.apiBase=https://openrouter.ai/api/v1 \
  --set agents.defaults.provider=openrouter \
  --set agents.defaults.model=openai/gpt-4o-mini

Detailed CLI docs:

Full documentation: https://yankeguo.github.io/weavbot/

Wechat Channel

Wechat is configured in two phases:

  1. Enable it in config (interactive onboard only sets placeholder enablement):
    • channels.wechat.enabled=true
  2. Complete QR login and credential binding with:
weavbot wechat login

For multi-account setups, put account entries under channels.wechat.accounts and optionally limit runtime accounts with channels.wechat.enabledAccounts.

Configuration reference:

Credits

This project is a hard fork of nanobot by HKUDS, with significant optimizations and improvements.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

weavbot-0.4.0.tar.gz (142.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

weavbot-0.4.0-py3-none-any.whl (184.2 kB view details)

Uploaded Python 3

File details

Details for the file weavbot-0.4.0.tar.gz.

File metadata

  • Download URL: weavbot-0.4.0.tar.gz
  • Upload date:
  • Size: 142.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for weavbot-0.4.0.tar.gz
Algorithm Hash digest
SHA256 44db64c4b624fd54c1ebc0054e2b9c86499eb89639ae519b173c858bc8c15ea2
MD5 73878fae3c233191c3d4b23240c1a8ab
BLAKE2b-256 2c751498cddff76cac793cfd95995d768a9616586481c553545f7d72b3ef2a4c

See more details on using hashes here.

Provenance

The following attestation bundles were made for weavbot-0.4.0.tar.gz:

Publisher: release.yml on yankeguo/weavbot

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file weavbot-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: weavbot-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 184.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for weavbot-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 879d8d325a6943ba4da572510cce1dac6a72ccd4b4d8b6630c5fce5937bcd4d3
MD5 0187379f938a95dd1cd787d96d8c6e1d
BLAKE2b-256 d46e18de647228d9f5484f90fff2bb24726e343bfce3c0c4357cf1832bd7b9ad

See more details on using hashes here.

Provenance

The following attestation bundles were made for weavbot-0.4.0-py3-none-any.whl:

Publisher: release.yml on yankeguo/weavbot

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page