安装
ReadShell 通过 npm 全局安装:先装好 Node.js 20 或更高版本,再执行
npm install -g readshell 即可。没有账号、没有后台服务,装完就能用。
安装需要什么环境?
ReadShell 是一个 Node.js 命令行程序,唯一的前置要求是 Node.js ≥ 20。
它在 macOS、Linux 和 Windows 的终端里运行(Windows 数据目录为 %APPDATA%/readshell)。
node -v # 需要 v20 或更高 怎么安装 ReadShell?
一条命令全局安装。包名是 readshell:
npm install -g readshell
安装会注册两个完全等价的命令:novel 和
readshell。文档里统一用 novel。
怎么确认装好了?
查看版本号、列出全部命令:
novel --version
novel --help 然后导入书库、开始阅读:
novel import ~/books/ # 支持 txt / epub / md,目录会递归扫描
novel resume # 打开书库继续读 怎么升级到新版本?
应用内置了升级命令,会在终端里检查并更新到 npm 上的最新版本:
novel update 数据存在哪里?
书库、阅读进度、书签和统计全部保存在本机的一个 SQLite 文件里,不同操作系统的位置如下
(也可以用环境变量 READSHELL_HOME 覆盖):
| 系统 | 数据目录 |
|---|---|
| macOS | ~/Library/Application Support/readshell/ |
| Linux | ~/.config/readshell/(遵循 XDG_CONFIG_HOME) |
| Windows | %APPDATA%/readshell/ |
所有数据都在本地:ReadShell 没有服务器,永远不会上传任何东西。
从 readshell-pro 迁移
旧版 readshell-pro 已停用,功能并入完全免费的 MIT 版 readshell 包(1.0 起)。
请切换到新包:
npm uninstall -g readshell-pro
npm install -g readshell
书库、进度和书签保存在本机数据目录中,切换包名不会丢失;旧的云账号配置会在首次运行时自动清理。
原来依赖云同步的,改用 novel sync --dir 文件夹同步即可。
下一步
更新于 2026-10-10