HKUDS/nanobot:README 来源编辑指南
基于 README、仓库元数据和许可证整理 HKUDS/nanobot 的安装与核验路径。
项目定位
HKUDS/nanobot 的 README 将项目描述为"Ultra-lightweight, open-source, self-hosted personal AI agent framework in Python with WebUI, tools, memory, MCP, multi-agent workflows, automation, and chat apps"。本文只整理仓库能直接核验的内容,不把星标、Fork 或宣传语当成质量证明。README 在"nanobot"下的说明是:🐈 nanobot is an ultra-lightweight, open-source, self-hosted personal AI agent framework written in Python. It runs in a WebUI, terminal, or chat apps and combines tools, long-term memory, MCP integrations, model routing, multi-agent。这给出的首先是项目边界,而不是已经完成的生产验证。
适用场景
从 README 的"What can nanobot do?"和相关条目看,读者可以先判断它是否解决自己的具体问题:use tools such as files, shell, web search, web fetch, MCP, cron, image generation, and subagents。如果你的目标与这段说明不一致,就不应仅凭项目热度采用它。这里保留原项目名、命令和组件名,方便回到一手来源核对。 README 还列出了另一条可核对的信息:connect to Telegram, Discord, Slack, WeChat, Email, Mattermost, and other chat apps。这类原文条目可以帮助读者设计试运行步骤,但不能代替自己的环境测试。
工作方式
README 把工作方式分散写在"What can nanobot do?"等段落中。可确认的线索包括:nanobot is a self-hosted personal AI agent runtime. It can:。这篇整理没有把未写出的架构、性能或安全边界补成结论;真正的运行链仍应结合仓库目录、配置文件和版本标签检查。
安装与第一次运行
第一次安装应从 README 给出的入口开始。当前可复核的命令是: curl -fsSL https://raw.githubusercontent.com/HKUDS/nanobot/main/scripts/install.sh | sh 如果仓库没有提供命令,本文不会替它编造安装步骤,而是建议先打开 README 的"Start Here"部分,确认系统依赖、默认端口和首次初始化动作。
配置与日常使用
日常使用的细节取决于项目实际文档。README 的"📦 Install"段落提到:> [!IMPORTANT] > If you want the newest features and experiments, install from source. > > If you want the most stable day-to-day experience, install from PyPI or with uv.。对于配置文件、环境变量、权限和数据目录,当前稿只记录来源明确的部分;未写明的默认值必须在测试环境中验证,并保留可回滚的配置副本。 同一部分还提到:keep session history and long-term memory through Dream。