CLI 安装指南

Novel Writer CLI 是星尘织梦的命令行工具,提供本地创作、上传同步、格式转换等核心功能

系统要求
安装前请确保您的系统满足以下要求

操作系统

  • macOS 10.14 或更高版本
  • Windows 10 或更高版本
  • Linux (Ubuntu 18.04+, CentOS 7+)

运行环境

  • Node.js 16.0.0 或更高版本
  • npm 7.0.0 或 yarn 1.22.0+
  • 至少 500MB 可用磁盘空间

安装方法

使用 npm 安装
推荐

使用 npm 全局安装是最简单快捷的方式

npm install -g novel-writer-cn
使用 yarn 安装

如果您更喜欢使用 yarn 包管理器

yarn global add novel-writer-cn
中国地区加速安装

如果您在中国地区,可以使用淘宝镜像加速安装

# 设置镜像源
npm config set registry https://registry.npmmirror.com
# 安装 CLI
npm install -g novel-writer-cn
# 恢复默认源(可选)
npm config set registry https://registry.npmjs.org
验证安装

安装完成后,运行以下命令验证是否安装成功

# 查看版本号
$ novel --version
novel-writer-cn v1.5.2
# 查看帮助信息
$ novel --help
Usage: novel [command] [options]
更新升级

保持 CLI 工具最新以获得新功能和修复

检查更新

npm outdated -g novel-writer-cn

升级到最新版本

npm update -g novel-writer-cn

安装指定版本

npm install -g novel-writer-cn@1.4.0
卸载说明

如果您需要卸载 CLI 工具

# 使用 npm 卸载
npm uninstall -g novel-writer-cn
# 使用 yarn 卸载
yarn global remove novel-writer-cn
# 清理配置文件(可选)
rm -rf ~/.novel

常见问题

安装时提示权限不足怎么办?

在 macOS 或 Linux 系统上,您可能需要使用 sudo:

sudo npm install -g novel-writer-cn

但更推荐使用 npm 的目录权限修复:

npm config set prefix ~/.npm-global
如何查看 CLI 的安装路径?

运行以下命令查看安装路径:

which novel

或在 Windows 上:

where novel
安装后命令不可用?

可能是 PATH 环境变量问题,尝试:

  1. 重新打开终端窗口
  2. 检查 npm 全局包路径:npm config get prefix
  3. 确保该路径在系统 PATH 中
下一步

安装完成后,您可以: